 Important: |
|---|
| This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist. |
The IDirectDrawSurface5::GetColorKeymethod retrieves the color key value for the DirectDrawSurface object.
HRESULT GetColorKey( DWORD dwFlags , LPDDCOLORKEY lpDDColorKey );
Parameters
- dwFlags
- Determines which color key is requested.
DDCKEY_DESTBLT Set if the structure specifies a color key or color space to be used as a destination color key for blit operations. DDCKEY_DESTOVERLAY Set if the structure specifies a color key or color space to be used as a destination color key for overlay operations. DDCKEY_SRCBLT Set if the structure specifies a color key or color space to be used as a source color key for blit operations. DDCKEY_SRCOVERLAY Set if the structure specifies a color key or color space to be used as a source color key for overlay operations. - lpDDColorKey
- Address of the
DDCOLORKEYstructure that
will be filled with the current values for the specified color key
of the DirectDrawSurface object.
Return Values
If the method succeeds, the return value is DD_OK.
If the method fails, the return value may be one of the following error values:
DDERR_INVALIDOBJECT DDERR_INVALIDPARAMS DDERR_NOCOLORKEY DDERR_NOCOLORKEYHW DDERR_SURFACELOST DDERR_UNSUPPORTED Requirements
Runs on Versions Declared in Link to Windows CE OS 2.12 or later. Version 2.12 requires DXPAK 1.0 or later. ddraw.h ddraw.lib See Also
IDirectDrawSurface5::SetColorKey