Export (0) Print
Expand All

SetPixel function

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 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 codeDescription
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.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Wingdi.h (include Windows.h)

Library

Gdi32.lib

DLL

Gdi32.dll

See also

Bitmaps Overview
Bitmap Functions
GetDeviceCaps
GetPixel
SetPixelV
COLORREF
RGB

 

 

Community Additions

ADD
Show:
© 2015 Microsoft