WgslStruct
Struct schema constructed via d.struct function.
Responsible for handling reading and writing struct values
between binary and JS representation. Takes into account
the byteAlignment requirement of its members.
Extends
Section titled “Extends”BaseData.TgpuNamable
Type Parameters
Section titled “Type Parameters”• TProps extends Record<string, BaseData> = any
WgslStruct(
props): { [K in string | number | symbol]: InferRecord<TProps>[K] }
Struct schema constructed via d.struct function.
Responsible for handling reading and writing struct values
between binary and JS representation. Takes into account
the byteAlignment requirement of its members.
Parameters
Section titled “Parameters”{ [K in string | number | symbol]: InferRecord<TProps>[K] }
Returns
Section titled “Returns”{ [K in string | number | symbol]: InferRecord<TProps>[K] }
Defined in
Section titled “Defined in”packages/typegpu/src/data/wgslTypes.ts:1327
WgslStruct(): { [K in string | number | symbol]: InferRecord<TProps>[K] }
Struct schema constructed via d.struct function.
Responsible for handling reading and writing struct values
between binary and JS representation. Takes into account
the byteAlignment requirement of its members.
Returns
Section titled “Returns”{ [K in string | number | symbol]: InferRecord<TProps>[K] }
Defined in
Section titled “Defined in”packages/typegpu/src/data/wgslTypes.ts:1328
Properties
Section titled “Properties”[$gpuRepr]
Section titled “[$gpuRepr]”
readonly[$gpuRepr]: { [K in string | number | symbol]: InferGPURecord<TProps>[K] }
Defined in
Section titled “Defined in”packages/typegpu/src/data/wgslTypes.ts:1332
[$internal]
Section titled “[$internal]”
readonly[$internal]:object
isAbstruct
Section titled “isAbstruct”isAbstruct:
boolean
Overrides
Section titled “Overrides”Defined in
Section titled “Defined in”packages/typegpu/src/data/wgslTypes.ts:1321
[$invalidSchemaReason]
Section titled “[$invalidSchemaReason]”
readonly**[{K & string}’ — `> }[keyof TProps],undefined>
Defined in
Section titled “Defined in”packages/typegpu/src/data/wgslTypes.ts:1337
[$memIdent]
Section titled “[$memIdent]”
readonly[$memIdent]:WgslStruct<{ [K in string | number | symbol]: MemIdentityRecord<TProps>[K] }>
Defined in
Section titled “Defined in”packages/typegpu/src/data/wgslTypes.ts:1333
[$repr]
Section titled “[$repr]”
readonly[$repr]: { [K in string | number | symbol]: InferRecord<TProps>[K] }
Overrides
Section titled “Overrides”Defined in
Section titled “Defined in”packages/typegpu/src/data/wgslTypes.ts:1331
[$reprPartial]
Section titled “[$reprPartial]”
readonly[$reprPartial]:undefined| { [K in string | number | symbol]: Partial<InferPartialRecord<TProps>>[K] }
Defined in
Section titled “Defined in”packages/typegpu/src/data/wgslTypes.ts:1334
[$validStorageSchema]
Section titled “[$validStorageSchema]”
readonly[$validStorageSchema]: { [K in string | number | symbol]: IsValidStorageSchema<TProps[K]> }[keyofTProps] extendstrue?true:false
Defined in
Section titled “Defined in”packages/typegpu/src/data/wgslTypes.ts:1346
[$validUniformSchema]
Section titled “[$validUniformSchema]”
readonly[$validUniformSchema]: { [K in string | number | symbol]: IsValidUniformSchema<TProps[K]> }[keyofTProps] extendstrue?true:false
Defined in
Section titled “Defined in”packages/typegpu/src/data/wgslTypes.ts:1349
[$validVertexSchema]
Section titled “[$validVertexSchema]”
readonly[$validVertexSchema]: { [K in string | number | symbol]: IsValidVertexSchema<TProps[K]> }[keyofTProps] extendstrue?true:false
Defined in
Section titled “Defined in”packages/typegpu/src/data/wgslTypes.ts:1352
propTypes
Section titled “propTypes”
readonlypropTypes:TProps
Defined in
Section titled “Defined in”packages/typegpu/src/data/wgslTypes.ts:1325
readonlytype:"struct"
Overrides
Section titled “Overrides”Defined in
Section titled “Defined in”packages/typegpu/src/data/wgslTypes.ts:1324
Methods
Section titled “Methods”$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