TgpuBindGroupLayout
Extends
Section titled “Extends”TgpuNamable
Type Parameters
Section titled “Type Parameters”• Entries extends Record<string, TgpuLayoutEntry | null> = Record<string, TgpuLayoutEntry | null>
Properties
Section titled “Properties”[$gpuValueOf]
Section titled “[$gpuValueOf]”
readonly[$gpuValueOf]: { [K in string | number | symbol]: InferLayoutEntry<Entries[K]> }
Defined in
Section titled “Defined in”packages/typegpu/src/tgpuBindGroupLayout.ts:287
[$internal]
Section titled “[$internal]”
readonly[$internal]:BindGroupLayoutInternals<Entries>
Defined in
Section titled “Defined in”packages/typegpu/src/tgpuBindGroupLayout.ts:278
$
readonly$: { [K in string | number | symbol]: InferLayoutEntry<Entries[K]> }
Defined in
Section titled “Defined in”packages/typegpu/src/tgpuBindGroupLayout.ts:296
readonlybound: { [K in string | number | symbol]: BindLayoutEntry<Entries[K]> }
Defined in
Section titled “Defined in”packages/typegpu/src/tgpuBindGroupLayout.ts:284
entries
Section titled “entries”
readonlyentries:Entries
Defined in
Section titled “Defined in”packages/typegpu/src/tgpuBindGroupLayout.ts:280
readonlyindex:undefined|number
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.
Defined in
Section titled “Defined in”packages/typegpu/src/tgpuBindGroupLayout.ts:305
resourceType
Section titled “resourceType”
readonlyresourceType:"bind-group-layout"
Defined in
Section titled “Defined in”packages/typegpu/src/tgpuBindGroupLayout.ts:279
readonlyvalue: { [K in string | number | symbol]: InferLayoutEntry<Entries[K]> }
Defined in
Section titled “Defined in”packages/typegpu/src/tgpuBindGroupLayout.ts:293
Methods
Section titled “Methods”$idx()
Section titled “$idx()”$idx(
index?):this
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
Section titled “Parameters”index?
Section titled “index?”number
Returns
Section titled “Returns”this
Defined in
Section titled “Defined in”packages/typegpu/src/tgpuBindGroupLayout.ts:313
$name()
Section titled “$name()”$name(
label):this
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”TgpuNamable.$name
Defined in
Section titled “Defined in”packages/typegpu/src/shared/meta.ts:97
unwrap()
Section titled “unwrap()”unwrap(
unwrapper):GPUBindGroupLayout
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
Section titled “Parameters”unwrapper
Section titled “unwrapper”Unwrapper
Used to unwrap any resources that this resource depends on.
Returns
Section titled “Returns”GPUBindGroupLayout