Blt
Expand Minimize

GetOverlayColorControls routine

The GetOverlayColorControls function retrieves color-control settings for the given overlay.

Syntax


PFND3DDDI_GETOVERLAYCOLORCONTROLS GetOverlayColorControls;

__checkReturn HRESULT APIENTRY GetOverlayColorControls(
  _In_     HANDLE hDevice,
  _Inout_  D3DDDIARG_GETOVERLAYCOLORCONTROLS *pData
)
{ ... }

Parameters

hDevice [in]

A handle to the display device (graphics context).

pData [in, out]

A pointer to a D3DDDIARG_GETOVERLAYCOLORCONTROLS structure that describes parameters for retrieving an overlay's color-control settings.

Return value

GetOverlayColorControls returns one of the following values:

Return codeDescription
S_OK

The color-control settings were successfully retrieved.

E_INVALIDARG

Parameters were validated and determined to be incorrect.

E_OUTOFMEMORY

GetOverlayColorControls could not allocate the required memory for it to complete.

 

Remarks

The Microsoft Direct3D runtime calls the GetOverlayColorControls function to return the current brightness, contrast, hue, saturation, sharpness, gamma, and color-enable settings that are associated with a specific overlay.

The runtime can also call GetOverlayColorControls for an overlay that is not yet visible. In this situation, when the hOverlay member of the D3DDDIARG_GETOVERLAYCOLORCONTROLS structure pointed to by pData is set to NULL, the driver should return the default color-control settings of the overlay hardware.

Requirements

Version

Available in Windows Vista and later versions of the Windows operating systems.

Header

D3dumddi.h (include D3dumddi.h)

See also

D3DDDIARG_GETOVERLAYCOLORCONTROLS
D3DDDI_DEVICEFUNCS

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft