GXSetDispCopyYScale

Syntax

#include <revolution/gx.h>

u32 GXSetDispCopyYScale( f32 yscale );

Arguments

yscale Vertical scale value. Range is 1.0 to 256.0.

Return Values

Number of lines that will be copied. Uses the display source size when this function is called as the base.

Description

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 Render Mode parameters to GXGetYScaleFactor function:

GXRenderModeObj* rmode = &GXNtsc240IntAa;
u32              nlines;
f32              yscale;

yscale = GXGetYScaleFactor(rmode->efbHeight, rmode->xfbHeight);
nlines = GXSetDispCopyYScale(yscale);

The number of actual lines copied is returned based on the current EFB height (the GXSetDispCopySrc 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 GXSetDispCopySrc function first. There is also another way to calculate the line number, using the GXGetNumXfbLines function.

See Also

Render Modes, GXCopyDisp, GXSetDispCopySrc, GXGetYScaleFactor, GXGetNumXfbLines

Revision History

2006/03/01 Initial version.


CONFIDENTIAL