SpriteMaskColor

Top  Previous  Next

Syntax

SpriteMaskColor(sprite as POINTER,clr as UINT)

Description

Sets the mask color of transparent sprites.

Parameters

sprite - Sprite pointer returned by LoadSprite.

clr - The transparency color or color index to use.

Return value

None

Remarks

The mask color is used by drawing modes beginning with @TRANS.. It specifies a color in the sprites image that will not be shown when rendering the sprite onto the buffer with DrawSprite or DrawSpriteXY. The mask color is also used in collision testing to determine what pixels are invisible. For 8 bit screens the masking color is specified as a palette index instead of an RGB color.

See Also: LoadSprite, DrawSprite, DrawSpriteXY, SpriteDrawMode, SpriteCollided, SpriteCollidedEx

Example usage

SpriteMaskColor badguy, RGB(255,255,255)