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>Syntax</h2>
17<dl><dd><pre class="construction">
18#include &lt;revolution/gx.h&gt;
19
20void GXCopyDisp( void* dest, <a href="../Enumerated_Types/GXBool.html">GXBool</a> clear );
21</pre></dd></dl>
22
23<h2>Arguments</h2>
24<TABLE class="arguments" border="1" >
25  <tr>
26<TH>dest</TH>
27<TD>Pointer to the external framebuffer. <CODE>dest</CODE> should be 32-byte aligned.</TD>
28  </tr>
29  <tr>
30<TH>clear</TH>
31<TD>Flag that indicates frame buffer should be cleared if <CODE>GX_TRUE</CODE>.</TD>
32  </tr>
33</TABLE>
34
35<h2>Return Values</h2>
36<p>None.</p>
37
38<H2>Description</H2>
39<P>This function copies the embedded frame buffer (EFB) to an external framebuffer (XFB) in main memory. The first pixel is copied to address <SPAN class="argument">dest</SPAN>. The stride (number of pixels from <SPAN class="argument">dest</SPAN> to the next line) of the XFB is set using the <A href="GXSetDispCopyDst.html"><CODE>GXSetDispCopyDst</CODE></A> function. The source image in the EFB is described using the <A href="GXSetDispCopySrc.html"><CODE>GXSetDispCopySrc</CODE></A> function.</P>
40<P>The graphics processor (GP) will stall all graphics commands until the copy is complete.</P>
41<P>If the <SPAN class="argument">clear</SPAN> flag is <CODE>GX_TRUE</CODE>, the color and Z buffers will be cleared during the copy. They will be cleared to the constant values specified using the <A href="GXSetCopyClear.html"><CODE>GXSetCopyClear</CODE></A> function.</P>
42
43<h2>See Also</h2>
44<P class="reference">
45<a href="RenderMode.html">Render Modes</a>,
46<A href="GXSetDispCopySrc.html">GXSetDispCopySrc</A>,
47<A href="GXSetDispCopyDst.html">GXSetDispCopyDst</A>,
48<A href="GXSetDispCopyFrame2Field.html">GXSetDispCopyFrame2Field</A>,
49<A href="GXSetDispCopyYScale.html">GXSetDispCopyYScale</A>,
50<A href="GXSetCopyFilter.html">GXSetCopyFilter</A>
51</P>
52
53<H2>Revision History</H2>
54<P>
552007/03/05 Corrected error in the See Also section.<br>2006/03/01 Initial version.<br>
56</P>
57
58<hr><p>CONFIDENTIAL</p></body>
59</html>