1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<HTML>
3<HEAD>
4<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<META name="GENERATOR" content="Microsoft FrontPage 5.0">
6<META http-equiv="Content-Style-Type" content="text/css">
7<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
8<TITLE>MTXPop</TITLE>
9</HEAD>
10<BODY>
11<H1>MTXPop</H1>
12
13<H2>Syntax</H2>
14<dl><dd><pre class="construction">
15&nbsp;&nbsp;&nbsp; #include &lt;revolution/mtx.h&gt;
16
17MtxPtr MTXPop ( MtxStack* sPtr );
18</pre></dd></dl>
19
20<H2>Arguments</H2>
21<TABLE class="arguments" border="1" >
22  <TBODY>
23    <TR>
24<TH>sPtr</TH>
25<TD>Pointer to an <A href="../structures/MtxStack_MtxStackPtr.html"><CODE>MtxStack</CODE></A> structure whose <CODE><STRONG>stackPtr</STRONG></CODE> member will be decremented</TD>
26    </TR>
27  </TBODY>
28</TABLE>
29
30<H2>Return Values</H2>
31<P>Returns a new stack pointer (old stack pointer - <CODE>MTX_PTR_OFFSET</CODE>) if the old stack pointer was greater than the stack base. Otherwise, returns <CODE><STRONG>NULL</STRONG></CODE> (empty stack).</P>
32
33<H2>Description</H2>
34<P>Decrements <SPAN class="argument">sPtr</SPAN>'s <CODE><STRONG>stackPtr</STRONG></CODE> member by one matrix (<SPAN class="argument">sPtr</SPAN><CODE><STRONG>-&gt;stackPtr</STRONG> -= MTX_PTR_OFFSET</CODE>), in effect popping the matrix from the stack. The popped matrix's memory is untouched until overwritten by a 'push' call.</P>
35<P>If the stack pointer was equal to the stack base, <SPAN class="argument">sPtr</SPAN><CODE><STRONG>-&gt;stackPtr</STRONG></CODE> is set to <CODE><STRONG>NULL</STRONG></CODE>, indicating an empty stack.</P>
36
37<H2>See Also</H2>
38<P class="reference">
39<A href="../structures/Mtx_MtxPtr.html">Mtx, MtxPtr</A>,
40<A href="../structures/MtxStack_MtxStackPtr.html">MtxStack, MtxStackPtr</A>,
41<A href="MTXGetStackPtr.html">MTXGetStackPtr</A>,
42<A href="MTXPush.html">MTXPush</A>,
43<A href="MTXPushFwd.html">MTXPushFwd</A>,
44<A href="MTXPushInv.html">MTXPushInv</A>,
45<A href="MTXPushInvXpose.html">MTXPushInvXpose</A>
46</P>
47
48<H2>Revision History</H2>
49<P>
502006/03/01 Initial version.<BR>
51</P>
52
53<hr><p>CONFIDENTIAL</p></body>
54</HTML>