Share via

IDirectDrawColorControl::GetColorControls (Compact 2013)

  • Article

3/26/2014

This method returns the current color control settings associated with the specified overlay or primary surface. The dwFlags member of the DDCOLORCONTROL structure indicates which of the color control options are supported.

Syntax

HRESULT GetColorControls(
  LPDDCOLORCONTROL lpColorControl
);

Parameters

  • lpColorControl
    Address of the DDCOLORCONTROL structure that will receive the current control settings of the specified surface.

Return Value

If the method succeeds, the return value is DD_OK.

If the method does not succeed, the return value may be one of the following error values:

DDERR_INVALIDOBJECT

DDERR_INVALIDPARAMS

DDERR_UNSUPPORTED

For more information on these error codes see DirectDraw Return Values.

Remarks

The first structure member, dwSize, should be set to the size of the structure, in bytes, before you use it.

When retrieving color controls, you do not need to set the dwFlags before using it - it will contain flags telling you which members are valid after the IDirectDrawColorControl::GetColorControls method returns.

The remaining DDCOLORCONTROL structure members contain values that describe the brightness, contrast, hue, saturation, sharpness and gamma, and whether color is used.

Requirements

Header

ddraw.h

Library

ddraw.lib

See Also

Reference

IDirectDrawColorControl
DirectDraw Reference
DirectDraw Interfaces
IDirectDrawColorControl::SetColorControls
DDCOLORCONTROL

Other Resources

DirectDraw