The post-build script makes copies of generated texture pages and replaces them with fallback pages (such as blank images, silhouettes, or lossy images).
The extension allows you to load your original texture pages when desired and replaces them on spot.
This enables the game to load faster and load the textures when they are needed.
Set up your desired fallback texture type in the extension properties.
Transparent and Solid Color reduce the texture page sizes the most, but produce illegible textures when not loaded.
Silhouette produces a single-color texture with transparency (encoded as a lossy WEBP), which usually takes up 3-10% of original size, depending on shape complexity
Lossy WEBP, is, hence the name, texture re-encoded into WEBP format.
These are slightly larger than Silhouette, but produce a fairly
legible image when not loaded, making them a great choice for loading
textures in background.
Add
wdt_async_image();
to an Async - Image event in a persistent object.
Load textures when you need them!
Or auto-load them if you're not sure.
You can use status functions to check on the progress.
You should call this in Async - Image event of some persistent object.
Otherwise the texture pages will not be replaced upon loading.
All of these start loading the respective texture page if it hasn't been loaded yet.
There's no harm calling them for something that's already loading/loaded.
Loads a texture page that contains the given subimage of the given sprite.
If subimg is omitted, applies to every subimage in the sprite.
Like above, but can be passed any number of sprites.
Loads a texture page that contains the atlas for the given font.
Loads a texture page that contains the atlas for the given tileset.
Loads all texture pages from a texture group!
Loads a texture page associated with the given texture page entry
(such as from sprite_get_texture).
You can have textures loaded automatically when they are being accessed!
It's a good idea to have the textures loaded by the time user will see them, but these offer a fail-safe in case you never load something.
Note: for implementation reasons, _get_texture calls count as "accessing the texture".
You can use wdt_autoload_enable to perform texture manipulations without loading them.
Automatically loads the the texture associated with a texture page entry when it is being accessed.
Automatically loads all sprite/font/tileset textures when they are being acessed.
Enables/disables automatic loading for marked textures.
Returns the previous state.
If enable is not passed in or is undefined,
just returns the current state.
For example, if you need to grab an auto-loaded sprite's texture without loading it, you could do
var _autoload = wdt_autoload_enable(false); var _texture = sprite_get_texture(sprite, subimg); wdt_autoload_enable(_autoload); // restore previous state // do something with _texture
This is 1 so that you can do if (status) to see if a thing is ready to use.
Currently loading the original texture page!
The original texture page has not been requested yet, we're using the fallback texture.
The original texture page failed to load (e.g. due to network error)
Returns the name ("ready", etc.) for the given status code.
For things that may be spread across multiple texture pages (such as sprites or texture groups), the functions return the "worst" state (error > fallback > loading > ready) for an easier estimation of whether the thing is good to use.
Returns the texture status for a sprite.
If subimg is omitted, checks all of the frames.
Returns the texture status for a font.
Returns the texture status for a tileset.
Returns the texture status for contents of a texture group.
Returns the texture status for a texture page entry directly.
GameMaker IDE (still?) can't hide functions in extensions, so you might as well know what's up
Returns the number of texture frames for a sprite - that is, 1 for Spine sprites (instead of 2147483647) and 0 for SWF sprites.