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="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows">
7<META http-equiv="Content-Style-Type" content="text/css">
8<title>GXS_LoadBGExtPltt</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">GXS_LoadBGExtPltt <img src="../../image/NTR.gif"align="middle"><img src="../../image/TWL.gif" align="middle"></H1>
15<H2>Syntax</H2>
16
17<dl>
18  <dd>
19<PRE>
20<CODE>#include &lt;nitro/gx/gx_load.h&gt;</CODE><BR>
21<CODE>void GXS_LoadBGExtPltt(const void *pSrc, u32 destSlotAddr, u32 szByte);</CODE></PRE></dd>
22</dl><h2>Arguments</h2>
23<TABLE border="1" width="100%">
24  <TBODY>
25    <TR>
26<TD width="190"><em><strong><font face="Courier New">pSrc</font></strong></em></TD>
27<TD width="512">Pointer to transfer source</TD>
28    </TR>
29    <TR>
30<TD width="190"><em><strong><font face="Courier New">destSlotAddr</font></strong></em></TD>
31<TD width="512">Transfer destination address in the BG Extended palette</TD>
32    </TR>
33    <TR>
34<TD width="190"><em><strong><font face="Courier New">szByte</font></strong></em></TD>
35<TD width="512">Transfer size (in bytes)</TD>
36    </TR>
37  </TBODY>
38</TABLE>
39<h2>Return Values</h2>
40<p>None.</p>
41<H2>Description</H2>
42<P>Uses DMA to transfer BG palette data to the sub 2D Engine's BG Extended palette. The transfer destination address (in the BG Extended palette) can be specified. The DMA channel to use here is <code>GX_DMAID</code> (defined in <code>gxcommon.h</code>). Both <SPAN class="argument">destSlotAddr</SPAN> and <SPAN class="argument">szByte</SPAN> must be 4-byte aligned. Call this function between the <A href="GXS_BeginLoadBGExtPltt.html"><CODE>GXS_BeginLoadBGExtPltt</CODE></A> and <A href="GXS_EndLoadBGExtPltt.html"><CODE>GXS_EndLoadBGExtPltt</CODE></A> functions.<BR><BR> <B>Note 1:</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 <A href="../../os/cache/DC_FlushRange.html" target="_self"><CODE>DC_FlushRange</CODE></A>.<BR><B>Note 2:</B> If the regions for transfer source and transfer destination overlap, the operation result is undefined.<BR><B>Note 3:</B> Do not call the <A href="GX_SetBankForSubBGExtPltt.html"><CODE>GX_SetBankForSubBGExtPltt</CODE></A>, <A href="GX_ResetBankForSubBGExtPltt.html"><CODE>GX_ResetBankForSubBGExtPltt</CODE></A>, or <A href="GX_DisableBankForSubBGExtPltt.html"><CODE>GX_DisableBankForSubBGExtPltt</CODE></A> function between <A href="GXS_BeginLoadBGExtPltt.html"><CODE>GXS_BeginLoadBGExtPltt</CODE></A> and <A href="GXS_EndLoadBGExtPltt.html"><CODE>GXS_EndLoadBGExtPltt</CODE></A>.<BR><B>Note 4:</B> The memory space available to use for palettes varies according to the BG surface. For a BG2 palette, you must place palette data in <CODE>0x4000-0x5FFF</CODE> (slot 2). For a BG3 palette, you must place palette data in <CODE>0x6000-0x7FFF</CODE> (slot 3). You can use the <A href="../g2/G2S_SetBG0Control.html"><CODE>G2S_SetBG0Control</CODE></A> function to select either <CODE>0x0000-0x1FFF</CODE> (slot 0) or <CODE>0x4000-0x5FFF</CODE> (slot 2) for BG0, and the <A href="../g2/G2S_SetBG1Control.html"><CODE>G2S_SetBG1Control</CODE></A> function to select either <CODE>0x2000-0x3FFF</CODE> (slot 1) or <CODE>0x6000-0x7FFF</CODE> (slot 3) for BG1.</P>
43
44<h2>See Also</h2>
45<P><A href="GXS_BeginLoadBGExtPltt.html"><CODE>GXS_BeginLoadBGExtPltt</CODE></A><BR> <A href="GXS_EndLoadBGExtPltt.html"><CODE>GXS_EndLoadBGExtPltt</CODE></A></P>
46<H2>Revision History</H2>
47<P>2009/07/24
48
49Revised description of palette data placement restrictions.
50</P>
51<P>2004/03/01
52
53Added note about restrictions on placing palette data.
54</P>
55<P>2004/02/09 Initial version.</P>
56<hr><p>CONFIDENTIAL</p></body>
57</html>
58