SetPixel function (wingdi.h)
The SetPixel function sets the pixel at the specified coordinates to the specified color.
Syntax
COLORREF SetPixel(
[in] HDC hdc,
[in] int x,
[in] int y,
[in] COLORREF color
);
Parameters
[in] hdc
A handle to the device context.
[in] x
The x-coordinate, in logical units, of the point to be set.
[in] y
The y-coordinate, in logical units, of the point to be set.
[in] color
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 |
---|---|
|
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.
Requirements
Requirement | Value |
---|---|
Minimum supported client | Windows 2000 Professional [desktop apps only] |
Minimum supported server | Windows 2000 Server [desktop apps only] |
Target Platform | Windows |
Header | wingdi.h (include Windows.h) |
Library | Gdi32.lib |
DLL | Gdi32.dll |