BmpLoader Class Reference

#include <private_filterbmp.h>

Inheritance diagram for BmpLoader:

Public Member Functions
virtual Bool	Identify (const Filename &name, UChar *probe, Int32 size)
virtual IMAGERESULT	Load (const Filename &name, BaseBitmap *bm, Int32 frame)
virtual Int32	GetSaver ()
Public Member Functions inherited from BitmapLoaderData
virtual	~BitmapLoaderData ()

Member Function Documentation

Identify()

virtual Bool Identify ( const Filename &  name, UChar *  probe, Int32  size  )

virtual

Identifies the file type as one that can be loaded using the bitmap loader plugin. If possible, the file should not be identified through the suffix, but through the probe data.

Parameters

[in]	name	The filename of the file.
[in]	probe	The start of a small chunk of data from the start of the file for testing the file type. Usually the probe size is 1024 bytes. Cineware SDK owns the pointed array.
[in]	size	The size of the chunk for testing the file type.

Returns

true if the plugin recognizes the file.

Implements BitmapLoaderData.

Load()

virtual IMAGERESULT Load ( const Filename &  name, BaseBitmap *  bm, Int32  frame  )

virtual

Loads the image file into a bitmap.

Parameters

[in]	name	The name of the file to load.
[in]	bm	The bitmap to load the image into. The caller owns the pointed bitmap.
[in]	frame	The frame number for formats containing multiple images in a file such as Quicktime or AVI.

Returns

The result of loading the file: IMAGERESULT

Implements BitmapLoaderData.

GetSaver()

virtual Int32 GetSaver ( )

virtual

Returns the ID of the corresponding bitmap saver for the bitmap loader, if there is one.

Returns

The plugin ID of the corresponding BitmapSaverData, or nullptr if there is none.

Implements BitmapLoaderData.