c4d_fielddata.h File Reference

Classes

struct  FieldOutput
 
struct  FieldOutputBlock
 
struct  FieldShared
 
struct  FieldInput
 
struct  FieldLayerLink
 
class  FieldCallerStack
 
struct  FieldInfo
 
class  FieldObject
 
class  FieldLayer
 

Macros

#define FLCall(fnc)
 
#define LIB_FIELD
 

Typedefs

using FieldOutputRef = maxon::StrongRef< FieldOutput >
 

Functions

FIELDSAMPLE_FLAG ExtractSampleFlags (const FieldOutputBlock &block)
 
Bool ValidateFieldOutputBlockWithFlags (const FieldOutputBlock &block, FIELDSAMPLE_FLAG flags)
 

Variables

static const Int32 FIELD_EXECUTION_BLOCK_SIZE
 
static const Float FIELD_EXECUTION_BLOCK_SIZEf
 
static const Int32 Fspherical
 
static const Int32 Flinear
 
static const Int32 Fbox
 
static const Int32 Fcylinder
 
static const Int32 Fcone
 
static const Int32 Ftorus
 
static const Int32 Fobject_DEPRECATED
 
static const Int32 Fcapsule
 
static const Int32 Fstep_DEPRECATED
 
static const Int32 Ftime_DEPRECATED
 
static const Int32 Fvolume_DEPRECATED
 
static const Int32 Fformula
 
static const Int32 Frandom
 
static const Int32 Fshader
 
static const Int32 Fsound
 
static const Int32 Fdelay_DEPRECATED
 
static const Int32 Fdecay_DEPRECATED
 
static const Int32 Fradial
 
static const Int32 Fgroup
 
static const Int32 Fpython
 
static const Int32 FLbase
 
static const Int32 FLplugin
 
static const Int32 FLfolder
 
static const Int32 FLfield
 
static const Int32 FLsolid
 
static const Int32 FLdescid
 
static const Int32 FLclamp
 
static const Int32 FLremap
 
static const Int32 FLcurve
 
static const Int32 FLgradient
 
static const Int32 FLquantize
 
static const Int32 FLinvert
 
static const Int32 FLcolorize
 
static const Int32 FLrangemap
 
static const Int32 FLnoise
 
static const Int32 FLspline
 
static const Int32 FLdelay
 
static const Int32 FLdecay
 
static const Int32 FLstep
 
static const Int32 FLweight
 
static const Int32 FLproximity
 
static const Int32 FLformula
 
static const Int32 FLtime
 
static const Int32 FLpython
 
static const Int32 FLmograph
 
static const Int32 FLpolygonobject
 
static const Int32 FLvolumeobject
 
static const Int32 FLparticleobject
 

Macro Definition Documentation

◆ FLCall

#define FLCall (   fnc)

◆ LIB_FIELD

#define LIB_FIELD

Typedef Documentation

◆ FieldOutputRef

Function Documentation

◆ ExtractSampleFlags()

FIELDSAMPLE_FLAG ExtractSampleFlags ( const FieldOutputBlock block)

Read the sample flags from the array content of a FieldOutputBlock.

Parameters
[in]blockThe outputs to extract flags from.
Returns
The flags.

◆ ValidateFieldOutputBlockWithFlags()

Bool ValidateFieldOutputBlockWithFlags ( const FieldOutputBlock block,
FIELDSAMPLE_FLAG  flags 
)

Validate the content of a block making sure that the block itself is valid and array allocation respect the specified flags. "block" flags must be a perfect 1 to 1 match with the specified flags for the function to succeed. if "block" is missing a flag or has an unneeded flag, validation will fail.

Parameters
[in]blockThe block to validate.
[in]flagsThe flags to compare the block against..
Returns
True if the block is valid.

Variable Documentation

◆ FIELD_EXECUTION_BLOCK_SIZE

const Int32 FIELD_EXECUTION_BLOCK_SIZE
static

/ The size of a block that's executed in an MP environment. For single depth execution a value closer to 1200 is actually more optimal, with one group 600 and from then on for each group depth you can expect a drop of a third. For general usage on current architectures this gives the best balance.

◆ FIELD_EXECUTION_BLOCK_SIZEf

const Float FIELD_EXECUTION_BLOCK_SIZEf
static

/ The size of a block that's executed in an MP environment. For single depth execution a value closer to 1200 is actually more optimal, with one group 600 and from then on for each group depth you can expect a drop of a third. For general usage on current architectures this gives the best balance.