Blt
Expand Minimize

SetOverlayColorControls routine

The SetOverlayColorControls function changes color-control settings for the given overlay.

Syntax


PFND3DDDI_SETOVERLAYCOLORCONTROLS SetOverlayColorControls;

__checkReturn HRESULT APIENTRY SetOverlayColorControls(
  _In_  HANDLE hDevice,
  _In_  const D3DDDIARG_SETOVERLAYCOLORCONTROLS *pData
)
{ ... }

Parameters

hDevice [in]

A handle to the display device (graphics context).

pData [in]

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

Return value

SetOverlayColorControls returns one of the following values:

Return codeDescription
S_OK

The color-control settings were successfully changed.

E_INVALIDARG

Parameters were validated and determined to be incorrect.

E_OUTOFMEMORY

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

 

Remarks

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

The runtime can also call SetOverlayColorControls for an overlay that is not yet visible. In this situation, when the hOverlay member of the D3DDDIARG_SETOVERLAYCOLORCONTROLS structure pointed to by pData is set to NULL, the driver should store the supplied color-control settings and use them when an overlay that references the specified resource is created.

Requirements

Version

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

Header

D3dumddi.h (include D3dumddi.h)

See also

D3DDDIARG_SETOVERLAYCOLORCONTROLS
D3DDDI_DEVICEFUNCS

 

 

Send comments about this topic to Microsoft

Show:
© 2015 Microsoft