GXSetDispCopyYScale

C Specification

#include <revolution/gx.h>
u32 GXSetDispCopyYScale( f32 yscale );

Arguments

yscale Vertical scale value. The range is from 1.0 to 256.0.

Return Values

Number of lines that will be copied. Based on the display source size when this function is called.

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 (GXSetDispCopySrc). 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 GXSetDispCopySrc function before calling this function. There's also another way to calculate this number using GXGetNumXfbLines.

See Also

Render Modes

GXCopyDisp
GXSetDispCopySrc
GXGetYScaleFactor
GXGetNumXfbLines

Revision History

2006/03/01 Initial version.


CONFIDENTIAL