CreateSprite

CreateSprite()

Syntax

Result = CreateSprite(#Sprite, Width, Height [, Mode])

Description

Creates an empty sprite with the specified dimensions. SpriteOutput() can be used to draw on the sprite.

Parameters

#Sprite A number to identify the new sprite. #PB_Any can be used to auto-generate this number.

Width, Height The size of the new sprite (in pixels).
Mode (optional)
It can be a combination of the following values (with the '|' operator):
  #PB_Sprite_PixelCollision: Add special information to handle pixel collision through SpritePixelCollision().
  #PB_Sprite_AlphaBlending : Sprite is created with per pixel alpha-channel support, needed for DisplayTransparentSprite().

Return value

Nonzero if the sprite has been created, zero otherwise. If #PB_Any was used for the #Sprite parameter then the generated number is returned on success.

Remarks

CreateSprite() has to be called in the same thread where OpenScreen() was called.

See Also

SpriteOutput()

Supported OS

All

<- CopySprite() - Sprite Index - DisplaySprite() ->

#Sprite	A number to identify the new sprite. #PB_Any can be used to auto-generate this number.
Width, Height	The size of the new sprite (in pixels).
Mode (optional)	It can be a combination of the following values (with the '\|' operator): #PB_Sprite_PixelCollision: Add special information to handle pixel collision through SpritePixelCollision(). #PB_Sprite_AlphaBlending : Sprite is created with per pixel alpha-channel support, needed for DisplayTransparentSprite().