BitmapSaverPlugin Class Reference

#include <c4d_basebitmap.h>

Inheritance diagram for BitmapSaverPlugin:

Detailed Description

The bitmap saver class is used to write images. Cannot be instantiated
Call FindPlugin() or FilterPluginList() with the plugin type PLUGINTYPE::BITMAPFILTER to retrieve bitmap loader instances.
Alternatively browse through all the plugin instances with GetFirstPlugin().

Public Member Functions

void BmGetDetails (Int32 *alpha, maxon::String *suffix)
Bool BmEdit (BaseContainer *data)
Int32 BmGetMaxResolution (Bool layers)
void BmCorrectResolution (const BaseContainer *settings, Int32 videoWidth, Int32 videoHeight, Int32 &videoWidthPadded, Int32 &videoHeightPadded)
IMAGERESULT BmSave (const Filename &name, BaseBitmap *bm, BaseContainer *data, SAVEBIT savebits)
IMAGERESULT BmOpen (PluginMovieData *&md, const Filename &name, BaseBitmap *bm, BaseContainer *data, SAVEBIT savebits, Int32 fps)
IMAGERESULT BmWrite (PluginMovieData *md, BaseBitmap *bm)
void BmClose (PluginMovieData *&md)
- Public Member Functions inherited from BasePlugin
BasePluginGetNext (void)
BasePluginGetPred (void)
BasePluginGetUp (void)
BasePluginGetDown (void)
BasePluginGetDownLast (void)
void * GetPluginStructure ()
Int32 GetInfo ()
Filename GetFilename ()
maxon::DllRef GetDllRef ()
Int32 GetID ()
PLUGINTYPE GetPluginType () const
- Public Member Functions inherited from BaseList2D
void SetBit (Int32 mask)
Bool GetBit (Int32 mask) const
void DelBit (Int32 mask)
void ToggleBit (Int32 mask)
Int32 GetAllBits () const
void SetAllBits (Int32 bits)
void SetBitEx (Int32 mask, Int32 flags)
const CharGetViewportRenderId (VIEWPORT_RENDER_ID typeId) const
BaseList2DGetNext ()
BaseList2DGetPred ()
BaseContainer GetData ()
void SetData (const BaseContainer &bc, Bool add=true)
const BaseContainerGetDataInstance () const
BaseContainerGetDataInstance ()
const BaseContainerGetDataInstanceRef () const
BaseContainerGetDataInstanceRef ()
String GetName () const
void SetName (const maxon::String &name)
String GetBubbleHelp ()
Bool TransferGoal (BaseList2D *dst, Bool undolink)
Bool TransferMarker (BaseList2D *dst) const
Bool Scale (Float scale)
Bool Edit ()
void GetIcon (IconData *dat)
GeListHeadGetNLARoot ()
BaseList2DAnimationLayerRemap (BaseObject **layer=nullptr)
String GetTypeName ()
BaseList2DGetMain () const
void InsertTrackSorted (CTrack *track)
Bool AddEventNotification (BaseList2D *bl, NOTIFY_EVENT eventid, NOTIFY_EVENT_FLAG flags, const BaseContainer *data)
Bool RemoveEventNotification (BaseDocument *doc, BaseList2D *bl, NOTIFY_EVENT eventid)
Bool FindEventNotification (BaseDocument *doc, BaseList2D *bl, NOTIFY_EVENT eventid)
Bool SetDescIDState (const DescID &id, DESCIDSTATE descidstate)
DESCIDSTATE GetDescIDState (const DescID &id, Bool tolerant) const
GeListHeadGetOverrideRoot ()
BaseOverrideGetFirstOverride ()
GeListHeadGetShaderRepositoryRoot ()
GeListHeadGetHiddenShaderRoot ()
maxon::NimbusForwardRef GetNimbusRef (const maxon::Id &spaceId) const
maxon::Result< maxon::NimbusForwardRefPrivateGetOrCreateNimbusRef (const maxon::Id &spaceId)
void RemoveNimbusRef (const maxon::Id &spaceId)
maxon::Result< maxon::HashMap< maxon::Id, maxon::NimbusForwardRef > > GetAllNimbusRefs () const
Bool IsNodeBased () const
void GetMarkerStampEx (UInt32 *l1, UInt32 *l2)
const GeMarkerGetMarker () const
void SetMarker (const GeMarker &m)
Bool AddUniqueID (Int32 appid, const Char *const mem, Int bytes)
Bool FindUniqueID (Int32 appid, const Char *&mem, Int &bytes) const
Int32 GetUniqueIDCount () const
Bool GetUniqueIDIndex (Int32 idx, Int32 &id, const Char *&mem, Int &bytes) const
Bool SetAnimatedParameter (CTrack *track, const DescID &id, const GeData &t_data1, const GeData &t_data2, Float mix, DESCFLAGS_SET flags)
Bool GetAnimatedParameter (const DescID &id, GeData &t_data1, GeData &t_data2, Float &mix, DESCFLAGS_GET flags)
BaseShaderGetFirstShader () const
void InsertShader (BaseShader *shader, BaseShader *pred=nullptr)
void ClearKeyframeSelection ()
Bool FindKeyframeSelection (const DescID &id)
Bool SetKeyframeSelection (const DescID &id, Bool selection)
Bool KeyframeSelectionContent ()
LayerObjectGetLayerObject (BaseDocument *doc)
Bool SetLayerObject (LayerObject *layer)
const LayerDataGetLayerData (BaseDocument *doc, Bool rawdata=false)
Bool SetLayerData (BaseDocument *doc, const LayerData &data)
GeListHeadGetCTrackRoot ()
CTrackGetFirstCTrack ()
CTrackFindCTrack (const DescID &id)
- Public Member Functions inherited from GeListNode
GeListNodeGetNext ()
GeListNodeGetPred ()
GeListNodeGetDown ()
GeListNodeGetUp ()
GeListNodeGetDownLast ()
void InsertBefore (GeListNode *bl)
void InsertAfter (GeListNode *bl)
void InsertUnder (GeListNode *bl)
void InsertUnderLast (GeListNode *bl)
void Remove ()
GeListHeadGetListHead ()
Int32 GetNodeID (Int32 index=0) const
template<typename CAST >
const CAST * GetNodeData (Int32 index=0) const
template<typename CAST >
CAST * GetNodeData (Int32 index=0)
void SetCustomData (GeListNode *node)
GeListNodeGetCustomData ()
BaseDocumentGetDocument ()
Int32 GetBranchInfo (BranchInfo *info, Int32 max, GETBRANCHINFO flags)
Bool IsDocumentRelated ()
Int32 GetInfo () const
Bool GetNBit (NBIT bit) const
UInt32 GetNBitMask (Int32 index) const
Bool ChangeNBit (NBIT bit, NBITCONTROL bitmode)
- Public Member Functions inherited from C4DAtom
Int32 GetType () const
Int32 GetRealType () const
Int32 GetDiskType () const
Bool IsInstanceOf (Int32 id) const
Int32 GetClassification () const
Bool Message (Int32 type, void *data=nullptr)
Bool MultiMessage (MULTIMSG_ROUTE flags, Int32 type, void *data)
C4DAtomGetClone (COPYFLAGS flags, AliasTrans *trn)
Bool CopyTo (C4DAtom *dst, COPYFLAGS flags, AliasTrans *trn)
Bool Read (HyperFile *hf, Int32 id, Int32 level)
Bool Write (HyperFile *hf)
Bool ReadObject (HyperFile *hf, Bool readheader)
Bool WriteObject (HyperFile *hf)
Bool GetDescription (Description *description, DESCFLAGS_DESC flags)
Bool GetParameter (const DescID &id, GeData &t_data, DESCFLAGS_GET flags)
Bool SetParameter (const DescID &id, const GeData &t_data, DESCFLAGS_SET flags)
DynamicDescriptionGetDynamicDescription ()
Bool GetEnabling (const DescID &id, const GeData &t_data, DESCFLAGS_ENABLE flags, const BaseContainer *itemdesc)
Bool TranslateDescID (const DescID &id, DescID &res_id, C4DAtom *&res_at)
UInt32 GetDirty (DIRTYFLAGS flags) const
void SetDirty (DIRTYFLAGS flags)
UInt32 GetHDirty (HDIRTYFLAGS mask) const
void SetHDirty (HDIRTYFLAGS mask)

Private Member Functions

 BitmapSaverPlugin ()
 ~BitmapSaverPlugin ()

Additional Inherited Members

- Static Public Member Functions inherited from BaseList2D
static BaseList2DAlloc (Int32 type)
static void Free (BaseList2D *&bl)
- Static Public Attributes inherited from BaseList2D
static const Int32 SETBIT_FLAG_NODIRTY
static const Int32 SETBIT_FLAG_REMOVE
- Protected Member Functions inherited from BasePlugin
 ~BasePlugin ()

Constructor & Destructor Documentation

◆ BitmapSaverPlugin()

BitmapSaverPlugin ( )

◆ ~BitmapSaverPlugin()

~BitmapSaverPlugin ( )

Member Function Documentation

◆ BmGetDetails()

void BmGetDetails ( Int32 alpha,
maxon::String suffix 

Retrieves the BitmapSaverData::GetMaxAlphas() information and the registered suffix of the saver.

[out]alphaAssigned the number of alpha channels.
[out]suffixAssigned the registered suffix string.

◆ BmEdit()

Bool BmEdit ( BaseContainer data)

◆ BmGetMaxResolution()

Int32 BmGetMaxResolution ( Bool  layers)

◆ BmCorrectResolution()

void BmCorrectResolution ( const BaseContainer settings,
Int32  videoWidth,
Int32  videoHeight,
Int32 videoWidthPadded,
Int32 videoHeightPadded 

CorrectResolution corrects the given input size to the preferred saver size.

[in]settingsOptional settings to use.
[in]videoWidthResolution width to check.
[in]videoHeightResolution height to check.
[out]videoWidthPaddedCorrected resolution width.
[out]videoHeightPaddedCorrected resolution height.

◆ BmSave()

IMAGERESULT BmSave ( const Filename name,
BaseBitmap bm,
BaseContainer data,
SAVEBIT  savebits 

◆ BmOpen()

IMAGERESULT BmOpen ( PluginMovieData *&  md,
const Filename name,
BaseBitmap bm,
BaseContainer data,
SAVEBIT  savebits,
Int32  fps 

◆ BmWrite()

IMAGERESULT BmWrite ( PluginMovieData *  md,
BaseBitmap bm 

◆ BmClose()

void BmClose ( PluginMovieData *&  md)