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>GXSetCopyClear</title>
10</head>
11
12<body>
13
14<h1 align="left">GXSetCopyClear</h1>
15
16<h2>Syntax</h2>
17<dl><dd><pre class="construction">
18#include &lt;revolution/gx.h&gt;
19
20void GXSetCopyClear(
21    <a href="../Structures/GXColor.html">GXColor</a>    clear_clr,
22    u32        clear_z);
23</pre></dd></dl>
24
25<h2>Arguments</h2>
26<TABLE class="arguments" border="1" >
27  <tr>
28<TH>clear_clr</TH>
29<TD>RGBA color (8 bits per component).&nbsp;The value will be converted to the correct format during the clear operation.</TD>
30  </tr>
31  <tr>
32<TH>clear_z</TH>
33<TD>24-bit Z value. This value will be converted to the correct format during the clear operation.<br> Use the constant <CODE>GX_MAX_Z24</CODE> to specify the maximum depth value.</TD>
34  </tr>
35</TABLE>
36
37<h2>Return Values</h2>
38<p>None.</p>
39
40<h2>Description</h2>
41<P>Sets the color and Z values to clear the embedded frame buffer to during copy operations.&nbsp;These values are used during both display copies and texture copies.
42</P>
43
44<h2>See Also</h2>
45<P class="reference">
46<a href="GXCopyDisp.html">GXCopyDisp</a>,
47<a href="GXCopyTex.html">GXCopyTex</a>
48</p>
49
50<H2>Revision History</H2>
51<P>
522006/03/01 Initial version.<br>
53</P>
54
55<hr><p>CONFIDENTIAL</p></body>
56</html>