Help Center

CGpGraphics.GetNearestColormethod

Gets the nearest color to the color that is passed in.

GraphicsmethodCGpGraphics.incdocumented

Syntax

FUNCTION GetNearestColor (BYVAL colour AS ARGB PTR) AS GpStatus

Parameters

NameDescription
colourPointer to a DWORD variable that, on input, specifies the color to be tested and, on output, receives the nearest color found in the color palette.

Return value

If the function succeeds, it returns StatusOk, which is an element of the GpStatus enumeration.

If the function fails, it returns one of the other elements of the GpStatus enumeration.

Description

Gets the nearest color to the color that is passed in. This method works on 8-bits per pixel or lower display devices for which there is an 8-bit color palette.

Example

' ======================================================================================== ' The following example creates a Color object and fills a rectangle with that color. It ' then gets the nearest 8-bit color and fills a second rectangle with that color. ' ======================================================================================== SUB Example_GetNearestColor (BYVAL hdc AS HDC)

' // Create a graphics object from the window device context DIM graphics AS CGpGraphics = hdc ' // Set the scale transform graphics.ScaleTransformForDpi

' // Create a Color object, and fill a rectangle with that color. DIM colour AS ARGB = &hFFA53F88 graphics.FillRectangle(@CGpSolidBrush(colour), 0, 0, 100, 100)

' // Get the nearest 8-bit color, and fill a second rectangle with that color. graphics.GetNearestColor(@colour) graphics.FillRectangle(@CGpSolidBrush(colour), 110, 0, 100, 100)

END SUB ' ========================================================================================

Reference

  • Include file CGpGraphics.inc
  • Defined in AfxNova/CGpGraphics.inc:426
  • Documented in Graphics/GdiPlus Classes/CGpGraphics Classes.md
  • Topic: CGpGraphics Class