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_LoadOBJPltt</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">GXS_LoadOBJPltt <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_LoadOBJPltt(const void *pSrc, u32 offset, 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 origin</TD>
28    </TR>
29    <TR>
30      <TD width="190"><em><strong><font face="Courier New">offset</font></strong></em></TD>
31      <TD width="512">Offset</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>This function uses DMA to transfer standard OBJ palette data to the sub 2D Engine palette RAM for OBJ. An offset can be specified for the transfer destination address. The DMA channel that is used is <CODE>GX_DMAID</CODE> (defined in <code>gxcommon.h</code>). The transfer destination address is <code>HW_DB_OBJ_PLTT</code> in the ARM9 memory space + <em><strong><code>offset</code></strong></em>. Both <em><strong><code>offset</code></strong></em> and <em><strong><code>szByte</code></strong></em> must be multiples of 2.</P>
43<P><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 not guaranteed.</P>
44
45<h2>See Also</h2>
46<P><code><A href="GXS_LoadOBJ.html">GXS_LoadOBJ</A></code>, <code><A href="GXS_LoadOAM.html">GXS_LoadOAM</A></code></P>
47<H2>Revision History</H2>
48<P>2004/02/09 Initial version.</P>
49<hr><p>CONFIDENTIAL</p></body>
50</html>
51