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>GXGetGPStatus</title>
10</head>
11
12<body>
13
14<h1 align="left">GXGetGPStatus</h1>
15
16<h2>Syntax</h2>
17<dl><dd><pre class="construction">
18#include &lt;revolution/gx.h&gt;
19
20void GXGetGPStatus(
21    <a href="../Enumerated_Types/GXBool.html">GXBool</a>* overhi,
22    <a href="../Enumerated_Types/GXBool.html">GXBool</a>* underlow,
23    <a href="../Enumerated_Types/GXBool.html">GXBool</a>* readIdle,
24    <a href="../Enumerated_Types/GXBool.html">GXBool</a>* cmdIdle,
25    <a href="../Enumerated_Types/GXBool.html">GXBool</a>* brkpt );
26</pre></dd></dl>
27
28<h2>Arguments</h2>
29<TABLE class="arguments" border="1" >
30  <tr>
31<TH>overhi</TH>
32<TD><CODE>GX_TRUE</CODE> if high watermark has been passed.</TD>
33  </tr>
34  <tr>
35<TH>underlow</TH>
36<TD><CODE>GX_TRUE</CODE> if low watermark has been passed.</TD>
37  </tr>
38  <tr>
39<TH>readIdle</TH>
40<TD><CODE>GX_TRUE</CODE> if the GP read unit is idle.</TD>
41  </tr>
42  <tr>
43<TH>cmdIdle</TH>
44<TD><CODE>GX_TRUE</CODE> if all commands have been flushed to XF.</TD>
45  </tr>
46  <tr>
47<TH>brkpt</TH>
48<TD><code>GX_TRUE</code> if FIFO has reached a breakpoint and GP reads have been stopped.</TD>
49  </tr>
50</TABLE>
51
52<h2>Return Values</h2>
53<p>None.</p>
54
55<H2>Description</H2>
56<P>Reads the current state of the GP.</P>
57<P><SPAN class="argument">overhi</SPAN> and <SPAN class="argument">underlow</SPAN> indicate whether the watermarks have been passed. If the CPU and GP FIFO are the same, <SPAN class="argument">overhi</SPAN> indicates whether the current GX thread is suspended.</P>
58<P>The <SPAN class="argument">brkpt</SPAN> value can be used to determine if a break point is in progress. (In other words, during a break point the reading of GP is suspended. It is resumed by calling the <A href="GXDisableBreakPt.html"><CODE>GXDisableBreakPt</CODE></A> function.) A callback can also be used to notify the application when a breakpoint has been reached. (See the <A href="GXSetBreakPtCallback.html"><CODE>GXSetBreakPtCallback</CODE></A> function.)</P>
59
60<h2>See Also</h2>
61<p>None.</p>
62
63<H2>Revision History</H2>
64<P>
652006/03/01 Initial version.<br>
66</P>
67
68<hr><p>CONFIDENTIAL</p></body>
69</HTML>