Katana Plug-in APIs 0.1
Defines

RendererObjectDefinitions

Renderer API

Supported renderer object definitions such as object and parameter types, renderer object key properties, and parameter value types. More...

Defines

#define kFnRendererObjectTypeShader   "shader"
#define kFnRendererObjectTypeFilter   "filter"
#define kFnRendererObjectTypeDriver   "driver"
#define kFnRendererObjectTypeRenderOutput   "renderOutput"
#define kFnRendererObjectTypeOutputChannel   "outputChannel"
#define kFnRendererObjectTypeOutputChannelAttrHints   "outputChannelAttrHints"
#define kFnRendererObjectTypeOutputChannelCustomParam   "outputChannelCustomParam"
#define kFnRendererObjectTypeRendererProcedural   "rendererProcedural"
#define kFnRendererObjectTypeRendererPrimitive   "rendererPrimitive"
#define kFnRendererObjectInfoKeyProtocolVersion   "protocolVersion"
#define kFnRendererObjectInfoKeyName   "name"
#define kFnRendererObjectInfoKeyType   "type"
#define kFnRendererObjectInfoKeyTypeTags   "typeTags"
#define kFnRendererObjectInfoKeyLocation   "location"
#define kFnRendererObjectInfoKeyFullPath   "fullPath"
#define kFnRendererObjectInfoKeyParam   "param"
#define kFnRendererObjectInfoKeyOutputType   "outputType"
#define kFnRendererObjectInfoKeyContainerHints   "containerHints"
#define kFnRendererObjectInfoKeyParamType   "type"
#define kFnRendererObjectInfoKeyParamArraySize   "arraySize"
#define kFnRendererObjectInfoKeyParamDefault   "default"
#define kFnRendererObjectInfoKeyParamHints   "hints"
#define kFnRendererObjectInfoKeyParamEnums   "enums"
#define kFnRendererObjectValueTypeNull   -2
#define kFnRendererObjectValueTypeUnknown   -1
#define kFnRendererObjectValueTypeByte   0
#define kFnRendererObjectValueTypeInt   1
#define kFnRendererObjectValueTypeUint   2
#define kFnRendererObjectValueTypeBoolean   3
#define kFnRendererObjectValueTypeFloat   4
#define kFnRendererObjectValueTypeColor3   5
#define kFnRendererObjectValueTypeColor4   6
#define kFnRendererObjectValueTypeVector2   7
#define kFnRendererObjectValueTypeVector3   8
#define kFnRendererObjectValueTypeVector4   9
#define kFnRendererObjectValueTypePoint2   10
#define kFnRendererObjectValueTypePoint3   11
#define kFnRendererObjectValueTypePoint4   12
#define kFnRendererObjectValueTypeString   13
#define kFnRendererObjectValueTypeMatrix   14
#define kFnRendererObjectValueTypeEnum   15
#define kFnRendererObjectValueTypeNormal   16
#define kFnRendererObjectValueTypePointer   17
#define kFnRendererObjectValueTypeShader   18
#define kFnRendererObjectValueTypeLocation   19
#define kFnRendererOutputTypeColor   "color"
#define kFnRendererOutputTypeDeep   "deep"
#define kFnRendererOutputTypeShadow   "shadow"
#define kFnRendererOutputTypeRaw   "raw"
#define kFnRendererOutputTypeScript   "script"
#define kFnRendererOutputTypePreScript   "prescript"
#define kFnRendererOutputTypeMerge   "merge"
#define kFnRendererOutputTypeForceNone   "none"

Detailed Description

Supported renderer object definitions such as object and parameter types, renderer object key properties, and parameter value types.


Define Documentation

#define kFnRendererObjectInfoKeyContainerHints   "containerHints"

Container level UI hints such as page properties (open, help, hide, etc.)

#define kFnRendererObjectInfoKeyFullPath   "fullPath"

Absolute path to the renderer object

#define kFnRendererObjectInfoKeyLocation   "location"

The directory or assetId for the renderer object

#define kFnRendererObjectInfoKeyName   "name"

The name of the renderer object (e.g. a shader name)

#define kFnRendererObjectInfoKeyOutputType   "outputType"

An output type if applicable, otherwise use kFnRendererObjectValueTypeUnknown

#define kFnRendererObjectInfoKeyParam   "param"

The grouped parameters for the renderer object (e.g. shader parameters)

#define kFnRendererObjectInfoKeyParamArraySize   "arraySize"

The array size of a renderer object parameter

#define kFnRendererObjectInfoKeyParamDefault   "default"

The default value of a renderer object parameter

#define kFnRendererObjectInfoKeyParamEnums   "enums"

Enumerated values for a renderer object parameter

#define kFnRendererObjectInfoKeyParamHints   "hints"

UI hints for a renderer object parameter

#define kFnRendererObjectInfoKeyParamType   "type"

The type of a renderer object parameter

#define kFnRendererObjectInfoKeyProtocolVersion   "protocolVersion"

The protocol version used to parse the attributes describing the renderer object information

#define kFnRendererObjectInfoKeyType   "type"

The type of the renderer object (e.g. a shader)

#define kFnRendererObjectInfoKeyTypeTags   "typeTags"

The tags associated with the type (e.g. shader types)

#define kFnRendererObjectTypeDriver   "driver"

Used to populate drivers and their parameters in the [Renderer]OutputChannel node

#define kFnRendererObjectTypeFilter   "filter"

Used to populate filters and their parameters in the [Renderer]OutputChannel node

#define kFnRendererObjectTypeOutputChannel   "outputChannel"

Used to populate the type drop-down parameter in the [Renderer]OutputChannel node

#define kFnRendererObjectTypeOutputChannelAttrHints   "outputChannelAttrHints"

Used to declare UI hints for the generated output channel attributes

#define kFnRendererObjectTypeOutputChannelCustomParam   "outputChannelCustomParam"

Used to populate an 'Add' drop-down list of channel parameter types in the [Renderer]OutputChannel node

#define kFnRendererObjectTypeRendererPrimitive   "rendererPrimitive"

This is currently not being used

#define kFnRendererObjectTypeRendererProcedural   "rendererProcedural"

This is currently not being used

#define kFnRendererObjectTypeRenderOutput   "renderOutput"

Used to populate the type drop-down parameter in the RenderOutputDefine node

#define kFnRendererObjectTypeShader   "shader"

Used to populate shaders and their parameters in the Material and [Renderer]ShadingNode nodes

#define kFnRendererObjectValueTypeBoolean   3

Boolean parameter type

#define kFnRendererObjectValueTypeByte   0

Byte parameter type

#define kFnRendererObjectValueTypeColor3   5

3 color values parameter type (RBG)

#define kFnRendererObjectValueTypeColor4   6

4 color values parameter type (RBGA)

#define kFnRendererObjectValueTypeEnum   15

Enumerated parameter type

#define kFnRendererObjectValueTypeFloat   4

Float parameter type

#define kFnRendererObjectValueTypeInt   1

Int parameter type

#define kFnRendererObjectValueTypeLocation   19

Location parameter type

#define kFnRendererObjectValueTypeMatrix   14

Matrix parameter type

#define kFnRendererObjectValueTypeNormal   16

Normal vector parameter type

#define kFnRendererObjectValueTypeNull   -2

Null parameter type

#define kFnRendererObjectValueTypePoint2   10

2-dimensional point parameter type

#define kFnRendererObjectValueTypePoint3   11

3-dimensional point parameter type

#define kFnRendererObjectValueTypePoint4   12

4-dimensional homogeneous point parameter type

#define kFnRendererObjectValueTypePointer   17

Pointer parameter type

#define kFnRendererObjectValueTypeShader   18

Shader parameter type

#define kFnRendererObjectValueTypeString   13

String parameter type

#define kFnRendererObjectValueTypeUint   2

Unsigned int parameter type

#define kFnRendererObjectValueTypeUnknown   -1

Unknown parameter type

#define kFnRendererObjectValueTypeVector2   7

2-dimensional vector parameter type

#define kFnRendererObjectValueTypeVector3   8

3-dimensional vector parameter type

#define kFnRendererObjectValueTypeVector4   9

4-dimensional vector parameter type

#define kFnRendererOutputTypeColor   "color"

Color output type (RenderOutputDefine)

#define kFnRendererOutputTypeDeep   "deep"

Deep output type (RenderOutputDefine)

#define kFnRendererOutputTypeForceNone   "none"

No output (RenderOutputDefine)

#define kFnRendererOutputTypeMerge   "merge"

Merge outputs (RenderOutputDefine)

#define kFnRendererOutputTypePreScript   "prescript"

Pre-script output type (RenderOutputDefine)

#define kFnRendererOutputTypeRaw   "raw"

Raw output type (RenderOutputDefine)

#define kFnRendererOutputTypeScript   "script"

Script (post) output type (RenderOutputDefine)

#define kFnRendererOutputTypeShadow   "shadow"

Shadow output type (RenderOutputDefine)

 All Classes Functions Variables Typedefs Enumerations Enumerator