TypeShade
storage
Function
Declares a storage binding of type T; use declare const name: storage<T> for read-only or declare const name: storage<T, "read_write"> for read-write access.
The signature and the sentence under each name are the compiler's own text at commit 26de7be8.
Syntax
declare function storage<T, A extends StorageBufferAccess = 'read'>(slot?: number | { group?: number; binding?: number }, binding?: number): A extends 'read_write' ? T : ReadView<T>A number in a parameter or a return position is the scalar slot. The ambient file declares a GPU scalar as a branded number whose brand is optional, so a literal and any branded scalar both fill it.
type f32 = number & { readonly [f32Tag]?: true }
A declaration you write still needs a width, and a bare number on a field or a parameter is refused; the TypeScript constructs page carries that row with the compiler's own message.
A signature may name a type the ambient file declares for its own use. These are those declarations.
StorageBufferAccesstype StorageBufferAccess = 'read' | 'read_write'ReadViewtype ReadView<T> = T extends number | boolean ? T : T extends (...args: never[]) => unknown ? T : { readonly [K in keyof T]: K extends string | number ? ReadView<T[K]> : T[K] }
Parameters
-
slotoptionalnumber | { group?: number; binding?: number } -
bindingoptionalnumber
Return value
A extends 'read_write' ? T : ReadView<T>
Description
The access mode is part of the type, as it is in WGSL (var<storage, read_write>); the declaration is always declare const.