ResolutionCtx

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

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:254

itemStateStack

itemStateStack: ItemStateStack

---

enableExtensions

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

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

---

gen

readonly gen: ShaderGenerator

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

---

mode

readonly mode: ExecState

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

Accessors

varyingLocations

Get Signature

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

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

Returns

Record<string, number> | undefined

Methods

addDeclaration()

addDeclaration(declaration): void

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

Parameters

declaration

string

Returns

void

---

allocateFixedEntry()

allocateFixedEntry(layoutEntry, resource): object

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

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:269

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:307

Parameters

options

FnToWgslOptions

Returns

object

body

body: Wgsl

head

head: Wgsl

returnType

returnType: BaseData

---

getUniqueName()

getUniqueName(resource): string

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

Parameters

resource

object

Returns

string

---

makeNameValid()

makeNameValid(name): string

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

Parameters

name

string

Returns

string

---

popMode()

popMode(expected?): void

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

Parameters

expected?

ExecMode

Returns

void

---

pushMode()

pushMode(state): void

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

Parameters

state

ExecState

Returns

void

---

resolve()

resolve(item, schema?): ResolvedSnippet

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

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:305

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:292

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:325

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:263

Type Parameters

T

T

Parameters

callback

() => T

Returns

T

---

withSlots()

withSlots<T>(pairs, callback): T

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

Type Parameters

T

T

Parameters

pairs

SlotValuePair[]

callback

() => T

Returns

T

---

withVaryingLocations()

withVaryingLocations<T>(locations, callback): T

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

Type Parameters

T

T

Parameters

locations

Record<string, number>

callback

() => T

Returns

T