SpriteOutput()

Syntax

OutputID = SpriteOutput(#Sprite)
Description
Returns the OutputID of the sprite to perform 2D rendering operation on it.

Parameters

#Sprite The sprite to draw on.

Return value

The output ID or zero if drawing is not possible. This value should be passed directly to the StartDrawing() function to start the drawing operation. The return-value is valid only for one drawing operation and cannot be reused.

Remarks

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

Example

  StartDrawing(SpriteOutput(#Sprite))
    ; do some drawing stuff here...
  StopDrawing()

Supported OS

All

<- SpriteID() - Sprite Index - SpritePixelCollision() ->