Unstruct

Defined in: packages/typegpu/src/data/dataTypes.ts:61

Struct schema constructed via d.unstruct function.

Useful for defining vertex buffers, as the standard layout restrictions do not apply. Members are not aligned in respect to their byteAlignment, unless they are explicitly decorated with the custom align attribute via d.align function.

Extends

BaseData.TgpuNamable

Type Parameters

• TProps extends Record<string, BaseData> = any

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

Defined in: packages/typegpu/src/data/dataTypes.ts:65

Struct schema constructed via d.unstruct function.

Parameters

props

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

Returns

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

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

Defined in: packages/typegpu/src/data/dataTypes.ts:66

Struct schema constructed via d.unstruct function.

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/dataTypes.ts:72

[$internal]

readonly [$internal]: true | Record<string, any>

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

Inherited from

BaseData.[$internal]

[$invalidSchemaReason]

readonly [$invalidSchemaReason]: "Unstructs are not host-shareable, use structs instead"

Defined in: packages/typegpu/src/data/dataTypes.ts:80

[$memIdent]

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

Defined in: packages/typegpu/src/data/dataTypes.ts:73

[$repr]

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

Defined in: packages/typegpu/src/data/dataTypes.ts:71

Overrides

BaseData.[$repr]

[$reprPartial]

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

Defined in: packages/typegpu/src/data/dataTypes.ts:74

[$validVertexSchema]

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

Defined in: packages/typegpu/src/data/dataTypes.ts:77