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<H2>C Specification</H2> 13<DL> 14 <DD> 15<PRE><CODE>#include <revolution/gx.h></CODE></PRE> 16 <DD> 17<PRE><CODE>u32 GXSetDispCopyYScale( f32 yscale );</CODE></PRE> 18</DL> 19<H2>Arguments</H2> 20<TABLE border="1" cellpadding="3" cellspacing="0.1"> 21 <TBODY> 22 <TR> 23<TD width="120" bgcolor="#ffffe8"><EM><STRONG><CODE>yscale</FONT></STRONG></EM></TD> 24<TD width="520">Vertical scale value. The range is from 1.0 to 256.0.</TD> 25 </TR> 26 </TBODY> 27</TABLE> 28<H2>Return Values</H2> 29<P>Number of lines that will be copied. Based on the display source size when this function is called.</P> 30<H2>Description</H2> 31<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"><code>Render Mode</code></a> parameters to <code><a href="GXGetYScaleFactor.html">GXGetYScaleFactor</a></code> function: </P> 32<BLOCKQUOTE><font size="3"><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></CODE></BLOCKQUOTE> 33<P>The number of actual lines copied is returned, based on the current EFB height (<a href="GXSetDispCopySrc.html"><code>GXSetDispCopySrc</code></a>). You can use this number to allocate the proper XFB size. To get the number of lines by using this function, it is necessary to call the <A href="GXSetDispCopySrc.html"><CODE>GXSetDispCopySrc</CODE></A> function before calling this function. There's also another way to calculate this number using <a href="GXGetNumXfbLines.html"><code>GXGetNumXfbLines</code></a>.</P> 34 35 36<H2>See Also</H2> 37<P><A href="RenderMode.html">Render Modes</A></P> 38<P><a href="GXCopyDisp.html">GXCopyDisp</a><br> <a href="GXSetDispCopySrc.html">GXSetDispCopySrc</a><br> <a href="GXGetYScaleFactor.html">GXGetYScaleFactor</a><br> <a href="GXGetNumXfbLines.html">GXGetNumXfbLines</a></P> 39<H2>Revision History</H2> 40<P>03/01/2006 Initial version.</P></BODY> 41</HTML>