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
17<h2>C Specification</h2>
18
19<dl>
20<dd><PRE><CODE>#include &lt;revolution/gx.h&gt;</CODE></PRE>
21  </dd>
22<dd><pre><CODE>void GXCopyDisp( void* dest, <a href="../Enumerated_Types/GXBool.html">GXBool</a> clear );</CODE></pre>
23  </dd>
24</dl>
25
26<h2>Arguments</h2>
27<TABLE border="1" cellpadding="3" cellspacing="0.1">
28  <tr>
29<TD width="120" bgcolor="#ffffe8"><em><strong><CODE>dest</CODE></strong></em></TD>
30<TD width="520">Pointer to the external framebuffer.&nbsp;<code><em><strong>dest</strong></em></code> should be 32-byte aligned.</TD>
31    </tr>
32  <tr>
33<TD width="120" bgcolor="#ffffe8"><em><strong><CODE>clear</CODE></strong></em></TD>
34<TD width="520">Flag that indicates frame buffer should be cleared if <code>GX_TRUE</code>.</TD>
35    </tr>
36</TABLE>
37<h2>Return Values</h2>
38
39<p>None.</p>
40<H2>Description</H2>
41<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>
42<P>The graphics processor (GP) will stall all graphics commands until the copy is complete.</P>
43<P>If the <em><strong><code>clear</code></strong></em> flag is true, the color and the 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>
44
45
46<h2>See Also</h2>
47
48<p><a href="RenderMode.html">Render Modes</a></p>
49<P><A href="GXSetDispCopySrc.html"><CODE>GXSetDispCopySrc</CODE></A><br> <A href="GXSetDispCopyDst.html"><CODE>GXSetDispCopyDst</CODE></A><br> <A href="GXSetDispCopyFrame2Field.html"><CODE>GXSetDispCopyFrame2Field</CODE></A><br> <A href="GXSetDispCopyYScale.html"><CODE>GXSetDispCopyYScale</CODE></A><br> <A href="GXSetCopyFilter.html"><CODE>GXSetCopyFilter</CODE></A></P>
50<H2>Revision History</H2>
51<P>
522007/03/05 Corrected error in the <B>See Also</B> sections.<br>2006/03/01 Initial version.
53</P><hr><p>CONFIDENTIAL</p></body>
54</html>