NtGdiDdSetColorKey function

[This function is subject to change with each operating system revision. Instead, use the Microsoft DirectDraw and Microsoft Direct3DAPIs; these APIs insulate applications from such operating system changes, and hide many other difficulties involved in interacting directly with display drivers.]

Sets the color key value for the specified surface.


  _In_    HANDLE              hSurface,
  _Inout_ PDD_SETCOLORKEYDATA puSetColorKeyData


hSurface [in]

Pointer to the DD_SURFACE_LOCAL structure that describes the surface with which the color key is to be associated.

puSetColorKeyData [in, out]

Pointer to a DD_SETCOLORKEYDATA structure that contains the information required to set the color key for the specified surface.

Return value

NtGdiDdSetColorKey returns one of the following callback codes.

Return codeDescription

The driver has performed the operation and returned a valid return code for that operation. If this code is DD_OK, DirectDraw or Direct3D proceeds with the function. Otherwise, DirectDraw or Direct3D returns the error code provided by the driver and aborts the function.


The driver has no comment on the requested operation. If the driver is required to have implemented a particular callback, DirectDraw or Direct3D reports an error condition. Otherwise, DirectDraw or Direct3D handles the operation as if the driver callback had not been defined by executing the DirectDraw or Direct3D device-independent implementation.



Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]



See also

Graphics Low Level Client Support