1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META name="GENERATOR" content="Microsoft FrontPage 5.0">
7<META http-equiv="Content-Style-Type" content="text/css">
8<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
9<title>GXCopyDisp</title>
10</head>
11
12<body>
13
14<h1 align="left">GXCopyDisp</h1>
15
16<h2>C Specification</h2>
17
18<dl>
19<dd><PRE><CODE>#include &lt;revolution/gx.h&gt;</CODE></PRE>
20  </dd>
21<dd><pre><CODE>void GXCopyDisp( void* dest, <a href="../Enumerated_Types/GXBool.html">GXBool</a> clear );</CODE></pre>
22  </dd>
23</dl>
24
25<h2>Arguments</h2>
26<TABLE border="1" cellpadding="3" cellspacing="0.1">
27  <tr>
28<TD width="120" bgcolor="#ffffe8"><em><strong><CODE>dest</CODE></strong></em></TD>
29<TD width="520">Pointer to the external framebuffer.&nbsp;<code><em><strong>dest</strong></em></code> should be 32-byte aligned.</TD>
30    </tr>
31  <tr>
32<TD width="120" bgcolor="#ffffe8"><em><strong><CODE>clear</CODE></strong></em></TD>
33<TD width="520">Flag that indicates frame buffer should be cleared if <code>GX_TRUE</code>.</TD>
34    </tr>
35</TABLE>
36<h2>Return Values</h2>
37
38<p>None.</p>
39<H2>Description</H2>
40<P>This function copies the embedded frame buffer (EFB) to an external framebuffer (XFB) in main memory. The first pixel is copied to address <em><strong><code>dest</code></strong></em>.  The stride (number of pixels from <em><strong><code>dest</code></strong></em> to the next line) of the XFB is set using <a href="GXSetDispCopyDst.html"><code>GXSetDispCopyDst</code></a>.  The source image in the EFB is described using <a href="GXSetDispCopySrc.html"><code>GXSetDispCopySrc</code></a>.</P>
41<P>The graphics processor (GP) will stall all graphics commands until the copy is complete.</P>
42<P>If the <em><strong><code>clear</code></strong></em> flag is true, the color and Z buffers will be cleared during the copy.  They will be cleared to the constant values set using <code><a href="GXSetCopyClear.html">GXSetCopyClear</a></code>.</P>
43
44
45<h2>See Also</h2>
46
47<p><a href="RenderMode.html">Render Modes</a></p>
48<P><a href="GXSetDispCopySrc.html">GXSetDispCopySrc</a><br> <a href="GXSetDispCopyDst.html">GXSetDispCopyDst</a><br> <a href="GXSetDispCopyFrame2Field.html">GXSetDispCopyFrame2Field</a><br> <a href="GXSetDispCopyYScale.html">GXSetDispCopyYScale</a><br> <a href="GXSetCopyFilter.html">GXSetDispCopyFilter </a></P>
49<H2>Revision History</H2>
50<P>03/01/2006 Initial version.</P></body>
51</html>