FreeImage.SaveToStream Method (FIBITMAP, Stream, FREE_IMAGE_FORMAT, FREE_IMAGE_SAVE_FLAGS, FREE_IMAGE_COLOR_DEPTH)

FreeImage.NET

previous page next page

FreeImage.NET Class Library Reference

FreeImageSaveToStream Method (FIBITMAP, Stream, FREE_IMAGE_FORMAT, FREE_IMAGE_SAVE_FLAGS, FREE_IMAGE_COLOR_DEPTH)

Saves a previously loaded FreeImage bitmap to a stream. The stream must be set to the correct position before calling SaveToStream.

Namespace: FreeImageAPI
Assembly: FreeImageNET (in FreeImageNET.dll) Version: 3.17.0.4 (3.17.0)

Syntax

Copy

public static bool SaveToStream(
	FIBITMAP dib,
	Stream stream,
	FREE_IMAGE_FORMAT format,
	FREE_IMAGE_SAVE_FLAGS flags,
	FREE_IMAGE_COLOR_DEPTH colorDepth
)

Parameters

dib: Type: FreeImageAPIFIBITMAP
Handle to a FreeImage bitmap.
stream: Type: System.IOStream
The stream to write to.
format: Type: FreeImageAPIFREE_IMAGE_FORMAT
Format of the image.
flags: Type: FreeImageAPIFREE_IMAGE_SAVE_FLAGS
Flags to enable or disable plugin-features.
colorDepth: Type: FreeImageAPIFREE_IMAGE_COLOR_DEPTH
The new color depth of the bitmap. Set to FICD_AUTO if SaveToStream should take the best suitable color depth. If a color depth is selected that the provided format cannot write an error-message will be thrown.

Return Value

Type: Boolean
Returns true on success, false on failure.

Exceptions

Exception	Condition
ArgumentNullException	dib or stream is null.
ArgumentException	stream cannot write.

Reference

FreeImage Class

SaveToStream Overload

FreeImageAPI Namespace

Contact/Feedback: FreeImage.NET Homepage
Help improve this Documentation: Join the Project

previous page start next page