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<h2>Syntax</h2>
17<dl><dd><pre class="construction">
18#include &lt;revolution/gx.h&gt;
19
20void GXGetFifoPtrs( const
21    <a href="../Structures/GXFifoObj.html">GXFifoObj</a>* fifo,
22    void**     read_ptr,
23    void**     write_ptr );
24</pre></dd></dl>
25
26<h2>Arguments</h2>
27<TABLE class="arguments" border="1" >
28  <tr>
29<TH>fifo</TH>
30<TD>A pointer to the FIFO structure.</TD>
31  </tr>
32  <tr>
33<TH>read_ptr</TH>
34<TD>Returns address of the FIFO read pointer.</TD>
35  </tr>
36  <tr>
37<TH>write_ptr</TH>
38<TD>Returns address of the FIFO write pointer.</TD>
39  </tr>
40</TABLE>
41
42<h2>Return Values</h2>
43<p>None.</p>
44
45<H2>Description</H2>
46<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</code></a> or <a href="GXGetGPFifo.html"><code>GXGetGPFifo</code></a>.
47</P>
48
49<P>Example:</P>
50<dl>
51<dd><PRE><CODE>GXFifoObj fifo;
52void* read_ptr;
53void* write_ptr;
54
55GXGetCPUFifo(&amp;fifo);
56GXGetFifoPtrs(&amp;fifo, &amp;read_ptr, &amp;write_ptr);
57</CODE></PRE></dd>
58</dl>
59
60<P><STRONG>Note:&nbsp;</STRONG> In contrast to the GAMECUBE SDK, <code>GXGetFifoPtrs</code> does not directly return the current FIFO data. As with other <CODE>GXGetFifo</CODE> type APIs, <code>GXGetFifoPtrs</code> runs either <a href="GXGetCPUFifo.html"><code>GXGetCPUFifo</code></a> or <a href="GXGetGPFifo.html"><code>GXGetGPFifo</code></a> and reads the necessary information from the <code>GXFifoObj</code> structure, which has obtained the current FIFO state.<P>
61
62<h2>See Also</h2>
63<P class="reference">
64<a href="GXGetCPUFifo.html">GXGetCPUFifo</a>,
65<a href="GXGetGPFifo.html">GXGetGPFifo</a>,
66<A href="GXInitFifoPtrs.html">GXInitFifoPtrs</A>
67</P>
68
69<H2>Revision History</H2>
70<P>
712006/06/16 Added a description of differences with the GameCube SDK.<BR>2006/03/01 Initial version.<br>
72</P>
73
74<hr><p>CONFIDENTIAL</p></body>
75</HTML>