Refresh

static void Refresh()

Refresh the contents of the active rendering surface.

If the selected surface is a Bitmap, this call will block until the graphics card has finished rendering to the Bitmap. If the screen backbuffer is selected instead, this call may or may not block depending on the settings and OpenGL implementation.

Before OpenLayer 2.0 (when Canvas didn't exist) the way to refresh the screen was to call GfxRend::RefreshScreen(). However, RefreshScreen doesn't support different rendering surfaces.

GfxRend::RefreshScreen can still be used for backwards compability but it's highly deprecated as it may mess up your code if you use Canvas as well. So if you use Canvas, it's best to use only Canvas, not RefreshScreen.

Examples

// Refresh the contents of the active canvas //
Canvas::Refresh();


Other functions of the class Canvas
SetTo
Selects the active rendering surface
Refresh
Refresh the contents of the active rendering surface
Fill
Fills the active rendering surface with the specified color
SetClipping
Sets the clipping region of the active rendering surface
DisableClipping
Disables the clipping region
GetClippingRegion
GetClippingRegion
Width
Returns the width of the active rendering surface
Height
Returns the height of the active rendering surface
Save
Saves the contents of the surface to an image file

Advanced functions

SetPixelWriteMode
Selects which color components the rendering functions affect
GetMemoryBitmap
Returns the contents of the Canvas in a memory bitmap
Push
Pushes the active Canvas to a stack
Pop
Pops the most recently stored Canvas from the stack


Questions about Refresh? Click here.