File: Refresh.html

package info (click to toggle)
openlayer 2.1-2.1
  • links: PTS
  • area: main
  • in suites: bullseye, buster, stretch
  • size: 3,392 kB
  • ctags: 2,317
  • sloc: ansic: 10,433; cpp: 9,890; xml: 109; makefile: 90; sh: 36
file content (10 lines) | stat: -rw-r--r-- 5,198 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transistional//EN"><html><head><title>OpenLayer Offline Manual</title><style type="text/css" media="all">@import "../CrystalStyle.css";</style><body bgcolor="FFFFFF" ><div align="center" style="pagestyle"><table width="60%"><tr><td><div class="parentLinks"><a href="../index.html">OpenLayer</a> | <a href="../Canvas.html">Canvas</a> | <a href="../Canvas/Refresh.html">Refresh</a></div><br><div class="BigHeader">Refresh</div><br><div class=""><div class="Surrounded"><table><tr valign="top"><td align="right"><div class="FuncDef"><strong><font color="#777733">static</font> <font color="#777733">void</font> <a href="../Canvas/Refresh.html"><font color="#0000CC">Refresh</font></a>()
<br></strong></div></td></tr></table>
<br>Refresh the contents of the active rendering surface.
<br></div>
<br>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.
<br>
<br>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.
<br>
<br>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.</div><br><div class="MediumHeader">Examples</div><br><div class="Code"><font color="#999922">//&nbsp;Refresh&nbsp;the&nbsp;contents&nbsp;of&nbsp;the&nbsp;active&nbsp;canvas&nbsp;//</font>
<br><a href="../Canvas.html"><font color="#0000CC">Canvas</font></a>::<a href="../Canvas/Refresh.html"><font color="#0000CC">Refresh</font></a>();</div><div class=""><br><br><div class="MediumHeader">Other functions of the class <a href="../Canvas.html"><font color="#0000CC">Canvas</font></a></div><div class="Surrounded"><table size="100%" cellpadding="0" cellspacing="0"><tr><td halign="center" class="funclist"><a href="../Canvas/SetTo.html">SetTo</a></td><td width="65%" halign="center"><div class="smalltext">Selects the active rendering surface</div></td></tr><tr><td halign="center" class="funclist"><a href="../Canvas/Refresh.html">Refresh</a></td><td width="65%" halign="center"><div class="smalltext">Refresh the contents of the active rendering surface</div></td></tr><tr><td halign="center" class="funclist"><a href="../Canvas/Fill.html">Fill</a></td><td width="65%" halign="center"><div class="smalltext">Fills the active rendering surface with the specified color</div></td></tr><tr><td halign="center" class="funclist"><a href="../Canvas/SetClipping.html">SetClipping</a></td><td width="65%" halign="center"><div class="smalltext">Sets the clipping region of the active rendering surface</div></td></tr><tr><td halign="center" class="funclist"><a href="../Canvas/DisableClipping.html">DisableClipping</a></td><td width="65%" halign="center"><div class="smalltext">Disables the clipping region</div></td></tr><tr><td halign="center" class="funclist"><a href="../Canvas/GetClippingRegion.html">GetClippingRegion</a></td><td width="65%" halign="center"><div class="smalltext">GetClippingRegion</div></td></tr><tr><td halign="center" class="funclist"><a href="../Canvas/Width.html">Width</a></td><td width="65%" halign="center"><div class="smalltext">Returns the width of the active rendering surface</div></td></tr><tr><td halign="center" class="funclist"><a href="../Canvas/Height.html">Height</a></td><td width="65%" halign="center"><div class="smalltext">Returns the height of the active rendering surface</div></td></tr><tr><td halign="center" class="funclist"><a href="../Canvas/Save.html">Save</a></td><td width="65%" halign="center"><div class="smalltext">Saves the contents of the surface to an image file</div></td></tr><tr><td colspan="2"><br><div class="SmallHeader"><font color="#775500">Advanced functions</font></div><br></td></tr><tr><td halign="center" class="funclist"><a href="../Canvas/SetPixelWriteMode.html">SetPixelWriteMode</a></td><td width="65%" halign="center"><div class="smalltext">Selects which color components the rendering functions affect</div></td></tr><tr><td halign="center" class="funclist"><a href="../Canvas/GetMemoryBitmap.html">GetMemoryBitmap</a></td><td width="65%" halign="center"><div class="smalltext">Returns the contents of the Canvas in a memory bitmap</div></td></tr><tr><td halign="center" class="funclist"><a href="../Canvas/Push.html">Push</a></td><td width="65%" halign="center"><div class="smalltext">Pushes the active Canvas to a stack</div></td></tr><tr><td halign="center" class="funclist"><a href="../Canvas/Pop.html">Pop</a></td><td width="65%" halign="center"><div class="smalltext">Pops the most recently stored Canvas from the stack</div></td></tr></table></div><br><div class=""><a href="../index.html">Back to the main page of the manual</a></div><br>Questions about Refresh? Click <a href="http://crystalstorm.ath.cx/index.php?lan=en&page=CreateFeedback&subject=Refresh">here.</a></div></td></tr></table></body></html>