Class GraphCodeGenerationContext

The GraphCodeGenerationContext is used during code generation to create the actual code.

Index

Constructors

Methods

decreaseIndent emitAssignment emitCode emitConstantBufferVariableDeclaration emitDependencyCode emitError emitExpressionTerminator emitIndent emitInlineComment emitInputValueOrInvocationForNode emitKeyword emitLineBreak emitLocalVariableDeclaration emitLocalVariableDeclarationWithValue emitObjectReference emitParameterDeclaration emitParameterListBegin emitParameterListEnd emitParameterListSeparator emitParenthesisBegin emitParenthesisEnd emitPreprocessorDefine emitPreprocessorUndefine emitScopeBegin emitScopeEnd emitSingleLineComment emitSpace emitTemporaryOutputValueForNode emitVariableDeclaration emitVariableDecorator emitVariableDecorators emitVariableReference emitWarning getObjectReference getPinName getTemporaryName getTypeConstant getTypeConstantBufferValue getTypeName getVariableReference increaseIndent registerTemporaryName getTypeConstantBufferValue systemTypeToType

Constructors

constructor

new GraphCodeGenerationContext(
    language: EnumValue<GraphCodeGenerationLanguage>,
    mode: EnumValue<GraphCodeGenerationMode>,
    variableValues: Map<bigint, any>,
): GraphCodeGenerationContext
Parameters
- language: EnumValue<GraphCodeGenerationLanguage>
- mode: EnumValue<GraphCodeGenerationMode>
- variableValues: Map<bigint, any>
Returns GraphCodeGenerationContext

Properties

buffer

buffer: string

The buffer to hold the generated code.

`Readonly`diagnosticMessages

diagnosticMessages: string[]

Diagnostic messages.

forcedTemporaryGenerationNodes

forcedTemporaryGenerationNodes: Set<ImmutableGraphNode>

Optional set of nodes that will always emit temporaries, indepedent of their connection count.

`Readonly`globalFunctions

globalFunctions: Set<string>

hasError

hasError: boolean

Determines if an error was generated.

indentLevel

indentLevel: number

The current indent level.

isDefaultObjectRequired

isDefaultObjectRequired: {
    sampler: boolean;
    texture1D: boolean;
    texture2D: boolean;
    texture3D: boolean;
}

Holds the state for the requirement of default objects.

isDefineRequired

isDefineRequired: { LOCAL_TANGENT_BASIS: boolean; WITH_COLOR0: boolean }

Determines if a specific define is required for shader generation.

`Readonly`language

language: EnumValue<GraphCodeGenerationLanguage>

The code generation language.

`Readonly`mode

mode: EnumValue<GraphCodeGenerationMode>

The code generation mode.

`Readonly`objectNames

objectNames: Map<GraphObject, string>

previewData

previewData: IGraphCodeGenerationPreviewData

The preview data.

Note

Not all code generation graphs support preview generation.

supressEmitCode

supressEmitCode: boolean

Determines whether code generation is disabled.

`Readonly`temporaryGeneratingNodes

temporaryGeneratingNodes: Set<ImmutableGraphNode>

`Readonly`temporaryNames

temporaryNames: Map<GraphPin, string>

`Readonly`temporaryStack

temporaryStack: CodeGeneratingGraphNode[]

`Readonly`variableValues

variableValues: Map<bigint, any>

`Readonly`visitedNodes

visitedNodes: Set<GraphNode>

`Static` `Readonly`defaultNumberPrecision

defaultNumberPrecision: 16

`Static`implicitObjectIndex

implicitObjectIndex: number

The implicit object index tracks the number of implicit objects created globally. This is important for implicit samplers and textures, otherwise instanced shaders might not update correctly to the updated value, as it's retained in the parameter buffer.

Methods

decreaseIndent

decreaseIndent(): void

Returns void

emitAssignment

emitAssignment(lhs: string, rhs: string): void
Parameters
- lhs: string
- rhs: string
Returns void

emitCode

emitCode(msg: string): void
Parameters
- msg: string
Returns void

emitConstantBufferVariableDeclaration

emitConstantBufferVariableDeclaration(variable: GraphVariable): void
Parameters
- variable: GraphVariable
Returns void

emitDependencyCode

emitDependencyCode(category: string, name: string, body: string): void
Parameters
- category: string
- name: string
- body: string
Returns void

emitError

emitError(msg: string): void
Parameters
- msg: string
Returns void

emitExpressionTerminator

emitExpressionTerminator(): void

Returns void

emitIndent

emitIndent(): void

Returns void

emitInlineComment

emitInlineComment(text: string): void
Parameters
- text: string
Returns void

emitInputValueOrInvocationForNode

emitInputValueOrInvocationForNode(node: ImmutableGraphNode, pin: GraphPin): void
Parameters
- node: ImmutableGraphNode
- pin: GraphPin
Returns void

emitKeyword

emitKeyword(keyword: EnumValue<GraphCodeGenerationKeyword>): void
Parameters
- keyword: EnumValue<GraphCodeGenerationKeyword>
Returns void

emitLineBreak

emitLineBreak(): void

Returns void

emitLocalVariableDeclaration

emitLocalVariableDeclaration(type: string | GraphType, name: string): void
Parameters
- type: string | GraphType
- name: string
Returns void

emitLocalVariableDeclarationWithValue

emitLocalVariableDeclarationWithValue(
    type: string | GraphType,
    name: string,
    value: string,
): void
Parameters
- type: string | GraphType
- name: string
- value: string
Returns void

emitObjectReference

emitObjectReference(object: GraphObject): void
Parameters
- object: GraphObject
Returns void

emitParameterDeclaration

emitParameterDeclaration(
    parameterType: EnumValue<GraphCodeGenerationKeyword>,
    type: string | GraphType,
    name: string,
): void
Parameters
- parameterType: EnumValue<GraphCodeGenerationKeyword>
- type: string | GraphType
- name: string
Returns void

emitParameterListBegin

emitParameterListBegin(): void

Returns void

emitParameterListEnd

emitParameterListEnd(): void

Returns void

emitParameterListSeparator

emitParameterListSeparator(): void

Returns void

emitParenthesisBegin

emitParenthesisBegin(): void

Returns void

emitParenthesisEnd

emitParenthesisEnd(): void

Returns void

emitPreprocessorDefine

emitPreprocessorDefine(name: string, value: string): void
Parameters
- name: string
- value: string
Returns void

emitPreprocessorUndefine

emitPreprocessorUndefine(name: string): void
Parameters
- name: string
Returns void

emitScopeBegin

emitScopeBegin(): void

Returns void

emitScopeEnd

emitScopeEnd(): void

Returns void

emitSingleLineComment

emitSingleLineComment(text: string): void
Parameters
- text: string
Returns void

emitSpace

emitSpace(): void

Returns void

emitTemporaryOutputValueForNode

emitTemporaryOutputValueForNode(node: ImmutableGraphNode, pin: GraphPin): void
Parameters
- node: ImmutableGraphNode
- pin: GraphPin
Returns void

emitVariableDeclaration

emitVariableDeclaration(
    variable: GraphVariable,
    asConst?: boolean,
    includeValue?: boolean,
): void
Parameters
- variable: GraphVariable
- OptionalasConst: boolean
- OptionalincludeValue: boolean
Returns void

emitVariableDecorator

emitVariableDecorator(name: string, value?: string): void
Parameters
- name: string
- Optionalvalue: string
Returns void

emitVariableDecorators

emitVariableDecorators(variable: GraphVariable): void
Parameters
- variable: GraphVariable
Returns void

emitVariableReference

emitVariableReference(variable: GraphVariable): void
Parameters
- variable: GraphVariable
Returns void

emitWarning

emitWarning(msg: string): void
Parameters
- msg: string
Returns void

getObjectReference

getObjectReference(graphObject: GraphObject, isImplicit?: boolean): string
Parameters
- graphObject: GraphObject
- OptionalisImplicit: boolean
Returns string

getPinName

getPinName(pin: GraphPin): string
Parameters
- pin: GraphPin
Returns string

getTemporaryName

getTemporaryName(pin: GraphPin): string
Parameters
- pin: GraphPin
Returns string

getTypeConstant

getTypeConstant(
    type: GraphType,
    value:
        | number
        | boolean
        | Immutable<Vector2>
        | Immutable<Vector3>
        | Immutable<Matrix4>
        | Immutable<Vector4>
        | Immutable<Matrix3>,
): string
Parameters
- type: GraphType
- value:
      | number
      | boolean
      | Immutable<Vector2>
      | Immutable<Vector3>
      | Immutable<Matrix4>
      | Immutable<Vector4>
      | Immutable<Matrix3>
Returns string

getTypeConstantBufferValue

getTypeConstantBufferValue(
type: Type | GraphType,
value: number | boolean | Vector2 | Vector3 | Matrix4 | Vector4 | Matrix3,
): string
Parameters
- type: Type | GraphType
- value: number | boolean | Vector2 | Vector3 | Matrix4 | Vector4 | Matrix3
Returns string

getTypeName

getTypeName(type: Type | GraphType): string
Parameters
- type: Type | GraphType
Returns string

getVariableReference

getVariableReference(variable: GraphVariable): string
Parameters
- variable: GraphVariable
Returns string

increaseIndent

increaseIndent(): void

Returns void

registerTemporaryName

registerTemporaryName(pin: GraphPin): string
Parameters
- pin: GraphPin
Returns string

`Static`getTypeConstantBufferValue

getTypeConstantBufferValue(
    language: EnumValueTyped<GraphCodeGenerationLanguage>,
    precision: number,
    type: Type | GraphType,
    value:
        | number
        | boolean
        | Immutable<Vector2>
        | Immutable<Vector3>
        | Immutable<Matrix4>
        | Immutable<Vector4>
        | Immutable<Matrix3>,
): string
Parameters
- language: EnumValueTyped<GraphCodeGenerationLanguage>
- precision: number
- type: Type | GraphType
- value:
      | number
      | boolean
      | Immutable<Vector2>
      | Immutable<Vector3>
      | Immutable<Matrix4>
      | Immutable<Vector4>
      | Immutable<Matrix3>
Returns string

`Static`systemTypeToType

systemTypeToType(type: Type): string
Parameters
- type: Type
Returns string

Class GraphCodeGenerationContext

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GraphCodeGenerationContext

Properties

buffer

ReadonlydiagnosticMessages

forcedTemporaryGenerationNodes

ReadonlyglobalFunctions

hasError

indentLevel

isDefaultObjectRequired

isDefineRequired

Readonlylanguage

Readonlymode

ReadonlyobjectNames

previewData

Note

supressEmitCode

ReadonlytemporaryGeneratingNodes

ReadonlytemporaryNames

ReadonlytemporaryStack

ReadonlyvariableValues

ReadonlyvisitedNodes

Static ReadonlydefaultNumberPrecision

StaticimplicitObjectIndex

Methods

decreaseIndent

Returns void

emitAssignment

Parameters

Returns void

emitCode

Parameters

Returns void

emitConstantBufferVariableDeclaration

Parameters

Returns void

emitDependencyCode

Parameters

Returns void

emitError

Parameters

Returns void

emitExpressionTerminator

Returns void

emitIndent

Returns void

emitInlineComment

Parameters

Returns void

emitInputValueOrInvocationForNode

Parameters

Returns void

emitKeyword

Parameters

Returns void

emitLineBreak

Returns void

emitLocalVariableDeclaration

Parameters

Returns void

emitLocalVariableDeclarationWithValue

Parameters

Returns void

emitObjectReference

Parameters

Returns void

emitParameterDeclaration

Parameters

Returns void

emitParameterListBegin

Returns void

emitParameterListEnd

Returns void

`Readonly`diagnosticMessages

`Readonly`globalFunctions

`Readonly`language

`Readonly`mode

`Readonly`objectNames

`Readonly`temporaryGeneratingNodes

`Readonly`temporaryNames

`Readonly`temporaryStack

`Readonly`variableValues

`Readonly`visitedNodes

`Static` `Readonly`defaultNumberPrecision

`Static`implicitObjectIndex

`Static`getTypeConstantBufferValue

`Static`systemTypeToType