Returns the file background color of an image. For 8-bit images, the color index in the palette is returned in the rgbReserved member of the bkcolor parameter.

Namespace:  FreeImageAPI
Assembly:  FreeImageNET (in FreeImageNET.dll)

Syntax

C#
public static bool GetBackgroundColor(
	FIBITMAP dib,
	out RGBQUAD bkcolor
)
Visual Basic (Declaration)
Public Shared Function GetBackgroundColor ( _
	dib As FIBITMAP, _
	<OutAttribute> ByRef bkcolor As RGBQUAD _
) As Boolean
Visual C++
public:
static bool GetBackgroundColor(
	FIBITMAP dib, 
	[OutAttribute] RGBQUAD% bkcolor
)

Parameters

dib
Type: FreeImageAPI..::.FIBITMAP
Handle to a FreeImage bitmap.
bkcolor
Type: FreeImageAPI..::.RGBQUAD %
The background color.

Return Value

Returns true on success, false on failure.

Version Information

FreeImage.NET

Supported in: 3.11.0, 3.12.0, 3.13.0, 3.13.1

See Also