ResolutionCtx

Defined in: packages/typegpu/src/types.ts:270

Passed into each resolvable item. All items in a tree share a resolution ctx, but there can be layers added and removed from the item stack when going down and up the tree.

Properties

[$internal]

[$internal]: object

Defined in: packages/typegpu/src/types.ts:271

itemStateStack

itemStateStack: ItemStateStack

---

enableExtensions

readonly enableExtensions: ("f16" | "clip_distances" | "primitive_index" | "dual_source_blending" | "subgroups")[] | undefined

Defined in: packages/typegpu/src/types.ts:276

---

gen

readonly gen: ShaderGenerator

Defined in: packages/typegpu/src/types.ts:277

---

mode

readonly mode: ExecState

Defined in: packages/typegpu/src/types.ts:275

Accessors

varyingLocations

Get Signature

get varyingLocations(): Record<string, number> | undefined

Defined in: packages/typegpu/src/types.ts:331

Returns

Record<string, number> | undefined

Methods

addDeclaration()

addDeclaration(declaration): void

Defined in: packages/typegpu/src/types.ts:279

Parameters

declaration

string

Returns

void

---

allocateFixedEntry()

allocateFixedEntry(layoutEntry, resource): object

Defined in: packages/typegpu/src/types.ts:292

Reserves a spot in the catch-all bind group, without the indirection of a bind-group. This means the resource is ‘fixed’, and cannot be swapped between code execution.

Parameters

layoutEntry

TgpuLayoutEntry

resource

object

Returns

object

binding

binding: number

group

group: string

---

allocateLayoutEntry()

allocateLayoutEntry(layout): string

Defined in: packages/typegpu/src/types.ts:286

Reserves a bind group number, and returns a placeholder that will be replaced with a concrete number at the end of the resolution process.

Parameters

layout

TgpuBindGroupLayout

Returns

string

---

fnToWgsl()

fnToWgsl(options): object

Defined in: packages/typegpu/src/types.ts:324

Parameters

options

FnToWgslOptions

Returns

object

code

code: string

returnType

returnType: BaseData

---

isIdentifierTaken()

isIdentifierTaken(name): boolean

Defined in: packages/typegpu/src/types.ts:355

Parameters

name

string

Returns

boolean

---

makeUniqueIdentifier()

makeUniqueIdentifier(primer, scope): string

Defined in: packages/typegpu/src/types.ts:353

Parameters

primer

The basis for the unique identifier. Depending on the strategy, or the names already taken, this may be modified to ensure uniqueness.

string | undefined

scope

The scope in which to generate the identifier. ‘global’ means the identifier is meant to be unique across the entire program, while ‘block’ means it cannot shadow any existing identifiers visible from within the current block. After the block is popped, any identifiers defined within it are no longer visible.

"block" | "global"

Returns

string

an identifier that is unique within the given scope

---

popMode()

popMode(expected?): void

Defined in: packages/typegpu/src/types.ts:303

Parameters

expected?

ExecMode

Returns

void

---

pushMode()

pushMode(state): void

Defined in: packages/typegpu/src/types.ts:302

Parameters

state

ExecState

Returns

void

---

reserveIdentifier()

reserveIdentifier(name, scope): void

Defined in: packages/typegpu/src/types.ts:363

Makes sure the given identifier cannot be generated by makeUniqueIdentifier within the given scope.

Parameters

name

string

The name to reserve

scope

See makeUniqueIdentifier for a description of the scope parameter.

"block" | "global"

Returns

void

---

resolve()

resolve(item, schema?): ResolvedSnippet

Defined in: packages/typegpu/src/types.ts:317

Returns the snippet representing item.

Parameters

item

unknown

The value to resolve

schema?

Additional information about the item’s data type

BaseData | typeof UnknownData

Returns

ResolvedSnippet

---

resolveSnippet()

resolveSnippet(snippet): ResolvedSnippet

Defined in: packages/typegpu/src/types.ts:322

Equivalent to snip(ctx.resolve(snippet.value, snippet.dataType).value, snippet.dataType, snippet.origin).

Parameters

snippet

Snippet

Returns

ResolvedSnippet

---

unwrap()

unwrap<T>(eventual): T

Defined in: packages/typegpu/src/types.ts:309

Unwraps all layers of slot/lazy indirection and returns the concrete value if available.

Type Parameters

T

T

Parameters

eventual

Eventual<T>

Returns

T

Throws

---

withRenamed()

withRenamed<T>(item, name, callback): T

Defined in: packages/typegpu/src/types.ts:341

Temporarily renames the item. Useful for resolutions with slots, since functions with different slots should have different names, and all hold the same inner function that is being resolved multiple times.

Type Parameters

T

T

Parameters

item

object

the item to rename

name

the temporary name to assign to the item (if missing, just returns callback())

string | undefined

callback

() => T

Returns

T

---

withResetIndentLevel()

withResetIndentLevel<T>(callback): T

Defined in: packages/typegpu/src/types.ts:280

Type Parameters

T

T

Parameters

callback

() => T

Returns

T

---

withSlots()

withSlots<T>(pairs, callback): T

Defined in: packages/typegpu/src/types.ts:300

Type Parameters

T

T

Parameters

pairs

SlotValuePair[]

callback

() => T

Returns

T

---

withVaryingLocations()

withVaryingLocations<T>(locations, callback): T

Defined in: packages/typegpu/src/types.ts:329

Type Parameters

T

T

Parameters

locations

Record<string, number>

callback

() => T

Returns

T