DrawingBuffer()

Syntax

*Buffer = DrawingBuffer()

Returns the drawing buffer for direct pixel manipulation.

Parameters

None.

Return value

Returns the pixel data pointer if direct access is possible or zero if the pixel data cannot be accessed directly.

Remarks

This function has to be called again if other drawing commands of this library where used since the last pixel manipulation. Once StopDrawing() has been called, the buffer is invalidated and can no more be used.

This function is for advanced programmers only. To get more information about the buffer, the following functions are available: DrawingBufferPixelFormat() and DrawingBufferPitch().

The returned address can be directly in video memory if the output is ScreenOutput() or SpriteOutput() and allows very fast pixel manipulation. With ImageOutput() this command allows direct access to the pixels of the target image.

Example

For an example of how the drawing buffer can be used to create a nice visual effect, take a look here:

Example

DirectScreenDrawing.pb

See Also

DrawingBufferPixelFormat(), DrawingBufferPitch()

Supported OS

All