Skip to content
This repository has been archived by the owner on May 15, 2024. It is now read-only.

Commit

Permalink
add usage instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
omicronrex authored Sep 7, 2021
1 parent 6d58659 commit 93a1a14
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,12 @@ This is an application_surface wrapper extension for Game Maker 8.2.

It automatically manages a surface, providing a post-draw callback entrypoint for composing the screen with it.

Requires [Core](https://github.com/omicronrex/gm82core) version 1.3.2 or newer.
Requires [Core](https://github.com/omicronrex/gm82core) version 1.3.2 or newer.

## Usage
1. Install Core and AppSurf, and add both to your project.
2. Create a script that will be used as a screen composing callback.
3. At game start, surface_init(...) with your callback script's id.
4. Write screen composition code in the script. application_surface contains the surface handle, and the projection is set to the size of the surface.
5. If need be, you can resize the application_surface.
6. When using other surfaces during the draw event, make sure to utilize surface_disengage() instead of surface_reset_target() to properly reset the draw stack. Using surfaces during other events is fine.

0 comments on commit 93a1a14

Please sign in to comment.