Class GraphCodeGenerationContext

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

Constructors

constructor

Properties

buffer diagnosticMessages forcedTemporaryGenerationNodes globalFunctions hasError indentLevel isDefaultObjectRequired language mode objectNames previewData supressEmitCode temporaryGeneratingNodes temporaryNames temporaryStack variableValues visitedNodes defaultNumberPrecision implicitObjectIndex

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

Properties

buffer

buffer: string

The buffer to hold the generated code.

ReadonlydiagnosticMessages

diagnosticMessages: string[]

Diagnostic messages.

forcedTemporaryGenerationNodes

forcedTemporaryGenerationNodes: Set<ImmutableGraphNode>

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

ReadonlyglobalFunctions

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.

Readonlylanguage

language: EnumValue<GraphCodeGenerationLanguage, number>

The code generation language.

Readonlymode

mode: EnumValue<GraphCodeGenerationMode, number>

The code generation mode.

ReadonlyobjectNames

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.

ReadonlytemporaryGeneratingNodes

temporaryGeneratingNodes: Set<ImmutableGraphNode>

ReadonlytemporaryNames

temporaryNames: Map<GraphPin, string>

ReadonlytemporaryStack

temporaryStack: CodeGeneratingGraphNode[]

ReadonlyvariableValues

variableValues: Map<bigint, any>

ReadonlyvisitedNodes

visitedNodes: Set<GraphNode>

Static ReadonlydefaultNumberPrecision

defaultNumberPrecision = 16

StaticimplicitObjectIndex

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, rhs): void

  • Parameters

    • lhs: string
    • rhs: string

    Returns void

emitCode

  • emitCode(msg): void

  • Parameters

    • msg: string

    Returns void

emitConstantBufferVariableDeclaration

  • emitConstantBufferVariableDeclaration(variable): void

  • Parameters

    Returns void

emitDependencyCode

  • emitDependencyCode(category, name, body): void

  • Parameters

    • category: string
    • name: string
    • body: string

    Returns void

emitError

  • emitError(msg): void

  • Parameters

    • msg: string

    Returns void

emitExpressionTerminator

  • emitExpressionTerminator(): void

  • Returns void

emitIndent

  • emitIndent(): void

  • Returns void

emitInlineComment

  • emitInlineComment(text): void

  • Parameters

    • text: string

    Returns void

emitInputValueOrInvocationForNode

emitKeyword

emitLineBreak

  • emitLineBreak(): void

  • Returns void

emitLocalVariableDeclaration

  • emitLocalVariableDeclaration(type, name): void

  • Parameters

    Returns void

emitLocalVariableDeclarationWithValue

  • emitLocalVariableDeclarationWithValue(type, name, value): void

  • Parameters

    • type: string | GraphType
    • name: string
    • value: string

    Returns void

emitObjectReference

  • emitObjectReference(object): void

  • Parameters

    Returns void

emitParameterDeclaration

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, value): void

  • Parameters

    • name: string
    • value: string

    Returns void

emitPreprocessorUndefine

  • emitPreprocessorUndefine(name): void

  • Parameters

    • name: string

    Returns void

emitScopeBegin

  • emitScopeBegin(): void

  • Returns void

emitScopeEnd

  • emitScopeEnd(): void

  • Returns void

emitSingleLineComment

  • emitSingleLineComment(text): void

  • Parameters

    • text: string

    Returns void

emitSpace

  • emitSpace(): void

  • Returns void

emitTemporaryOutputValueForNode

emitVariableDeclaration

  • emitVariableDeclaration(variable, asConst?, includeValue?): void

  • Parameters

    • variable: GraphVariable
    • OptionalasConst: boolean
    • OptionalincludeValue: boolean

    Returns void

emitVariableDecorator

  • emitVariableDecorator(name, value?): void

  • Parameters

    • name: string
    • Optionalvalue: string

    Returns void

emitVariableDecorators

  • emitVariableDecorators(variable): void

  • Parameters

    Returns void

emitVariableReference

  • emitVariableReference(variable): void

  • Parameters

    Returns void

emitWarning

  • emitWarning(msg): void

  • Parameters

    • msg: string

    Returns void

getObjectReference

  • getObjectReference(graphObject, isImplicit?): string

  • Parameters

    Returns string

getPinName

  • getPinName(pin): string

  • Parameters

    Returns string

getTemporaryName

  • getTemporaryName(pin): string

  • Parameters

    Returns string

getTypeConstant

getTypeConstantBufferValue

getTypeName

  • getTypeName(type): string

  • Parameters

    Returns string

getVariableReference

  • getVariableReference(variable): string

  • Parameters

    Returns string

increaseIndent

  • increaseIndent(): void

  • Returns void

registerTemporaryName

  • registerTemporaryName(pin): string

  • Parameters

    Returns string

StaticgetTypeConstantBufferValue

StaticsystemTypeToType

  • systemTypeToType(type): string

  • Parameters

    Returns string

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
decreaseIndentemitAssignmentemitCodeemitConstantBufferVariableDeclarationemitDependencyCodeemitErroremitExpressionTerminatoremitIndentemitInlineCommentemitInputValueOrInvocationForNodeemitKeywordemitLineBreakemitLocalVariableDeclarationemitLocalVariableDeclarationWithValueemitObjectReferenceemitParameterDeclarationemitParameterListBeginemitParameterListEndemitParameterListSeparatoremitParenthesisBeginemitParenthesisEndemitPreprocessorDefineemitPreprocessorUndefineemitScopeBeginemitScopeEndemitSingleLineCommentemitSpaceemitTemporaryOutputValueForNodeemitVariableDeclarationemitVariableDecoratoremitVariableDecoratorsemitVariableReferenceemitWarninggetObjectReferencegetPinNamegetTemporaryNamegetTypeConstantgetTypeConstantBufferValuegetTypeNamegetVariableReferenceincreaseIndentregisterTemporaryNamegetTypeConstantBufferValuesystemTypeToType