c4d_basebitmap.h File Reference

Classes
class	ColorProfile
class	ColorProfileConvert
class	BaseBitmap
class	MultipassBitmap
class	BaseBitmapLink
class	MovieLoader
class	MovieSaver
class	BitmapLoaderPlugin
class	BitmapSaverPlugin
class	AutoBitmap

Macros
#define	PIX_UCHAR(p)
#define	PIX_UWORD(p)
#define	PIX_FLOAT(p)
#define	B3D_BITDEPTH(mode)
#define	B3D_COLOR_MODE(mode)
#define	B3D_SETDEPTH(depth)
#define	B3D_IS_CHAR(mode)
#define	B3D_IS_UWORD(mode)
#define	B3D_IS_FLOAT(mode)
#define	COLORMODE_MAXCOLOR
#define	COLORBYTES_GRAY
#define	COLORBYTES_AGRAY
#define	COLORBYTES_RGB
#define	COLORBYTES_ARGB
#define	COLORBYTES_CMYK
#define	COLORBYTES_ACMYK
#define	COLORBYTES_GRAYw
#define	COLORBYTES_AGRAYw
#define	COLORBYTES_RGBw
#define	COLORBYTES_ARGBw
#define	COLORBYTES_GRAYf
#define	COLORBYTES_AGRAYf
#define	COLORBYTES_RGBf
#define	COLORBYTES_ARGBf
#define	COLORBYTES_MAX
#define	BASEBITMAP_DATA_GUIPIXELRATIO
#define	BASEBITMAP_DATA_DPI
#define	BASEBITMAP_DATA_ASPECTRATIO
#define	BASEBITMAP_DATA_EXPORTSETTINGS
#define	BASEBITMAP_DATA_NAME
#define	BASEBITMAP_DATA_PROGRESS_TIME
#define	BASEBITMAP_DATA_PROGRESS_ACTION
#define	BASEBITMAP_DATA_PROGRESS_FRAME
#define	BASEBITMAP_DATA_PROGRESS_SEQ
#define	BASEBITMAP_DATA_PROGRESS_FNUM
#define	BASEBITMAP_DATA_DRAW_REGIONS
#define	BASEBITMAP_DATA_SPINMODE
#define	BASEBITMAP_DATA_HOLDTIME
#define	BASEBITMAP_DATA_STARTTIME
#define	BASEBITMAP_DATA_PROGRESS_PHASE
#define	BASEBITMAP_DATA_FRAMETIME
#define	BASEBITMAP_DATA_TEXTURE_ERROR
#define	BASEBITMAP_DATA_IMAGEREFWRAPPER
#define	BASEBITMAP_DATA_PROGRESSHOOK
#define	BASEBITMAP_DATA_PROGRESSHOOK_CTX
#define	CUSTOMDATATYPE_COLORPROFILE
#define	CUSTOMGUI_COLORPROFILE
#define	BMP_INSERTLAST

Enumerations
enum	BITMAP_UPDATEREGION {   X1,   Y1,   X2,   Y2,   TYPE,   COLOR,   PREPARE }

Functions
enum BITMAP_UPDATEREGION	MAXON_ENUM_LIST (BITMAP_UPDATEREGION)
IconData	InitResourceIcon (Int32 resource_id)
BaseBitmap *	InitResourceBitmap (Int32 resource_id)
BaseBitmap *	GetBitmapFromLockList (BaseDocument *doc, Filename &fn, Int32 frame, LayerSet *lsl, LockList *&lockList, INITRENDERRESULT *initRenderResult=nullptr)
void	Unlock (LockList *&lockList)
Bool	IsMarkedForDeletion (const LockList *lockList)
maxon::Result< maxon::DataDictionary >	GetImageSettingsDictionary (const BaseContainer *data, Int32 filterId)
maxon::Result< void >	SetImageSettingsDictionary (const maxon::DataDictionary &settings, BaseContainer *data, Int32 filterId)
Bool	BitmapSaverPluginSupport (BitmapSaverPlugin *bp, Int flags)
Bool	BitmapSaverPluginSupport (Int32 format, Int flags)
Bool	BitmapSaverPluginIsMovie (BitmapSaverPlugin *bp)
Bool	BitmapSaverPluginIsMovie (Int32 format)

Variables
	X1
	Y1
	X2
	Y2
	TYPE
	COLOR
	PREPARE
ColorProfile	MAXON_ENUM_LIST

Macro Definition Documentation

COLORMODE_MAXCOLOR

#define COLORMODE_MAXCOLOR

Maximum number of color modes.

CUSTOMDATATYPE_COLORPROFILE

#define CUSTOMDATATYPE_COLORPROFILE

ColorProfile custom data ID.

CUSTOMGUI_COLORPROFILE

#define CUSTOMGUI_COLORPROFILE

ColorProfile custom GUI ID.

BMP_INSERTLAST

#define BMP_INSERTLAST

A special MultipassBitmap that can be used to indicate to position a layer last in the list.

See also

MultipassBitmap::AddLayer() / MultipassBitmap::AddFolder() / MultipassBitmap::AddAlpha()

Function Documentation

InitResourceIcon()

IconData InitResourceIcon

(

Int32

resource_id

)

Loads the global icon with ID resource_id.
Cinema 4D registers hundreds of its icons at program start and this way you can access them, for example RESOURCEIMAGE_MOVE is the move symbol. It is also possible to access the icons for commands.

Parameters

[in]

resource_id

The resource ID to load.

Returns

The loaded icon.

InitResourceBitmap()

BaseBitmap* InitResourceBitmap

(

Int32

resource_id

)

Loads the global icon with ID resource_id as a bitmap.
Cinema 4D registers hundreds of its icons at program start and this way you can access them, for example RESOURCEIMAGE_MOVE is the move symbol. It is also possible to access the icons for commands.

Parameters

[in]

resource_id

The resource ID to load.

Returns

The loaded bitmap.

GetBitmapFromLockList()

BaseBitmap* GetBitmapFromLockList	(	BaseDocument *	doc,
		Filename &	fn,
		Int32	frame,
		LayerSet *	lsl,
		LockList *&	lockList,
		INITRENDERRESULT *	initRenderResult = nullptr
	)

Gets a bitmap from a locklist.

Parameters

[in]	doc	The document to which the locklist belongs.
[in]	fn	Filename of the texture.
[in]	frame	Frame number.
[in]	lsl	Layer set.
[out]	lockList	The locklist to which this bitmap belongs.
[out]	initRenderResult	Result of loading the textures. Can be nullptr.

Returns

The locklist bitmap.

Unlock()

void Unlock

(

LockList *&

lockList

)

Unlocks a locklist. The parameter must be the same that was returned from GetBitmapFromLockList.

Parameters

[in]

lockList

Locklist to unlock.

IsMarkedForDeletion()

Bool IsMarkedForDeletion

(

const LockList *

lockList

)

Checks if a locklist is marked for deletion.

Parameters

[in]

lockList

Locklist to check.

GetImageSettingsDictionary()

maxon::Result<maxon::DataDictionary> GetImageSettingsDictionary	(	const BaseContainer *	data,
		Int32	filterId
	)

Extracts the DataDictionary from the BaseContainer.
The DataDictionary stores the image format settings.

Parameters

[in]	data	BaseContainer to extract.
[in]	filterId	Filter id to separate settings between different filters.

Returns

Extracted DataDictionary.

SetImageSettingsDictionary()

maxon::Result<void> SetImageSettingsDictionary	(	const maxon::DataDictionary &	settings,
		BaseContainer *	data,
		Int32	filterId
	)

Replaces the DataDictionary in the BaseContainer.
The DataDictionary stores the image format settings.

Parameters

[in]	settings	Settings to replace
[out]	data	BaseContainer to modify.
[in]	filterId	Filter id to separate settings between different filters.

Returns

OK on success.

BitmapSaverPluginSupport() [1/2]

Bool BitmapSaverPluginSupport	(	BitmapSaverPlugin *	bp,
		Int	flags
	)

BitmapSaverPluginSupport() [2/2]

Bool BitmapSaverPluginSupport	(	Int32	format,
		Int	flags
	)

BitmapSaverPluginIsMovie() [1/2]

Bool BitmapSaverPluginIsMovie

(

BitmapSaverPlugin *

bp

)

BitmapSaverPluginIsMovie() [2/2]

Bool BitmapSaverPluginIsMovie

(

Int32

format

)

Variable Documentation

X1

X1

Int32.

Y1

Y1

Int32.

X2

X2

Int32.

Y2

Y2

Int32.

TYPE

TYPE

Int32.

COLOR

COLOR

Vector.

PREPARE

PREPARE

Bool.