LoadSprite()

Syntax

Result = LoadSprite(#Sprite, FileName$ [, Mode])

Description

Load the specified sprite into memory for immediate use. The sprite must be in BMP format (uncompressed form) and can have any dimensions and be in either 256 colors, 16 bits, 24 bits or 32 bits. A screen should be opened with OpenScreen() or OpenWindowedScreen() before loading a sprite. If an error occurs the value 0 is returned, otherwise the sprite was loaded successfully. A loaded sprite can be freed by using the FreeSprite() command.

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

Sprite - Index