CatchSprite()
Syntax
Result = CatchSprite(#Sprite, MemoryAddress [, Mode])
Description
Load the specified sprite from the given memory area. The sprite must be in BMP, uncompressed format. A screen should be opened with OpenScreen() or OpenWindowedScreen() before loading a sprite. If an error occurs the value 0 is returned. Sprites can have any dimensions and can be in 256 colors, 16 bits, 24 bits or 32 bits format. A loaded sprite can be freed by using the FreeSprite() command. The 'CatchSprite' command is useful when using the 'IncludeBinary' PureBasic keyword. The images can be packed inside the executable. Nevertheless, use this option very carefully, as it will take more memory than storing the file in an external file (the file will be in both executable memory and loaded into physical memory).
The 'Mode' parameter is optional and can take the following values:0 : Default mode. Sprite resides in video memory (if possible) #PB_Sprite_Memory : Sprite is loaded into main PC memory (for SpecialFX) #PB_Sprite_Alpha : Sprite is 8 bits grayscale and will be used by DisplayAlphaSprite() or DisplayShadowSprite() #PB_Sprite_Texture: Sprite is created with 3D support - useful for the CreateSprite3D() command of the Sprite3D library.
Supported OS
Windows, AmigaOS, Linux