WgslStruct
Defined in: packages/typegpu/src/data/wgslTypes.ts:1198
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
Section titled “TProps”TProps extends Record<string, BaseData> = Record<string, BaseData>
Call Signature
Section titled “Call Signature”WgslStruct(
props): { [K in string | number | symbol]: InferRecord<TProps>[K] }
Defined in: packages/typegpu/src/data/wgslTypes.ts:1211
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] }
Call Signature
Section titled “Call Signature”WgslStruct(): { [K in string | number | symbol]: InferRecord<TProps>[K] }
Defined in: packages/typegpu/src/data/wgslTypes.ts:1212
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] }
Properties
Section titled “Properties”[$gpuRepr]
Section titled “[$gpuRepr]”
readonly[$gpuRepr]: { [K in string | number | symbol]: InferGPURecord<TProps>[K] }
Defined in: packages/typegpu/src/data/wgslTypes.ts:1217
[$inRepr]
Section titled “[$inRepr]”
readonly[$inRepr]: { [K in string | number | symbol]: InferInputRecord<TProps>[K] }
Defined in: packages/typegpu/src/data/wgslTypes.ts:1216
[$internal]
Section titled “[$internal]”
readonly[$internal]:object
Defined in: packages/typegpu/src/data/wgslTypes.ts:1205
isAbstruct
Section titled “isAbstruct”isAbstruct:
boolean
Overrides
Section titled “Overrides”[$invalidSchemaReason]
Section titled “[$invalidSchemaReason]”
readonly**[{K & string}’ — `> }[keyof TProps],undefined>
Defined in: packages/typegpu/src/data/wgslTypes.ts:1221
[$memIdent]
Section titled “[$memIdent]”
readonly[$memIdent]:WgslStruct<{ [K in string | number | symbol]: MemIdentityRecord<TProps>[K] }>
Defined in: packages/typegpu/src/data/wgslTypes.ts:1218
[$repr]
Section titled “[$repr]”
readonly[$repr]: { [K in string | number | symbol]: InferRecord<TProps>[K] }
Defined in: packages/typegpu/src/data/wgslTypes.ts:1215
Overrides
Section titled “Overrides”[$reprPartial]
Section titled “[$reprPartial]”
readonly[$reprPartial]: { [K in string | number | symbol]: Partial<InferPartialRecord<TProps>>[K] } |undefined
Defined in: packages/typegpu/src/data/wgslTypes.ts:1219
[$reprPatch]
Section titled “[$reprPatch]”
readonly[$reprPatch]: { [K in string | number | symbol]: Partial<InferPatchRecord<TProps>>[K] } |undefined
Defined in: packages/typegpu/src/data/wgslTypes.ts:1220
[$validStorageSchema]
Section titled “[$validStorageSchema]”
readonly[$validStorageSchema]: { [K in string | number | symbol]: IsValidStorageSchema<TProps[K]> }[keyofTProps] extendstrue?true:false
Defined in: packages/typegpu/src/data/wgslTypes.ts:1230
[$validUniformSchema]
Section titled “[$validUniformSchema]”
readonly[$validUniformSchema]: { [K in string | number | symbol]: IsValidUniformSchema<TProps[K]> }[keyofTProps] extendstrue?true:false
Defined in: packages/typegpu/src/data/wgslTypes.ts:1235
[$validVertexSchema]
Section titled “[$validVertexSchema]”
readonly[$validVertexSchema]: { [K in string | number | symbol]: IsValidVertexSchema<TProps[K]> }[keyofTProps] extendstrue?true:false
Defined in: packages/typegpu/src/data/wgslTypes.ts:1240
propTypes
Section titled “propTypes”
readonlypropTypes:TProps
Defined in: packages/typegpu/src/data/wgslTypes.ts:1209
readonlytype:"struct"
Defined in: packages/typegpu/src/data/wgslTypes.ts:1208
Overrides
Section titled “Overrides”Methods
Section titled “Methods”$name()
Section titled “$name()”$name(
label):this
Defined in: packages/typegpu/src/shared/meta.ts:97
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”TgpuNamable.$name
toString()
Section titled “toString()”toString():
string
Defined in: packages/typegpu/src/data/wgslTypes.ts:49
Returns
Section titled “Returns”string