WgslStruct

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

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.GPUCallable<[Prettify<InferRecord<TProps>>]>

Type Parameters

TProps

TProps extends Record<string, BaseData> = Record<string, BaseData>

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

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

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] }

Properties

[$gpuCallableStrictSignature]?

optional [$gpuCallableStrictSignature]: GPUCallableStrictSignature

Defined in: packages/typegpu/src/types.ts:484

Inherited from

GPUCallable.[$gpuCallableStrictSignature]

---

[$gpuRepr]

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

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

---

[$inRepr]

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

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

---

[$internal]

readonly [$internal]: object

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

isAbstruct

isAbstruct: boolean

Overrides

BaseData.[$internal]

---

[$invalidSchemaReason]

readonly **[{K & string}’ — `> }[keyof TProps], undefined>

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

---

[$memIdent]

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

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

---

[$repr]

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

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

Overrides

BaseData.[$repr]

---

[$reprPartial]

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

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

---

[$reprPatch]

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

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

---

[$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:1265

---

[$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:1270

---

[$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:1275

---

propTypes

readonly propTypes: TProps

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

---

type

readonly type: "struct"

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

Overrides

BaseData.type

Methods

[$gpuCallable]()

[$gpuCallable](ctx, args): Snippet

Defined in: packages/typegpu/src/types.ts:483

Parameters

ctx

ResolutionCtx

args

readonly [Snippet | undefined]

Returns

Snippet

Inherited from

GPUCallable.[$gpuCallable]

---

$name()

$name(label): this

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

Parameters

label

string

Returns

this

Inherited from

TgpuNamable.$name

---

toString()

toString(): string

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

Returns

string

Inherited from

BaseData.toString