About
A RenderData object represents a set of render settings of a BaseDocument . The render settings include:
Various parameters like resolution, image format, save path etc.
A list of MultipassObject elements that represent multipasses.
A list of BaseVideoPost elements that represent post filters or render engines.
RenderData objects are an instance of Rbase
.
Access
RenderData elements can be accessed from the BaseDocument :
Allocation/Deallocation
RenderData objects can be created with the usual tools:
The RenderData object can be handed over to a BaseDocument using:
if (renderData == nullptr )
renderData->
SetName (
"Preview Render Settings" _s);
Navigation
RenderData is based on GeListNode and the render settings are organized in a tree. This tree can be navigated with:
while (parentRenderData->
GetUp ())
{
parentRenderData = parentRenderData->
GetUp ();
}
Properties
The RenderData object gives access to render settings, Multipasses and post effects.
Data
RenderData is based on BaseList2D so the data can be accessed with
The container IDs are defined in drendersettings.h
.
Changing the RDATA_RENDERENGINE parameter to change the render engine will not automatically create the needed video post for that render engine. The video post has to be created manually.
if (renderData == nullptr )
renderData->
SetName (
"Hardware Rendering" _s);
if (videoPost == nullptr )
If a given RenderData element is active can be checked with a bit. To set a given RenderData object as the active one, use BaseDocument::SetActiveRenderData() .
while (renderData != nullptr )
{
renderData = renderData->
GetNext ();
}
The image format settings are defined in a maxon::DataDictionary that is saved within the BaseContainer . These functions are used to access the image format settings:
if (renderData == nullptr )
if (renderDataBaseContainer == nullptr )
maxon::DataDictionary exportSettings;
exportSettings.Set(maxon::MEDIASESSION::OPENEXR::EXPORT::HALFFLOAT,
true )
iferr_return ;
exportSettings.Set(maxon::MEDIASESSION::OPENEXR::EXPORT::LAYERNUMBERING,
true )
iferr_return ;
exportSettings.Set(maxon::MEDIASESSION::OPENEXR::EXPORT::COMPRESSIONMETHOD, maxon::MEDIASESSION::OPENEXR::EXPORT::COMPRESSIONMETHOD.ENUM_NONE)
iferr_return ;
if (renderData == nullptr )
if (renderDataBaseContainer == nullptr )
maxon::Id method = data.GetOrDefault(maxon::MEDIASESSION::OPENEXR::EXPORT::COMPRESSIONMETHOD);
Multipasses
A render multipass contains different elements of the render result. What multipasses should be created is stored in a list of MultipassObject elements.
See also MultipassObject Manual .
while (multipass != nullptr )
{
{
{
}
}
}
Post Effects
Post effects are executed during the rendering process to apply filters like color correction to the final image. BaseVideoPost objects can also represent a render engine. These BaseVideoPost elements are stored in a list.
See also BaseVideoPost Manual .
while (videoPost != nullptr )
{
if (videoPost->
GetType () == 1025462)
{
break ;
}
}
Further Reading
@ RDATA_FORMAT
Definition: drendersettings.h:69
Bool GetBit(Int32 mask) const
Definition: c4d_baselist.h:2207
@ RDATA_YRES
Definition: drendersettings.h:153
maxon::Int Int
Definition: ge_sys_math.h:62
@ MULTIPASSOBJECT_TYPE
Definition: zmultipass.h:6
RenderData * GetFirstRenderData(void)
#define FILTER_EXR
EXR.
Definition: ge_prepass.h:195
@ RDATA_STEREO
Definition: drendersettings.h:427
const BaseContainer * GetDataInstance() const
Definition: c4d_baselist.h:2283
Definition: lib_description.h:327
void SetInt32(Int32 id, Int32 l)
Definition: c4d_basecontainer.h:505
return OK
Definition: apibase.h:2532
BaseVideoPost * GetFirstVideoPost()
Definition: apibaseid.h:250
#define iferr_return
Definition: resultbase.h:1434
#define BIT_ACTIVERENDERDATA
Active render data.
Definition: ge_prepass.h:881
#define MAXON_SOURCE_LOCATION
Definition: memoryallocationbase.h:66
@ RDATA_RENDERENGINE
Definition: drendersettings.h:39
void SetActiveRenderData(RenderData *rd)
void SetBool(Int32 id, Bool b)
Definition: c4d_basecontainer.h:498
static BaseVideoPost * Alloc(Int32 type)
#define DiagnosticOutput(formatString,...)
Definition: debugdiagnostics.h:166
RenderData * GetNext(void)
Definition: c4d_basedocument.h:168
maxon::Result< void > SetImageSettingsDictionary(const maxon::DataDictionary &settings, BaseContainer *data, Int32 filterId)
static RenderData * Alloc(void)
static String IntToString(Int32 v)
Definition: c4d_string.h:495
Bool SetParameter(const DescID &id, const GeData &t_data, DESCFLAGS_SET flags)
RenderData * GetUp(void)
Definition: c4d_basedocument.h:180
Int32 GetInt32(void) const
Definition: c4d_gedata.h:427
BaseContainer GetContainer(Int32 id) const
Definition: c4d_basecontainer.h:418
const BaseContainer & GetDataInstanceRef() const
Definition: c4d_baselist.h:2299
Definition: c4d_videopost.h:23
@ RDATA_XRES
Definition: drendersettings.h:152
MultipassObject * GetNext(void)
Definition: c4d_basedocument.h:120
Definition: c4d_gedata.h:82
void SetName(const maxon::String &name)
Definition: c4d_baselist.h:2324
maxon::Int32 Int32
Definition: ge_sys_math.h:58
#define ApplicationOutput(formatString,...)
Definition: debugdiagnostics.h:207
maxon::Result< maxon::DataDictionary > GetImageSettingsDictionary(const BaseContainer *data, Int32 filterId)
#define VPBUFFER_OBJECTBUFFER
Object buffer multipass channel.
Definition: c4d_videopostdata.h:140
MultipassObject * GetFirstMultipass()
BaseVideoPost * GetNext(void)
Definition: c4d_videopost.h:56
void InsertRenderDataLast(RenderData *rd)
@ RDATA_SAVEOPTIONS
Definition: drendersettings.h:71
RenderData * GetActiveRenderData(void)
@ VP_WATERMARK_TEXT_ENABLE
Definition: vpwatermark.h:68
void SetContainer(Int32 id, const BaseContainer &s)
Definition: c4d_basecontainer.h:597
Definition: c4d_basedocument.h:136
Definition: c4d_basedocument.h:105
String GetName() const
Definition: c4d_baselist.h:2318
void InsertVideoPost(BaseVideoPost *pvp, BaseVideoPost *pred=nullptr)
@ MULTIPASSOBJECT_OBJECTBUFFER
Definition: zmultipass.h:8
Int32 GetType() const
Definition: c4d_baselist.h:1348
Int32 GetInt32(Int32 id, Int32 preset=0) const
Definition: c4d_basecontainer.h:303
Bool GetParameter(const DescID &id, GeData &t_data, DESCFLAGS_GET flags)
Definition: c4d_basecontainer.h:46
@ RDATA_RENDERENGINE_PREVIEWHARDWARE
Definition: drendersettings.h:41