Click or drag to resize
Ab4d.SharpEngine logo

IBitmapIO Interface

IBitmapIO interface defines platform independent methods to provide basic bitmap loading and saving methods.

Namespace: Ab4d.SharpEngine.Common
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 1.0.8740+deb2991acfe86a95cca780cd4f82bcae2805c1a5
Syntax
C#
public interface IBitmapIO

The IBitmapIO type exposes the following members.

Properties
 NameDescription
Public propertyConvertToSupportedFormat When true (by default) then the loaded images are converted into a format that is supported by the engine (32 bit BGRA or RGBA format) When false then the loader tries to preserve the format of the bitmap (for example 8 bit for grayscale) but this is not guaranteed and the loader may still convert the image to BGRA. Also, it is not guaranteed that the image in the original format will be correctly displayed.
Public propertyFileNotFoundResolver Gets or sets a Func that takes file name of a file that does not exists and returns an existing file name. If file name is not resolved, then null is returned.
Public propertyFileStreamResolver Gets or sets a Func that takes file name of a file that does not exists and returns a stream to the file. The returned stream is closed after the bitmap is read. If file name is not resolved, then null is returned.
Top
Methods
 NameDescription
Public methodIsFileFormatExportSupported Returns true when exporting a bitmap to the specified file format that is defined by the fileExtension is supported.
Public methodIsFileFormatImportSupported Returns true when importing a bitmap from the specified file format that is defined by the fileExtension is supported.
Public methodIsStreamSupported Returns true when methods that take Stream as parameter are supported. When false, then only methods that take fileName are supported.
Public methodLoadBitmap(String) Load bitmap into the GpuImageData struct
Public methodLoadBitmap(Stream, String) Load bitmap into the GpuImageData struct
Public methodSaveBitmap(RawImageData, String) Save bitmap from the GpuImageData to the specified file.
Public methodSaveBitmap(RawImageData, Stream, String) Save bitmap from the GpuImageData to the specified fileStream.
Top
See Also