BitmapExtensionsGetColors Method

Gets the colors used in the defined bitmap. A limit can be defined in maxColors.

Definition

Namespace: KGySoft.Drawing
Assembly: KGySoft.Drawing (in KGySoft.Drawing.dll) Version: 8.1.0
C#
public static Color[] GetColors(
	this Bitmap bitmap,
	int maxColors = 0,
	bool forceScanningContent = false
)

Parameters

bitmap  Bitmap
The bitmap, whose colors have to be returned. If it is indexed and the forceScanningContent parameter is , then its palette entries are returned and maxColors is ignored.
maxColors  Int32  (Optional)
A limit of the returned colors. If forceScanningContent parameter is , then this parameter is ignored for indexed bitmaps. Use 0 for no limit. This parameter is optional.
Default value: 0.
forceScanningContent  Boolean  (Optional)
to force scanning the actual image content even if the specified bitmap is indexed and has a palette. This parameter is optional.
Default value: .

Return Value

Color
An array of Color entries.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Bitmap. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

Completely transparent pixels are considered the same regardless of their color information.

Every PixelFormat is supported, though wide color formats (Format16bppGrayScale, Format48bppRgb, Format64bppArgb and Format64bppPArgb) are quantized to 32 bit during the processing. To get the actual number of colors, which is accurate even for wide color formats, use the GetColorCount method.

See Also