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>GXGetFifoWrap</title>
10</head>
11
12<body>
13
14<h1 align="left">GXGetFifoWrap</h1>
15
16<h2>Syntax</h2>
17<dl><dd><pre class="construction">
18#include &lt;revolution/gx.h&gt;
19
20<a href="../Enumerated_Types/GXBool.html">GXBool</a> GXGetFifoWrap( const <A href="../Structures/GXFifoObj.html">GXFifoObj</A>* fifo );
21</pre></dd></dl>
22
23<h2>Arguments</h2>
24<TABLE class="arguments" border="1" >
25  <tr>
26<TH>fifo</TH>
27<TD>A pointer to the FIFO structure.</TD>
28  </tr>
29</TABLE>
30
31<h2>Return Values</h2>
32<p>This function returns the wrap information of the specified FIFO object. This function returns <CODE>GX_TRUE</CODE> if wrapped; otherwise, it returns <CODE>GX_FALSE</CODE>.</p>
33
34<H2>Description</H2>
35<P>This function returns the wrap information of the specified FIFO object (whether writing data to the FIFO has returned to the base pointer position after going around in the buffer). This can be used to determine write overflow to the CPU FIFO in multi-buffer mode. For the actual procedure, use this function after obtaining the state in the FIFO object using <a href="GXGetCPUFifo.html"><code>GXGetCPUFifo</code></a>.</P>
36
37<h2>See Also</h2>
38<P class="reference">
39<a href="GXGetCPUFifo.html">GXGetCPUFifo</a>,
40<a href="GXSetCPUFifo.html">GXSetCPUFifo</a>
41</p>
42
43<H2>Revision History</H2>
44<P>
452006/03/01 Initial version.<br>
46</P>
47
48<hr><p>CONFIDENTIAL</p></body>
49</html>