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>GXSetDispCopyYScale</TITLE> 9</HEAD> 10<BODY> 11<H1 align="left">GXSetDispCopyYScale</H1> 12 13<H2>Syntax</H2> 14<dl><dd><pre class="construction"> 15#include <revolution/gx.h> 16 17u32 GXSetDispCopyYScale( f32 yscale ); 18</pre></dd></dl> 19 20<H2>Arguments</H2> 21<TABLE class="arguments" border="1" > 22 <TBODY> 23 <TR> 24<TH>yscale</TH> 25<TD>Vertical scale value. Range is 1.0 to 256.0.</TD> 26 </TR> 27 </TBODY> 28</TABLE> 29 30<H2>Return Values</H2> 31<P>Number of lines that will be copied. Uses the display source size when this function is called as the base.</P> 32 33<H2>Description</H2> 34<P>This function sets the vertical scale for the embedded frame buffer (EFB) to external frame buffer (XFB) copy operation. Normally the vertical scale is set passing the current <A href="RenderMode.html">Render Mode</A> parameters to <A href="GXGetYScaleFactor.html"><CODE>GXGetYScaleFactor</CODE></A> function:</P> 35<DL><DD><CODE><A href="../Structures/GXRenderModeObj.html">GXRenderModeObj</A>* rmode = &GXNtsc240IntAa;<BR> u32 nlines;<BR> f32 yscale;<BR> <BR> yscale = GXGetYScaleFactor(rmode->efbHeight, rmode->xfbHeight);<BR> nlines = GXSetDispCopyYScale(yscale);<BR></CODE></DD></DL> 36<P>The number of actual lines copied is returned based on the current EFB height (the <A href="GXSetDispCopySrc.html"><CODE>GXSetDispCopySrc</CODE></A> function). You can use this number to allocate the proper XFB size. To use the function to get the number of lines, it is necessary to call the <A href="GXSetDispCopySrc.html"><CODE>GXSetDispCopySrc</CODE></A> function first. There is also another way to calculate the line number, using the <A href="GXGetNumXfbLines.html"><CODE>GXGetNumXfbLines</CODE></A> function.</P> 37 38<H2>See Also</H2> 39<P class="reference"> 40<A href="RenderMode.html">Render Modes</A>, 41<A href="GXCopyDisp.html">GXCopyDisp</A>, 42<A href="GXSetDispCopySrc.html">GXSetDispCopySrc</A>, 43<A href="GXGetYScaleFactor.html">GXGetYScaleFactor</A>, 44<A href="GXGetNumXfbLines.html">GXGetNumXfbLines</A> 45</P> 46 47<H2>Revision History</H2> 48<P> 492006/03/01 Initial version.<br> 50</P> 51 52<hr><p>CONFIDENTIAL</p></body> 53</HTML>