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>Render Modes</TITLE> 9</HEAD> 10<BODY> 11<H1 align="left">Render Modes</H1> 12<H2>Syntax</H2> 13<dl><dd><pre class="construction"> 14#include <revolution/gx.h> 15</pre></dd></dl> 16 17<H2>Description</H2> 18<P>To enable the render mode variables for the GX API, initialize the <A href="../Structures/GXRenderModeObj.html"><CODE>GXRenderModeObj</CODE></A> structure set. Active render modes are as indicated on the <A href="#Render Mode Structures">lower half</A> of this page. The application can provide the default values for display-related functions and, if preferred, disable them.</P> 19<P><A href="../Management/GXInit.html"><CODE>GXInit</CODE></A> sets the render mode to the appropriate <A href="#GXNtsc480IntDf"><CODE>GXNtsc480IntDf</CODE></A> and <CODE><A href="#GXPal528IntDf">GXPal528IntDf</A></CODE>.</P> 20 21<H2>Code Example</H2> 22<P>The following is just a basic example. It is not necessarily the optimal way of managing your frame loop.</P> 23<DL><DD><CODE>main()<BR> {<BR> // Set up rendering display mode to NTSC 240 <BR> // lines per field interlaced.<BR> // Antialiased rendering.<BR> <A href="../Structures/GXRenderModeObj.html">GXRenderModeObj</A>* rmode = &<A href="#GXNtsc240IntAa">GXNtsc240IntAa</A>;<BR> u16* bufA, bufB, nextbuffer;<BR> u32 count;<BR> u8* fifo;<BR> f32 yScale;<BR> u32 n_xfb_lines;<BR> <BR> fifo = <A href="../../os/Alloc/OSAlloc.html">OSAlloc</A>(FIFO_SIZE);<BR> <A href="../Management/GXInit.html">GXInit</A>(fifo, FIFO_SIZE); <BR> <A href="../../vi/VIInit.html">VIInit</A>();<BR> <BR> // Set up video<BR> <A href="../../vi/VIConfigure.html">VIConfigure</A>(rmode);<BR> <BR> // Set other GX state <BR> <A href="../Culling/GXSetScissor.html">GXSetScissor</A>( 0, 0, rmode->fbWidth, rmode->efbHeight );<BR> <BR> <A href="GXSetDispCopySrc.html">GXSetDispCopySrc</A>(0, 0, rmode->fbWidth, rmode->efbHeight);<BR> <BR> // call yscale after setting display copy source<BR> n_xfb_lines = // account for yscale in xfb height<BR> <A href="GXSetDispCopyYScale.html">GXSetDispCopyYScale</A>((f32)(rmode->xfbHeight /<BR> (f32)(rmode->efbHeight));<BR> <BR> <A href="GXSetDispCopyDst.html">GXSetDispCopyDst</A>(rmode->fbWidth, n_xfb_lines);<BR> <A href="GXSetCopyFilter.html">GXSetCopyFilter</A>(rmode->aa, rmode->sample_pattern,<BR> GX_TRUE, rmode->vfilter);<BR> <BR> if (rmode->aa)<BR> <A href="../PixelProc/GXSetPixelFmt.html">GXSetPixelFmt</A>(GX_PF_RGB565_Z16, GX_ZC_LINEAR);<BR> else<BR> <A href="../PixelProc/GXSetPixelFmt.html">GXSetPixelFmt</A>(GX_PF_RGB8_Z24, GX_ZC_LINEAR);<BR> <BR> <A href="../PixelProc/GXSetFieldMode.html">GXSetFieldMode</A>(rmode->field_rendering, rmode->xfbHeight < rmode->viHeight);</CODE></DD></DL> 24<DL><DD><CODE> // Allocate the main memory for the framebuffer<BR> bufA = <A href="../../os/Alloc/OSAlloc.html">OSAlloc</A>( <A href="../../vi/VIPadFrameBufferWidth.html">VIPadFramebufferWidth</A>(rmode->fbWidth) * n_xfb_lines * VI_DISPLAY_PIX_SZ);<BR> bufB = <A href="../../os/Alloc/OSAlloc.html">OSAlloc</A>( <A href="../../vi/VIPadFrameBufferWidth.html">VIPadFramebufferWidth</A>(rmode->fbWidth) * n_xfb_lines * VI_DISPLAY_PIX_SZ);<BR> <BR> // main rendering loop<BR> nextbuffer = bufA;<BR> count = 0;<BR> <BR> while (1) {<BR> // jitter frustum for field rendering<BR> if (rmode->field_rendering)<BR> <A href="../Transform/GXSetViewportJitter.html">GXSetViewportJitter</A>(<BR> 0.0f, 0.0f,<BR> (f32)(rmode->fbWidth), <BR> (f32)(rmode->efbHeight), <BR> 0.0f, 1.0f,<BR> <A href="../../vi/VIGetNextField.html">VIGetNextField</A>());<BR> else<BR> <A href="../Transform/GXSetViewport.html">GXSetViewport</A>( <BR> 0.0f, 0.0f,<BR> (f32)(rmode->fbWidth), <BR> (f32)(rmode->efbHeight), <BR> 0.0f, 1.0f );<BR> <BR> // do some rendering<BR> doRendering();<BR> <BR> // copy framebuffer from EFB (on chip) to XFB (main memory)<BR> // and clear the color and z buffer<BR> <A href="GXCopyDisp.html">GXCopyDisp</A>(nextbuffer, GX_TRUE);<BR> <A href="../Management/GXDrawDone.html">GXDrawDone</A>();<BR> <BR> // tell VI that a new buffer is done and its type<BR> <A href="../../vi/VISetNextFrameBuffer.html">VISetNextFrameBuffer</A>(nextbuffer);<BR> <A href="../../vi/VIFlush.html">VIFlush</A>();<BR> <A href="../../vi/VIWaitForRetrace.html">VIWaitForRetrace</A>();<BR> <BR> // swap buffers<BR> if (count ^= 1) nextbuffer = bufB;<BR> else nextbuffer = bufA;<BR> }<BR> }</CODE></DD></DL> 25 26<H2>Definitions</H2> 27<P>NTSC - Video standard used in North America and Japan.</P> 28<P>PAL - Video standard used in Europe.</P> 29<P>EURGB60Hz - RGB 60Hz, 480 line mode (same timing and aspect ratio as NTSC) used in Europe.</P> 30<P>Double-Strike (Ds) - Display two fields at the same location on the TV. This is as opposed to interlaced displays, in which one field represents even lines and the other field represents odd lines. The advantage of this mode is that it is easy to drop fields. The disadvantage is that it is half the resolution vertically of interlaced displays.</P> 31<P>Interlaced (Int) - Display one field as even lines on the TV and display the next field as odd lines on the TV.</P> 32<P>Progressive (Prog) - Display all lines of a frame in one pass.</P> 33<P>De-Flicker (Df) - A method of filtering the flicker artifacts that occur when displaying objects that appear in one field but not the next of an interlaced display. Deflickering uses information from both fields and applies a (vertical) filter to this information to create each displayed line.</P> 34<P>Anti-alias (Aa) - Anti-aliasing on Wii uses a subsampling method. Three samples are computed for each pixel and stored in the EFB. A filter is applied to these samples during the copy from the EFB to the XFB. When anti-aliasing, each pixel occupies 2 times the memory in the EFB versus not anti-aliasing. For the largest frame sizes (640 x 480 or 640 x 528), there is not enough memory to render an entire anti-aliased image, so the application must render the image in two passes. Typically the application would first render the top half of the frame and copy it out, then render the bottom half and copy it out to the XFB.</P> 35 36<H2><A name="Render Mode Structures">Render Mode Structures</A></H2> 37<P>Note that any Render Mode structures that are not referenced by the application code will be dead-stripped from the object file by the linker.</P> 38 39<H3>GXNtsc240Ds</H3> 40<P>This render mode can be considered a 'non-interlaced low-res' render mode since both fields are drawn at the same location on the display (double-strike).</P> 41 42<H3>GXNtsc240DsAa</H3> 43<P>This render mode combines double-strike frame rendering with antialiasing.</P> 44 45<H3><A name="GXNtsc240Int">GXNtsc240Int</A></H3> 46<P>This render mode requires the application to maintain a 60Hz field update rate. This is an interlaced render mode, so effectively it appears to the viewer to be 480 lines (although it blinks at very high speed). However, the application only needs to fill 240 lines (per frame). If the application cannot maintain the 60Hz rate, it will need to make provisions for dropping fields, which can be visually strange.</P> 47 48<H3><A name="GXNtsc240IntAa">GXNtsc240IntAa</A></H3> 49<P>This mode enables anti-aliasing so each pixel will be the average of three subpixels. However, anti-aliasing incurs a fill rate penalty (1/2 of the maximum fill rate). But if the application uses an average of two textures/pixel, the fill rate is still close to 1/2 of the maximum (so use some multi-texture in this mode). This mode must also maintain a 60Hz field update rate or be prepared to drop fields.</P> 50 51<H3><A name="GXNtsc480IntDf">GXNtsc480IntDf</A></H3> 52<P>This mode renders 480 lines in order to produce two deflickered fields (240 lines each). The frame rate is 60Hz or less. Each field will be deflickered, meaning some of the information from the odd lines will be present in the even lines and vice versa. This makes for a more <EM>flicker-free</EM> display. If one renders at 60Hz, it may appear that there is a fill-rate penalty since one rendered field is thrown away during each cycle. However, that field had to be computed in order to perform proper deflickering. Also, the <EM>extra</EM> field is available as a backup in case the update rate drops below 60Hz, preventing some of the unpleasant anomalies that occur when a field is dropped in field-rendering mode.</P> 53 54<H3>GXNtsc480Int</H3> 55<P>This render mode is the standard 'frame' rendering mode. This mode produces both even and odd lines at the same time -- a frame. Usually the update rate for this mode is 30Hz.</P> 56 57<H3>GXNtsc480IntAa</H3> 58<P>This render mode requires more memory than the EFB has available, so the application must do two passes, each pass rendering half the lines. Since this mode also produces both fields, the update rate is normally 30Hz. Deflicker is available in this mode as well. Note that proper deflicker filtering requires overlapping each half slightly.</P> 59 60<H3>GXNtsc480Prog</H3> 61<P>This mode renders 480 lines and display all the lines at 60Hz. The frame rate is 60Hz or less. The vertical filter is effectively turned off in this mode; that may produce a "sharper" image.</P> 62 63<H3>GXNtsc480ProgSoft</H3> 64<P>This mode renders 480 lines and display all the lines at 60Hz. The frame rate is 60Hz or less. The vertical filter is turned on in this mode to produce a softer or more blurred image than <CODE>GXNtsc480Prog</CODE>.</P> 65 66<H3>GXNtsc480ProgAa</H3> 67<P>This mode renders 480 lines and display all the lines at 60Hz. The frame rate is 60 Hz or less. As with <CODE>GXNtsc480IntAa</CODE>, rendering a full frame in this mode requires doing two (overlapped) rendering passes. The vertical filter is enabled in order to do proper antialiasing.</P> 68 69<H3>GXPal264Ds</H3> 70<H3>GXPal264DsAa</H3> 71<H3>GXPal264Int</H3> 72<H3>GXPal264IntAa</H3> 73<H3><A name="GXPal528IntDf">GXPal528IntDf</A></H3> 74<H3>GXPal528Int</H3> 75<H3>GXPal524IntAa</H3> 76<P>These modes are similar to the NTSC modes; only the video format differs.</P> 77<P>Note that PAL interlaced anti-aliased mode is only 524 lines tall. Rendering an anti-aliased frame requires rendering two half-height sub-images. However, proper filtering requires overlapping the two sub-images. Due to various hardware restrictions, 4 lines are duplicated. Since the anti-aliased EFB is only 264 lines tall, a maximum size of 524 lines results from these requirements.</P> 78 79<H3>GXEurgb60Hz240Ds</H3> 80<H3>GXEurgb60Hz240DsAa</H3> 81<H3>GXEurgb60Hz240Int</H3> 82<H3>GXEurgb60Hz240IntAa</H3> 83<H3><A name="GXEurgb60Hz480IntDf">GXEurgb60Hz480IntDf</A></H3> 84<H3>GXEurgb60Hz480Int</H3> 85<H3>GXEurgb60Hz480IntAa</H3> 86<H3>GXEurgb60Hz480Prog</H3> 87<H3>GXEurgb60Hz480ProgSoft</H3> 88<H3>GXEurgb60Hz480ProgAa</H3> 89<P>These modes are similar to the NTSC modes; only the video format differs.</P> 90 91<H2>Arguments</H2> 92<P>None.</P> 93 94<H2>Return Values</H2> 95<P>None.</P> 96 97<H2>See Also</H2> 98<P>None.</P> 99 100<H2>Revision History</H2> 101<P> 1022008/06/19 Removed mention of MPAL.<br>2006/06/16 Added progressive scan mode for PAL, EURGB60, and MPAL.<br>2006/03/01 Initial version.<br> 103</P> 104 105<hr><p>CONFIDENTIAL</p></body> 106</HTML>