c4d.documents.BaseVideoPost

class c4d.documents.BaseVideoPost

Methods Signatures

BaseVideoPost.__init__(self, type)

Initializes a new BaseVideoPost.

BaseVideoPost.RenderEngineCheck(self, type)

Checks if a videopost is available for a certain render engine.

BaseVideoPost.StereoMergeImages(self, dest, source, ...)

Merges stereoscopic images for rendering.

BaseVideoPost.StereoGetCameraCountEditor(self, doc, bd)

Returns the number of stereoscopic editor cameras.

BaseVideoPost.StereoGetCameraCountRenderer(self, doc, rd)

Returns the number of stereoscopic cameras used for rendering.

BaseVideoPost.StereoGetCameraInfo(self, doc, bd, rd, index)

Retrieves the information for a stereoscopic camera.

Inheritance

Parent Class:

Methods Documentation

BaseVideoPost.__init__(self, type)

Initializes a new BaseVideoPost.

Parameters

type (int) – The videopost type: VideoPost Types.

BaseVideoPost.RenderEngineCheck(self, type)

Checks if a videopost is available for a certain render engine.

Parameters

type (int) – The ID of the render engine.

Return type

bool

Returns

True if the videopost is available for the specified render engine, otherwise False.

BaseVideoPost.StereoMergeImages(self, dest, source, settings, transform)

Merges stereoscopic images for rendering.

Parameters
  • dest (c4d.bitmaps.BaseBitmap) – The destination bitmap to be filled with the merged stereoscopic image.

  • source (List[c4d.bitmaps.BaseBitmap]) – A list containing the stereoscopic images.

  • settings (c4d.BaseContainer) – The stereoscopic render settings: See RDATA_STEREO in drendersettings.h.

  • transform (int) –

    The color space transformation mode:

    COLORSPACETRANSFORMATION_NONE

    None.

    COLORSPACETRANSFORMATION_LINEAR_TO_SRGB

    Linear to sRGB color space transformation.

    COLORSPACETRANSFORMATION_SRGB_TO_LINEAR

    sRGB to linear color space transformation.

    COLORSPACETRANSFORMATION_LINEAR_TO_VIEW

    Linear to display color space transformation.

    COLORSPACETRANSFORMATION_SRGB_TO_VIEW

    sRGB to display color space transformation.

Return type

bool

Returns

True if the stereo images were merged, otherwise False.

BaseVideoPost.StereoGetCameraCountEditor(self, doc, bd)

Returns the number of stereoscopic editor cameras.

Parameters
Return type

int

Returns

The number of stereoscopic cameras.

BaseVideoPost.StereoGetCameraCountRenderer(self, doc, rd)

Returns the number of stereoscopic cameras used for rendering.

Parameters
Return type

int

Returns

The number of stereoscopic cameras.

BaseVideoPost.StereoGetCameraInfo(self, doc, bd, rd, index)

Retrieves the information for a stereoscopic camera.

Parameters
Return type

Optional[Dict[c4d.Matrix, float, float, str]]

Returns

A dictionary (None if the function failed) with the following information for the stereoscopic camera:


m: c4d.Matrix: Matrix of the stereoscopic camera.
off_x: float: Stereoscopic camera film X offset.
off_y: float: Stereoscopic camera film Y offset.
name: str: Name of the stereoscopic camera.