WgslStruct

Defined in: packages/typegpu/src/data/wgslTypes.ts:1294

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

BaseData.TgpuNamable

Type Parameters

• TProps extends Record<string, BaseData> = any

WgslStruct(props): { [K in string | number | symbol]: InferRecord<TProps>[K] }

Defined in: packages/typegpu/src/data/wgslTypes.ts:1304

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

props

{ [K in string | number | symbol]: InferRecord<TProps>[K] }

Returns

{ [K in string | number | symbol]: InferRecord<TProps>[K] }

WgslStruct(): { [K in string | number | symbol]: InferRecord<TProps>[K] }

Defined in: packages/typegpu/src/data/wgslTypes.ts:1305

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

{ [K in string | number | symbol]: InferRecord<TProps>[K] }

Properties

[$gpuRepr]

readonly [$gpuRepr]: { [K in string | number | symbol]: InferGPURecord<TProps>[K] }

Defined in: packages/typegpu/src/data/wgslTypes.ts:1309

[$internal]

readonly [$internal]: object

Defined in: packages/typegpu/src/data/wgslTypes.ts:1298

isAbstruct

isAbstruct: boolean

Overrides

BaseData.[$internal]

[$invalidSchemaReason]

readonly [$invalidSchemaReason]: SwapNever<{ [K in string | number | symbol]: ExtractInvalidSchemaError<TProps[K], `in struct property ’${K & string}’ — `> }[keyof TProps], undefined>

Defined in: packages/typegpu/src/data/wgslTypes.ts:1314

[$memIdent]

readonly [$memIdent]: WgslStruct<{ [K in string | number | symbol]: MemIdentityRecord<TProps>[K] }>

Defined in: packages/typegpu/src/data/wgslTypes.ts:1310

[$repr]

readonly [$repr]: { [K in string | number | symbol]: InferRecord<TProps>[K] }

Defined in: packages/typegpu/src/data/wgslTypes.ts:1308

Overrides

BaseData.[$repr]

[$reprPartial]

readonly [$reprPartial]: undefined | { [K in string | number | symbol]: Partial<InferPartialRecord<TProps>>[K] }

Defined in: packages/typegpu/src/data/wgslTypes.ts:1311

[$validStorageSchema]

readonly [$validStorageSchema]: { [K in string | number | symbol]: IsValidStorageSchema<TProps[K]> }[keyof TProps] extends true ? true : false

Defined in: packages/typegpu/src/data/wgslTypes.ts:1323

[$validUniformSchema]

readonly [$validUniformSchema]: { [K in string | number | symbol]: IsValidUniformSchema<TProps[K]> }[keyof TProps] extends true ? true : false

Defined in: packages/typegpu/src/data/wgslTypes.ts:1326

[$validVertexSchema]

readonly [$validVertexSchema]: { [K in string | number | symbol]: IsValidVertexSchema<TProps[K]> }[keyof TProps] extends true ? true : false

Defined in: packages/typegpu/src/data/wgslTypes.ts:1329