win32 SetPixel

SetPixel

The SetPixel function sets the pixel at the specified coordinates to the specified color.

COLORREF SetPixel(
  __in  HDC hdc,
  __in  int X,
  __in  int Y,
  __in  COLORREF crColor
);

Parameters

hdc [in]
A handle to the device context.

X [in]
The x-coordinate, in logical units, of the point to be set.

Y [in]
The y-coordinate, in logical units, of the point to be set.

crColor [in]
The color to be used to paint the point. To create a COLORREF color value, use the RGB macro.

Return Value

If the function succeeds, the return value is the RGB value that the function sets the pixel to. This value may differ from the color specified by crColor; that occurs when an exact match for the specified color cannot be found.

If the function fails, the return value is -1.

This can be the following value.

Return code	Description
ERROR_INVALID_PARAMETER	One or more of the input parameters is invalid.

Remarks

The function fails if the pixel coordinates lie outside of the current clipping region.

Not all devices support the SetPixel function. For more information, see GetDeviceCaps.