c4d.plugins.BitmapSaverData

A data class for creating bitmap savers. Use RegisterBitmapSaverPlugin() to register the plugin.

Note

See Py-Xample plugin example.

Definition

class c4d.plugins.BitmapSaverData

• BitmapSaverData.Edit()
• BitmapSaverData.Save()

• BitmapSaverData.GetMaxAlphas() NEW
• BitmapSaverData.GetMaxResolution() NEW

Inheritance

• c4d.plugins.BaseData
  • c4d.plugins.BitmapLoaderData

Methods

BitmapSaverData.Edit(self, data)

Override - Open the settings dialog for this import/export filter.

Parameters: data (BaseContainer) – The settings for your plugin. Return type: bool Returns: True if the dialog opened successfully.

BitmapSaverData.Save(self, fn, bmp, data, savebits)

Warning

Never call any GUI commands in this method. Use the return value to inform the user about the state of the rendering.

Override - Save the bitmap to a file.

Parameters:

• fn (str) – The filename of the file to save.
• bmp (BaseBitmap) – The bitmap to save the image from.
• data (BaseContainer) – The settings for your plugin. These settings are stored with the general preferences.
• savebits (int) –

  Flags for the save:

  SAVEBIT_0	No flags
  SAVEBIT_ALPHA	Save the alpha channel(s) in the file. (For filter plugins, don’t save an alpha channel if this isn’t set.)
  SAVEBIT_MULTILAYER	Save multiple layers
  SAVEBIT_USESELECTEDLAYERS	Use selected layers
  SAVEBIT_16BITCHANNELS	Use 16 bit channels
  SAVEBIT_GREYSCALE	Save in grayscale mode
  SAVEBIT_INTERNALNET	Private
  SAVEBIT_DONTMERGE	Avoid merging of layers in B3D files
  SAVEBIT_32BITCHANNELS	Use 32 bit channels
  SAVEBIT_SAVERENDERRESULT	Private
  SAVEBIT_FIRSTALPHA_ONLY	Private

Return type:

int

Returns:

The return values:

IMAGERESULT_OK	Image loaded/created
IMAGERESULT_NOTEXISTING	Image doesn`t exist
IMAGERESULT_WRONGTYPE	Image has the wrong type
IMAGERESULT_OUTOFMEMORY	Not enough memory
IMAGERESULT_FILEERROR	File error
IMAGERESULT_FILESTRUCTURE	Invalid file structure
IMAGERESULT_FILESTRUCTURE	Miscellaneous structure error
IMAGERESULT_PARAM_ERROR	Parameter error

BitmapSaverData.GetMaxAlphas(data)

New in version R13.029.

Get the maximum number of alpha channels this format supports with the current settings.

Parameters: data (BaseContainer) – The settings for your plugin. These settings are stored with the general preferences. Return type: int Returns: The number of alpha channels.

BitmapSaverData.GetMaxResolution(layers)

New in version R13.029.

Overload this to return the maximum resolution of the image format.

Parameters: layers (bool) – True if layers are to be saved, otherwise False. Return type: int Returns: The maximum resolution supported by the image format.