ClipSprite()

Syntax

ClipSprite(#Sprite, x, y, Width, Height)

Creates a clip zone for the specified sprite. For example, if a sprite is 100*100 (Width*Height) and a clipping zone is added as x=10, y=10, Width=20, Height=20 then when the sprite is displayed, only the rectangular area starting from x=10, y=10 with width=20 and height=20 will be displayed.

Parameters

#Sprite	The sprite to clip.
x, y	The clipping start position (in pixels). #PB_Default can be used as value to remove the clipping.
Width, Height	The clipping size (in pixels). #PB_Default can be used as value to remove the clipping.

Return value

None.

See Also

DisplaySprite(), DisplayTransparentSprite()

Supported OS

All