StartDrawing()

Syntax

Result = StartDrawing(OutputID)
Description
Change the current drawing output to the specified output. After setting this, all drawing functions are rendered to this output.

Parameters

OutputID The output to draw on. It can be obtained with the following functions:

WindowOutput(): Graphics will be rendered directly on the Window
ScreenOutput(): Graphics will be rendered directly on the Screen (for games)
SpriteOutput(): Graphics will be rendered directly on the Sprite (for games)
ImageOutput(): Graphics will be rendered directly on the Image data (see CreateImage())
PrinterOutput(): Graphics will be rendered directly on the Printer
CanvasOutput(): Graphics will be rendered directly on the CanvasGadget()
TextureOutput(): Graphics will be rendered directly on the Texture (for 3D games)

Return value

Returns nonzero if drawing is possible or zero if the operation failed.

Remarks

Once all drawing operations are finished, StopDrawing() must be called.

If "Create thread-safe executable" is enabled in the compiler options then every thread has its own current drawing output, which means two threads can do drawing on separate outputs at the same time.

See Also

StopDrawing()

Supported OS

All

<- SetOrigin() - 2DDrawing Index - StopDrawing() ->