InitRenderStruct Manual

内容表

关于
Functionality
特性
延伸阅读

关于

A InitRenderStruct element is used to initialize materials and shaders for rendering. It is typically created by Cinema 4D but it can be created on demand to sample materials or shaders. See Sampling a Shader .

Functionality

A InitRenderStruct element can be initiated and used with these functions:

InitRenderStruct::InitRenderStruct() : Constructor, accepts a BaseDocument argument.
InitRenderStruct::Init() : Initiates the render structure with the given argument.
InitRenderStruct::GetThreadCount() : Returns the thread count by accessing the stored VolumeData pointer.
InitRenderStruct::TransformColor() : Transforms a color based on the internally stored color profile and linear workflow settings.

// This example samples the given shader in UV space.

// init the shader

InitRenderStruct irs { doc };

COLORSPACETRANSFORMATION transform = COLORSPACETRANSFORMATION::NONE ; // check if linear workflow is enabled if (irs.linear_workflow) transform = COLORSPACETRANSFORMATION::LINEAR_TO_SRGB ; const INITRENDERRESULT res = shader-> InitRender (irs); if (res != INITRENDERRESULT::OK ) return maxon::UnexpectedError( MAXON_SOURCE_LOCATION );

// sample the shader in UV space ChannelData channelData; channelData. off = 0; channelData. scale = 0; channelData. t = doc-> GetTime (). Get (); channelData. texflag = CALC_TEXINFO (0, CHANNEL_COLOR ); channelData. d = 向量 { 1, 1, 1 }; channelData. n = 向量 { 0, 1, 0 }; channelData. vd = nullptr ; // VolumeData is nullptr

for ( Int32 y = 0; y < height; ++y) { for ( Int32 x = 0; x < width; ++x) { // generate UV coordinates const Float64 xFloat = ( Float64 )x; const Float64 yFloat = ( Float64 )y; const Float64 u = xFloat / widthFloat; const Float64 v = yFloat / heightFloat; channelData. p . x = u; channelData. p . y = v; channelData. p . z = 0.0f; const 向量 color = shader-> Sample (&channelData); const 向量 transformedColor = TransformColor (color, transform). Clamp01 ();

// write into the given BaseBitmap const Int32 r = SAFEINT32 (transformedColor. x * COLORTOINT_MULTIPLIER ); const Int32 g = SAFEINT32 (transformedColor. y * COLORTOINT_MULTIPLIER ); const Int32 b = SAFEINT32 (transformedColor. z * COLORTOINT_MULTIPLIER ); bitmap-> SetPixel (x, y, r, g, b); } }

// free shader resources shader-> FreeRender ();

特性

The settings of InitRenderStruct are:

InitRenderStruct::version : The Cinema 4D 版本。
InitRenderStruct::time : The current time.
InitRenderStruct::fps : The framerate.
InitRenderStruct::docpath : The path for the document.
InitRenderStruct::matname : The material name.
InitRenderStruct::errorlist : A private error list.
InitRenderStruct::vd : The volume data. Can be nullptr , always check.
InitRenderStruct::doc : The document to render.
InitRenderStruct::thread : The current thread or nullptr for the main Cinema 4D thread.
InitRenderStruct::flags : The flags, see INITRENDERFLAG .
InitRenderStruct::linear_workflow : True if Linear workflow is enabled.
InitRenderStruct::document_colorprofile : The document color profile.

延伸阅读

ChannelData::texflag

Int32 texflag

[READ ONLY] The texture flags: TEX

定义： c4d_shader.h:969

maxon::Vec3::Clamp01

constexpr Unstrided Clamp01() const

Returns a vector that is clamped to the range [0.0 .. 1.0].

定义： vec.h:399

Int32 SAFEINT32(Float32 x)

定义： apibasemath.h:266

MAXON_SOURCE_LOCATION

#define MAXON_SOURCE_LOCATION

定义： memoryallocationbase.h:66

Float t

[READ ONLY] The current time in seconds.

定义： c4d_shader.h:968

Vector p

[READ ONLY] The texture position in UVW coordinates.

定义： c4d_shader.h:965

ChannelData::off

Float off

定义： c4d_shader.h:971

BaseShader::FreeRender

void FreeRender(void)

Frees all resources used by this shader that were allocated by calling InitRender().

定义： c4d_basechannel.h:110

BaseShader::InitRender

INITRENDERRESULT InitRender(const InitRenderStruct &is)

定义： c4d_basechannel.h:105

T z

定义： vec.h:34

Float Get(void) const

定义： c4d_basetime.h:66

maxon::Vec3< maxon::Float64, 1 >

InitRenderStruct

定义： c4d_shader.h:179

BaseDocument::GetTime

BaseTime GetTime(void) const

BaseBitmap::SetPixel

Bool SetPixel(Int32 x, Int32 y, Int32 r, Int32 g, Int32 b)

定义： c4d_basebitmap.h:704

T x

定义： vec.h:32

Vector TransformColor(const Vector &input, COLORSPACETRANSFORMATION colortransformation)

INITRENDERRESULT

INITRENDERRESULT

定义： ge_prepass.h:395

Vector d

[READ ONLY] The MIP sample radius in UVW coordinates.

定义： c4d_shader.h:967

T y

定义： vec.h:33

maxon::Int32 Int32

定义： ge_sys_math.h:58

COLORSPACETRANSFORMATION::LINEAR_TO_SRGB

@ LINEAR_TO_SRGB

Linear to sRGB color space transformation.

COLORTOINT_MULTIPLIER

static const Float COLORTOINT_MULTIPLIER

Constant to convert from vectors color components to integers.

定义： c4d_tools.h:25

Vector n

[READ ONLY] The surface normal.

定义： c4d_shader.h:966

Int32 CALC_TEXINFO(Int32 texflag, Int32 channel)

定义： c4d_shader.h:52

COLORSPACETRANSFORMATION

COLORSPACETRANSFORMATION

定义： ge_prepass.h:483

COLORSPACETRANSFORMATION::NONE

@ NONE

None.

ChannelData::scale

Float scale

[READ ONLY] The MIP blur offset.

定义： c4d_shader.h:971

ChannelData::vd

VolumeData * vd

[READ ONLY] The volume information, can be nullptr.

定义： c4d_shader.h:970

BaseShader::Sample

Vector Sample(ChannelData *cd)

定义： c4d_basechannel.h:123

#define CHANNEL_COLOR

The color channel of a material.

定义： c4d_shader.h:94

INITRENDERRESULT::OK

@ OK

Everything is OK, there was no error.

定义： c4d_shader.h:952

maxon::Float64 Float64

定义： ge_sys_math.h:65