1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 8.0.0.0 for Windows">
6<META http-equiv="Content-Style-Type" content="text/css">
7<title>GX_LoadClearImageColor</title>
8<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
9</head>
10<body>
11<h1 align="left">GX_LoadClearImageColor <img src="../../image/NTR.gif"align="middle"><img src="../../image/TWL.gif" align="middle"></H1>
12<H2>Syntax</H2>
13<dl>
14  <dd>
15<CODE>#include &lt;nitro/gx/gx_load.h&gt;</CODE><BR>
16  <BR>
17  <CODE>void GX_LoadClearImageColor(const void *pSrc, u32 szByte);</CODE></dd>
18</dl><h2>Arguments</h2>
19<TABLE border="1" width="100%">
20  <TBODY>
21    <TR>
22      <TD width="190"><em><strong><font face="Courier New">pSrc</font></strong></em></TD>
23      <TD width="512">Pointer to transfer origin</TD>
24    </TR>
25    <TR>
26      <TD width="190"><em><strong><font face="Courier New">szByte</font></strong></em></TD>
27      <TD width="512">Transfer size (in bytes)</TD>
28    </TR>
29  </TBODY>
30</TABLE>
31<h2>Return Values</h2>
32<p>None.</p>
33<H2>Description</H2>
34<P>This function uses DMA to transfer the clear image (color) to the clear image slot. Use the <code>GX_DMAID</code> DMA channel (defined in <code>gxcommon.h</code>). <em><strong><code>szByte</code></strong></em> must be a multiple of 4. Call this function between the <CODE><A href="GX_BeginLoadClearImage.html">GX_BeginLoadClearImage</A></CODE> and <CODE><A href="GX_EndLoadClearImage.html">GX_EndLoadClearImage</A></CODE> functions.<BR><BR> <B>Notes:</B> Because the DMA transfer is carried out internally, the transfer source data must be written to main memory in advance using a function such as <CODE><A href="../../os/cache/DC_FlushRange.html" target="_self">DC_FlushRange</A></CODE>.<BR>If the regions for transfer source and transfer destination overlap, the operation result is undefined. Do not call <A href="GX_SetBankForClearImage.html"><CODE>GX_SetBankForClearImage</CODE></A>, <A href="GX_ResetBankForClearImage.html"><CODE>GX_ResetBankForClearImage</CODE></A>, or <A href="GX_DisableBankForClearImage.html"><CODE>GX_DisableBankForClearImage</CODE></A> between <CODE><A href="GX_BeginLoadClearImage.html">GX_BeginLoadClearImage</A></CODE> and <CODE><A href="GX_EndLoadClearImage.html">GX_EndLoadClearImage</A></CODE>.</P>
35<h2>See Also</h2>
36<P><code><A href="GX_BeginLoadClearImage.html">GX_BeginLoadClearImage</A></code><BR> <code><A href="GX_LoadClearImageDepth.html">GX_LoadClearImageDepth</A></code><BR> <code><A href="GX_EndLoadClearImage.html">GX_EndLoadClearImage</A></code></P>
37<H2>Revision History</H2>
38<P>2004/02/09</P>
39<UL>
40  <LI>Revised and expanded the description.
41</UL>
42<P>2004/01/19 Initial version.</P>
43<hr><p>CONFIDENTIAL</p></body>
44</html>
45