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>GXGetFifoPtrs</title>
10</head>
11
12<body>
13
14<h1 align="left">GXGetFifoPtrs</h1>
15
16
17<h2>C Specification</h2>
18
19<dl>
20  <dd><PRE><CODE>#include &lt;revolution/gx.h&gt;</CODE></PRE></dd>
21  <dd><pre><CODE>void GXGetFifoPtrs( const
22    <a href="../Structures/GXFifoObj.html">GXFifoObj</a>* fifo,
23    void**     read_ptr,
24    void**     write_ptr );</CODE></pre></dd>
25</dl><h2>Arguments</h2>
26<div align="left">
27<TABLE border="1" cellpadding="3" cellspacing="0.1">
28  <tr>
29<TD width="120" valign="top" bgcolor="#ffffe8"><code><strong><em>fifo</em></strong></code></TD>
30<TD width="520">pointer to a FIFO structure.</TD>
31    </tr>
32  <tr>
33<TD width="120" valign="top" bgcolor="#ffffe8"><code><strong><em>read_ptr</em></strong></code></TD>
34<TD width="520">returns address of the FIFO read pointer.</TD>
35    </tr>
36  <tr>
37<TD width="120" valign="top" bgcolor="#ffffe8"><code><strong><em>write_ptr</em></strong></code></TD>
38<TD width="520">returns address of the FIFO write pointer.</TD>
39    </tr>
40</TABLE>
41</div>
42
43<h2>Return Values</h2>
44
45<p>None.</p>
46
47<H2>Description</H2>
48<P>This function reads the values of the read and write pointers of the specified FIFO object. It is used when you want to get the value of each setting from the FIFO state obtained using either <code><a href="GXGetCPUFifo.html">GXGetCPUFifo</a></code> or <code><a href="GXGetGPFifo.html">GXGetGPFifo</a></code>.
49</P>
50
51<P>Example:</P>
52<dl>
53<dd><PRE><CODE>GXFifoObj fifo;
54void* read_ptr;
55void* write_ptr;
56
57GXGetCPUFifo(&amp;fifo);
58GXGetFifoPtrs(&amp;fifo, &amp;read_ptr, &amp;write_ptr);
59</CODE></PRE></dd>
60</dl>
61
62<P><STRONG>Note:</STRONG> In contrast to the Nintendo&nbsp;GameCube SDK, <code>GXGetFifoPtrs</code> does not directly return the current FIFO data. As with other GXGetFifo type APIs, <code>GXGetFifoPtrs</code> runs either <code><a href="GXGetCPUFifo.html">GXGetCPUFifo</a></code> or <code><a href="GXGetGPFifo.html">GXGetGPFifo</a></code>. It reads the necessary information from the <code>GXFifoObj</code> structure, which has the current FIFO state.<P>
63
64<h2>See Also</h2>
65<p>
66<code><a href="GXGetCPUFifo.html">GXGetCPUFifo</a></code><br> <code><a href="GXGetGPFifo.html">GXGetGPFifo</a></code><br> <A href="GXInitFifoPtrs.html"><CODE>GXInitFifoPtrs</CODE></A></P>
67<H2>Revision History</H2>
68<P>
692006/06/16 Added a description of differences with the Nintendo&nbsp;GameCube SDK.<BR>2006/03/01 Initial version.
70</P>
71<hr>
72<P>CONFIDENTIAL</p>
73</BODY>
74</HTML>