BitmapLoaderData Class Reference

#include <c4d_filterdata.h>

Inheritance diagram for BitmapLoaderData:

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

Detailed Description

A data class for bitmap loaders plugins.

Constructor & Destructor Documentation

~BitmapLoaderData()

virtual ~BitmapLoaderData ( )

virtual

Default destructor.

Member Function Documentation

Identify()

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

pure 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.

Implemented in BmpLoader, and JpgLoader.

Load()

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

pure 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

Implemented in BmpLoader, and JpgLoader.

GetSaver()

virtual Int32 GetSaver ( )

pure 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.

Implemented in BmpLoader, and JpgLoader.