DDICHECKOVERLAYSUPPORTINPUT structure (d3dumddi.h)

The DDICHECKOVERLAYSUPPORTINPUT structure describes an overlay display mode that the user-mode display driver uses to verify overlay support.

Syntax

typedef struct _DDICHECKOVERLAYSUPPORTINPUT {
  [in] UINT                    OverlayWidth;
  [in] UINT                    OverlayHeight;
       D3DDDIFORMAT            OverlayFormat;
  [in] UINT                    DisplayWidth;
  [in] UINT                    DisplayHeight;
  [in] UINT                    DisplayRefreshRate;
  [in] D3DDDIFORMAT            DisplayFormat;
  [in] D3DDDI_SCANLINEORDERING DisplayScanLineOrdering;
  [in] D3DDDI_ROTATION         DisplayRotation;
} DDICHECKOVERLAYSUPPORTINPUT;

Members

[in] OverlayWidth

The width of the overlay in pixels.

[in] OverlayHeight

The height of the overlay in pixels.

OverlayFormat

[in] A D3DDDIFORMAT-typed value that indicates the pixel format of the overlay.

[in] DisplayWidth

The screen width of the display in pixels.

[in] DisplayHeight

The screen height of the display in pixels.

[in] DisplayRefreshRate

The refresh rate of the display.

[in] DisplayFormat

A D3DDDIFORMAT-typed value that indicates the pixel format of the display.

[in] DisplayScanLineOrdering

A D3DDDI_SCANLINEORDERING-typed value that indicates how the scan lines are drawn on the display.

[in] DisplayRotation

A D3DDDI_ROTATION-typed value that indicates how the display is oriented.

Remarks

The runtime specifies a pointer to a DDICHECKOVERLAYSUPPORTINPUT structure in the pInfo member of the D3DDDIARG_GETCAPS structure. The runtime also specifies the D3DDDICAPS_CHECKOVERLAYSUPPORT value in the Type member of D3DDDIARG_GETCAPS. The runtime specifies these values in a call to the user-mode display driver's GetCaps function to determine if the driver supports the overlay that DDICHECKOVERLAYSUPPORTINPUT describes. The driver's GetCaps returns a pointer to a D3DOVERLAYCAPS structure that contains information about the capabilities of the overlay through the pData member of D3DDDIARG_GETCAPS if the driver supports the overlay.

Requirements

Requirement	Value
Minimum supported client	DDICHECKOVERLAYSUPPORTINPUT is supported beginning with the Windows 7 operating system.
Header	d3dumddi.h (include D3dumddi.h)

See also

D3DDDIARG_GETCAPS

D3DDDIFORMAT

D3DDDI_ROTATION

D3DDDI_SCANLINEORDERING

GetCaps