PFND3DDDI_GETOVERLAYCOLORCONTROLS callback function (d3dumddi.h)

Article
04/01/2021

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

Syntax

PFND3DDDI_GETOVERLAYCOLORCONTROLS Pfnd3dddiGetoverlaycolorcontrols;

HRESULT Pfnd3dddiGetoverlaycolorcontrols(
  HANDLE hDevice,
  D3DDDIARG_GETOVERLAYCOLORCONTROLS *unnamedParam2
)
{...}

Parameters

hDevice

A handle to the display device (graphics context).

unnamedParam2

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 code	Description
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

Requirement	Value
Minimum supported client	Available in Windows Vista and later versions of the Windows operating systems.
Target Platform	Desktop
Header	d3dumddi.h (include D3dumddi.h)