PDD_VPORTCB_COLORCONTROL callback function (ddrawint.h)

Article
04/02/2021

The DdVideoPortColorControl callback function gets or sets the VPE object color controls.

Syntax

PDD_VPORTCB_COLORCONTROL PddVportcbColorcontrol;

DWORD PddVportcbColorcontrol(
  PDD_VPORTCOLORDATA unnamedParam1
)
{...}

Parameters

unnamedParam1

Points to a DD_VPORTCOLORDATA structure that contains the information required for the driver to get the current VPE object color controls or to set new values.

Return value

DdVideoPortColorControl returns one of the following callback codes:

Remarks

DirectDraw drivers that set the DDVPCAPS_COLORCONTROL flag in the DDVIDEOPORTCAPS structure must implement DdVideoPortColorControl.

Depending on the value of the dwFlags member of the DD_VPORTCOLORDATA structure at lpColorControl, the driver should do the following:

When dwFlags is DDRAWI_VPORTGETCOLOR, the driver should fill in each member of the DDCOLORCONTROL structure that it supports with the VPE object's current color control setting. The driver must set the corresponding bit in the dwFlags member of DDCOLORCONTROL for every color control member in which it writes data.
DdVideoPortColorControl can be called to determine the color control capabilities of the VPE object. The driver should therefore fail the call if it does not support a requested color control capability.
When dwFlags is DDRAWI_VPORTSETCOLOR, the driver should set the VPE object's color control settings to the values specified in the DDCOLORCONTROL structure. The driver should check the dwFlags member of DDCOLORCONTROL to determine which structure members contain valid data.

Requirements

Requirement	Value
Target Platform	Desktop
Header	ddrawint.h (include Winddi.h)