CopySprite

CopySprite()

Syntax

Result = CopySprite(#Sprite1, #Sprite2 [, Mode])

Description

Copy the #Sprite1 to #Sprite2.

Parameters

#Sprite1 The source sprite to copy.

#Sprite2 A number to identify the new copied sprite. #PB_Any can be used to auto-generate this number. If #Sprite2 doesn't exists, it is created.
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 copied, zero otherwise. If #PB_Any was used for the #Sprite2 parameter then the generated number is returned on success.

Supported OS

All

<- ClipSprite() - Sprite Index - CreateSprite() ->

#Sprite1	The source sprite to copy.
#Sprite2	A number to identify the new copied sprite. #PB_Any can be used to auto-generate this number. If #Sprite2 doesn't exists, it is created.
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().