GXGetNumXfbLines

C Specification

#include <revolution/gx.h>
u16 GXGetNumXfbLines( u16 efbHeight, f32 yscale );

Arguments

efbHeight Height of the embedded frame buffer, in increments of two (2 to 528).
yscale Vertical scale value Range from 1.0 to 256.0

Return Values

Number of lines that will be copied.

Description

This is a convenient function for calculating the number of lines copied to the external frame buffer (XFB), based on given EFB height and Y scale. You can use this number to allocate the proper XFB size. You can also obtain this return value using GXSetDispCopyYScale. In contrast to GXSetDispCopyYScale, this function does not affect the graphics processor. It only calculates the number based on input arguments.

See Also

GXSetDispCopyYScale
GXGetYScaleFactor

Revision History

03/01/2006 Initial version.