VIConfigurePan

Syntax

#include <revolution/vi.h>

void VIConfigurePan(u16 xOrg, u16 yOrg, u16 width, u16 height);

Arguments

xOrg The pan origin's x coordinate.
yOrg The pan origin's y coordinate.
width The pan width.
height The pan height.

Return Values

None.

Description

This function configures the position and size of the pan.

The pan is the area in the XFB shown on the screen. Normally, there is no need to call the VIConfigurePan function. By default, the pan is set to the same size as the XFB. This function is useful if only a part of the XFB is to be shown.

Be careful when calling VIConfigure after calling VIConfigurePan. The pan information set in VIConfigurePan is reset to default values by VIConfigure.

Changes do not take effect until VIFlush is called. See the VIFlush function reference for more details about when the change takes effect.

See Also

VIFlush, VIConfigure

Revision History

2006/03/01 Initial version.


CONFIDENTIAL