1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//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<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css"> 8<title>GXGetCPUFifo</title> 9</head> 10 11<body> 12 13<h1 align="left">GXGetCPUFifo</h1> 14 15<h2>Syntax</h2> 16<dl><dd><pre class="construction"> 17#include <revolution/gx.h> 18 19<a href="../Enumerated_Types/GXBool.html">GXBool</a> GXGetCPUFifo( <a href="../Structures/GXFifoObj.html">GXFifoObj</a>* fifo ); 20</pre></dd></dl> 21 22<h2>Arguments</h2> 23<TABLE class="arguments" border="1" > 24 <tr> 25 <TH>fifo</TH> 26 <TD>A pointer to the FIFO structure.</TD> 27 </tr> 28</TABLE> 29 30<h2>Return Values</h2> 31<p>Returns <CODE>GX_TRUE</CODE> if the FIFO status could be obtained; otherwise, returns <CODE>GX_FALSE</CODE>.</p> 32 33<H2>Description</H2> 34<P>This function gets the current CPU FIFO state in the structure object specified by <SPAN class="argument">fifo</SPAN>. This function returns <CODE>GX_TRUE</CODE> if the status was correctly obtained; otherwise, it returns <CODE>GX_FALSE</CODE> if the status could not be obtained because the CPU FIFO had not been set.</P> 35 36<P><STRONG>Note:</STRONG> In contrast to the function of the same name in the Nintendo GameCube SDK, this function directly gets the current state of the CPU FIFO that is being used. (With the Nintendo GameCube SDK, only a pointer to the <a href="../Structures/GXFifoObj.html"><code>GXFifoObj</code></a> structure previously set by the <a href="GXSetCPUFifo.html"><code>GXSetCPUFifo</code></a> function was returned.<br>In addition, beginning from SDK 3.1 patch 3, specifications have changed so that the write-gather buffer inside the function is not flushed. You must call the <A href="../Management/GXFlush.html"><code>GXFlush</code></A> function, or a function that internally calls that function, at least once between the time that the last command enters the FIFO and the time the <code>GXGetCPUFifo</code> function is called. If these functions are not called, there is a possibility that problems may arise such as the screen remaining blacked out.<br> 37 38The following functions internally call the <code>GXFlush</code> function.<br> 39 40 <a href="../Management/GXAbortFrame.html"><code>GXAbortFrame</code></a><br> 41 <a href="../Management/GXSetDrawSync.html"><code>GXSetDrawSync</code></a><br> 42 <a href="../Management/GXSetDrawDone.html"><code>GXSetDrawDone</code></a><br> 43 <a href="../Management/GXDrawDone.html"><code>GXDrawDone</code></a><br> 44 <a href="../DisplayList/GXBeginDisplayList.html"><code>GXBeginDisplayList</code></a><br> 45 <a href="../DisplayList/GXEndDisplayList.html"><code>GXEndDisplayList</code></a><br> 46 <a href="../Performance/GXReadClksPerVtx.html"><code>GXReadClksPerVtx</code></a><br> 47 <a href="../GfxFIFO/GXRedirectWriteGatherPipe.html"><code>GXRedirectWriteGatherPipe</code></a><br> 48</P> 49 50<h2>See Also</h2> 51<P class="reference"> 52<a href="GXSetCPUFifo.html">GXSetCPUFifo</a> 53</p> 54 55<H2>Revision History</H2> 56<P> 572008/09/04 Revised notes about changes to this function in SDK 3.1 patch 3 and subsequent versions.<br>2008/05/12 Added notes about changes to this function in SDK3.1 patch3 and subsequent versions.<br>2007/03/05 Added a Note about the difference with the Nintendo GameCube SDK.<br>2006/09/22 Corrected typo in the argument name.<br>2006/03/01 Initial version.<br> 58</P> 59 60<hr><p>CONFIDENTIAL</p></body> 61</HTML>