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>GXEndDisplayList</title> 10</head> 11 12<body> 13 14<h1 align="left">GXEndDisplayList</h1> 15 16<h2>Syntax</h2> 17<dl><dd><pre class="construction"> 18#include <revolution/gx.h> 19 20u32 GXEndDisplayList( void ); 21</pre></dd></dl> 22 23<h2>Arguments</h2> 24<p>None.</p> 25 26<h2>Return Values</h2> 27<P>Returns the size of the display list in bytes unless size exceeds the buffer such as under conditions where 0 is returned. ASSERT errors also occur under conditions like this when using the debug library.</P> 28 29<H2>Description</H2> 30<P>This function ends a display list and resumes writing graphics commands to the CPU <A href="../list.html#Graphics FIFO">FIFO</A>. It returns the size of the display list written to the display list buffer since the call to <A href="GXBeginDisplayList.html"><CODE>GXBeginDisplayList</CODE></A>. If the display list size exceeds the size of the allocated buffer, the function will fault with an ASSERT error. In the case of optimized libraries, where ASSERT errors do not occur, a zero length size will be returned. The display list size is a multiple of 32 bytes and any unused commands in the last 32 bytes will be padded with <CODE>GX_NOP(0x00)</CODE>.</P> 31<P>Due to the mechanics of flushing the write-gather pipe (which is used to create the display list), the display buffer should be at least 32 bytes larger than the maximum expected amount of data stored. The <CODE>GXEndDisplayList</CODE> function calls <A href="../Management/GXFlush.html"><CODE>GXFlush</CODE></A>. Therefore it is not necessary to call the <A href="../Management/GXFlush.html"><CODE>GXFlush</CODE></A> function explicitly after creating the display list.</P> 32<P>Display lists cannot be nested. In other words, the <A href="GXBeginDisplayList.html"><CODE>GXBeginDisplayList</CODE></A>, <CODE>GXEndDisplayList</CODE> and <A href="GXCallDisplayList.html"><CODE>GXCallDisplayList</CODE></A> functions cannot be called between a <A href="GXBeginDisplayList.html"><CODE>GXBeginDisplayList</CODE></A> and <CODE>GXEndDisplayList</CODE> function pair.</P> 33<P>To execute a display list, use the <A href="GXCallDisplayList.html"><CODE>GXCallDisplayList</CODE></A> function.</P> 34 35<h2>See Also</h2> 36<P class="reference"> 37<A href="GXBeginDisplayList.html">GXBeginDisplayList</A>, 38<A href="GXCallDisplayList.html">GXCallDisplayList</A> 39</P> 40 41<H2>Revision History</H2> 42<P> 432006/03/01 Initial version.<br> 44</P> 45 46<hr><p>CONFIDENTIAL</p></body> 47</HTML>