# G2*_GetWndOutsidePlane

## C Specification

      #include <nitro/gx/g2.h>

      GXWndPlane G2_GetWndOutsidePlane( void );
      GXWndPlane G2S_GetWndOutsidePlane( void );

## Arguments

None.

## Return Values

Information for the plane being displayed outside of the window.

## Description

Gets the settings for the plane that is displayed outside of the window and the existence of color effects as the `GXWndPlane` structure.
Use the `G2_GetWndOutsidePlane` function to get the settings for the main 2D engine, and use `G2S_GetWndOutsidePlane` 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 outside of the window. To read more details, see the reference for the `G2_SetWndOutsidePlane` 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_SetWndOutsidePlane

## Revision History

12/24/2004 Initial version.

CONFIDENTIAL