G2*_GetWnd0InsidePlane

C Specification

#include <nitro/gx/g2.h>

GXWndPlane G2_GetWnd0InsidePlane( void );
GXWndPlane G2S_GetWnd0InsidePlane( void );

Arguments

None.

Return Values

Information for the plane being displayed in the window.

Description

Gets the settings for the plane that is displayed inside Window 0 and the existence of color effects using the GXWndPlane structure.
Use the G2_GetWnd0InsidePlane function to get the settings for the main 2D engine, and use G2S_GetWnd0InsidePlane to get the settings for the sub 2D engine.

The GXWndPlane structure that gets returned includes the following information:

planeMask Information about the settings for the plane that is being displayed in the window. To read more details, see the reference for the G2_SetWnd0InsidePlane function.
effect The setting for the existence of color effects inside the window.

Following is the type definition for type GXWndPlane:

typedef struct
{
u8      planeMask       :5;
u8      effect          :1;
u8      _reserve        :2;
}
GXWndPlane;

See Also

G2_SetWnd0InsidePlane

Revision History

12/24/2004 Initial version.