TgpuBindGroupLayout

Defined in: packages/typegpu/src/tgpuBindGroupLayout.ts:160

Extends

• TgpuNamable

Type Parameters

• Entries extends Record<string, TgpuLayoutEntry | null> = Record<string, TgpuLayoutEntry | null>

Properties

[$internal]

readonly [$internal]: true

Defined in: packages/typegpu/src/tgpuBindGroupLayout.ts:166

---

$

readonly $: { [K in string | number | symbol]: InferLayoutEntry<Entries[K]> }

Defined in: packages/typegpu/src/tgpuBindGroupLayout.ts:178

---

bound

readonly bound: { [K in string | number | symbol]: BindLayoutEntry<Entries[K]> }

Defined in: packages/typegpu/src/tgpuBindGroupLayout.ts:169

---

entries

readonly entries: Entries

Defined in: packages/typegpu/src/tgpuBindGroupLayout.ts:168

---

index

readonly index: undefined | number

Defined in: packages/typegpu/src/tgpuBindGroupLayout.ts:187

An explicit numeric index assigned to this bind group layout. If undefined, a unique index is assigned automatically during resolution. This can be changed with the .$idx() method.

---

resourceType

readonly resourceType: "bind-group-layout"

Defined in: packages/typegpu/src/tgpuBindGroupLayout.ts:167

---

value

readonly value: { [K in string | number | symbol]: InferLayoutEntry<Entries[K]> }

Defined in: packages/typegpu/src/tgpuBindGroupLayout.ts:175

Methods

[$gpuValueOf]()

[$gpuValueOf](): { [K in string | number | symbol]: InferLayoutEntry<Entries[K]> }

Defined in: packages/typegpu/src/tgpuBindGroupLayout.ts:172

Returns

{ [K in string | number | symbol]: InferLayoutEntry<Entries[K]> }

---

$idx()

$idx(index?): this

Defined in: packages/typegpu/src/tgpuBindGroupLayout.ts:195

Associates this bind group layout with an explicit numeric index. When a call to this method is omitted, a unique numeric index is assigned to it automatically.

Used when generating WGSL code: @group(${index}) @binding(...) ...;

Parameters

index?

number

Returns

this

---

$name()

$name(label): this

Defined in: packages/typegpu/src/shared/meta.ts:83

Parameters

label

string

Returns

this

Inherited from

TgpuNamable.$name

---

unwrap()

unwrap(unwrapper): GPUBindGroupLayout

Defined in: packages/typegpu/src/tgpuBindGroupLayout.ts:202

Creates a raw WebGPU resource based on the typed descriptor. NOTE: This creates a new resource every time, better to use root.unwrap(...) instead.

Parameters

unwrapper

Unwrapper

Used to unwrap any resources that this resource depends on.

Returns

GPUBindGroupLayout