This method composite a transparent foreground image against a single background color or against a background image. In case useBitmapBackground is false and applicationBackground and bitmapBackGround are null, a checkerboard will be used as background.

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

Syntax

C#
public bool Composite(
	bool useBitmapBackground,
	Nullable<Color> applicationBackground,
	FreeImageBitmap bitmapBackGround
)
Visual Basic (Declaration)
Public Function Composite ( _
	useBitmapBackground As Boolean, _
	applicationBackground As Nullable(Of Color), _
	bitmapBackGround As FreeImageBitmap _
) As Boolean
Visual C++
public:
bool Composite(
	bool useBitmapBackground, 
	Nullable<Color> applicationBackground, 
	FreeImageBitmap^ bitmapBackGround
)

Parameters

useBitmapBackground
Type: System..::.Boolean
When true the background of this instance is used if it contains one.
applicationBackground
Type: System..::.Nullable<(Of <(Color>)>)
Backgroundcolor used in case useBitmapBackground is false and applicationBackground is not null.
bitmapBackGround
Type: FreeImageAPI..::.FreeImageBitmap
Background used in case useBitmapBackground is false and applicationBackground is a null reference.

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