ShaderGenerator
Defined in: packages/typegpu/src/tgsl/shaderGenerator.ts:114
NOTE: This is an unstable API and may change in the future.
An interface meant to be used by other systems to generate snippets of shader code in the target language (WGSL, GLSL, etc.).
Properties
Section titled “Properties”languageKey
Section titled “languageKey”
readonlylanguageKey:string
Defined in: packages/typegpu/src/tgsl/shaderGenerator.ts:115
Methods
Section titled “Methods”declareGlobalConst()
Section titled “declareGlobalConst()”declareGlobalConst(
options):ResolvedSnippet
Defined in: packages/typegpu/src/tgsl/shaderGenerator.ts:119
Parameters
Section titled “Parameters”options
Section titled “options”ConstantDefinitionOptions
Returns
Section titled “Returns”ResolvedSnippet
declareGlobalVar()
Section titled “declareGlobalVar()”declareGlobalVar(
options):ResolvedSnippet
Defined in: packages/typegpu/src/tgsl/shaderGenerator.ts:120
Parameters
Section titled “Parameters”options
Section titled “options”VariableDefinitionOptions
Returns
Section titled “Returns”ResolvedSnippet
emitBinaryOp()
Section titled “emitBinaryOp()”emitBinaryOp(
lhs,op,rhs):string
Defined in: packages/typegpu/src/tgsl/shaderGenerator.ts:128
Parameters
Section titled “Parameters”Snippet
BinaryOperator
Snippet
Returns
Section titled “Returns”string
emitCall()
Section titled “emitCall()”emitCall(
name,templateParams,args):string
Defined in: packages/typegpu/src/tgsl/shaderGenerator.ts:127
Parameters
Section titled “Parameters”string
templateParams
Section titled “templateParams”readonly Snippet[]
readonly Snippet[]
Returns
Section titled “Returns”string
emitTypeAnnotation()
Section titled “emitTypeAnnotation()”emitTypeAnnotation(
schema):string
Defined in: packages/typegpu/src/tgsl/shaderGenerator.ts:126
Parameters
Section titled “Parameters”schema
Section titled “schema”Returns
Section titled “Returns”string
functionDefinition()
Section titled “functionDefinition()”functionDefinition(
options):string
Defined in: packages/typegpu/src/tgsl/shaderGenerator.ts:121
Parameters
Section titled “Parameters”options
Section titled “options”FunctionDefinitionOptions
Returns
Section titled “Returns”string
initGenerator()
Section titled “initGenerator()”initGenerator(
ctx):void
Defined in: packages/typegpu/src/tgsl/shaderGenerator.ts:117
Parameters
Section titled “Parameters”ResolutionCtx
Returns
Section titled “Returns”void
numericLiteral()
Section titled “numericLiteral()”numericLiteral(
value,schema):ResolvedSnippet
Defined in: packages/typegpu/src/tgsl/shaderGenerator.ts:124
Parameters
Section titled “Parameters”number
schema
Section titled “schema”Returns
Section titled “Returns”ResolvedSnippet
typeInstantiation()
Section titled “typeInstantiation()”typeInstantiation(
schema,args):ResolvedSnippet
Defined in: packages/typegpu/src/tgsl/shaderGenerator.ts:123
Parameters
Section titled “Parameters”schema
Section titled “schema”readonly Snippet[]
Returns
Section titled “Returns”ResolvedSnippet