Skip to content
TypeGPU
Search
Ctrl
K
Cancel
GitHub
RSS
Documentation
Examples
Blog
Select theme
Dark
Light
Auto
Documentation
Examples
Blog
Why TypeGPU?
Getting Started
Fundamentals
Roots
Functions
TGSL
new
Pipelines
new
Buffers
Data Schemas
Bind Groups
Resolve
Vertex Layouts
Enabling Features
new
Timing Your Pipelines
new
Slots
new
Ecosystem
@typegpu/noise
Integration
WebGPU Interoperability
React Native
new
WESL Interoperability
Working with wgpu-matrix
Tooling
Build Plugin
new
Generator CLI
Reference
API
typegpu
Classes
MissingBindGroupsError
MissingLinksError
MissingSlotValueError
MissingVertexBuffersError
NotUniformError
ResolutionError
Interfaces
Configurable
IndexFlag
Render
Sampled
StorageFlag
TgpuAccessor
TgpuBindGroupLayout
TgpuBuffer
TgpuBufferMutable
TgpuBufferReadonly
TgpuBufferUniform
TgpuComputeFn
TgpuComputePipeline
TgpuConst
TgpuDeclare
TgpuDerived
TgpuFragmentFn
TgpuMutable
TgpuMutableTexture
TgpuQuerySet
TgpuReadonly
TgpuReadonlyTexture
TgpuRenderPipeline
TgpuRoot
TgpuSampledTexture
TgpuSampler
TgpuSlot
TgpuTexture
TgpuUniform
TgpuVar
TgpuVertexFn
TgpuVertexLayout
TgpuWriteonlyTexture
UniformFlag
VertexFlag
WithBinding
WithCompute
WithFragment
WithVertex
Type Aliases
BindLayoutEntry
Eventual
ExtractBindGroupInputFromLayout
InitFromDeviceOptions
InitOptions
LayoutEntryToInput
Storage
TextureProps
TgpuAnyTextureView
TgpuBindGroup
TgpuComputeFnShell
TgpuFn
TgpuFnShell
TgpuFragmentFnShell
TgpuLayoutComparisonSampler
TgpuLayoutEntry
TgpuLayoutExternalTexture
TgpuLayoutSampler
TgpuLayoutStorage
TgpuLayoutStorageTexture
TgpuLayoutTexture
TgpuLayoutUniform
TgpuVertexFnShell
Uniform
ValidateBufferSchema
ValidUsagesFor
VariableScope
Vertex
Variables
tgpu
Functions
isBuffer
isBufferShorthand
isComparisonSampler
isDerived
isSampledTextureView
isSampler
isSlot
isStorageTextureView
isTexture
isTgpuFn
isUsableAsRender
isUsableAsSampled
isUsableAsStorage
isUsableAsUniform
isUsableAsVertex
typegpu/data
Interfaces
Align
Atomic
BaseData
Bool
Builtin
Decorated
Disarray
F16
F32
I32
Interpolate
Location
LooseDecorated
m2x2f
m3x3f
m4x4f
Mat2x2f
Mat3x3f
Mat4x4f
Ptr
Size
TgpuVertexFormatData
U16
U32
Unstruct
v2b
v2f
v2i
v2u
v3b
v3f
v3i
v3u
v4b
v4f
v4i
v4u
Vec2b
Vec2f
Vec2h
Vec2i
Vec2u
Vec3b
Vec3f
Vec3h
Vec3i
Vec3u
Vec4b
Vec4f
Vec4h
Vec4i
Vec4u
Void
WgslArray
WgslStruct
Type Aliases
AnyAttribute
AnyBuiltin
AnyData
AnyLooseData
AnyVecInstance
AnyWgslData
AnyWgslStruct
BuiltinClipDistances
BuiltinFragDepth
BuiltinFrontFacing
BuiltinGlobalInvocationId
BuiltinInstanceIndex
BuiltinLocalInvocationId
BuiltinLocalInvocationIndex
BuiltinNumWorkgroups
BuiltinPosition
BuiltinSampleIndex
BuiltinSampleMask
BuiltinVertexIndex
BuiltinWorkgroupId
float16
float16x2
float16x4
float32
float32x2
float32x3
float32x4
FormatToWGSLType
HasCustomLocation
Infer
InferGPU
InferPartial
IsBuiltin
PackedData
sint16
sint16x2
sint16x4
sint32
sint32x2
sint32x3
sint32x4
sint8
sint8x2
sint8x4
snorm16
snorm16x2
snorm16x4
snorm8
snorm8x2
snorm8x4
uint16
uint16x2
uint16x4
uint32
uint32x2
uint32x3
uint32x4
uint8
uint8x2
uint8x4
unorm10_10_10_2
unorm16
unorm16x2
unorm16x4
unorm8
unorm8x2
unorm8x4
unorm8x4_bgra
Variables
builtin
float16
float16x2
float16x4
float32
float32x2
float32x3
float32x4
formatToWGSLType
packedFormats
sint16
sint16x2
sint16x4
sint32
sint32x2
sint32x3
sint32x4
sint8
sint8x2
sint8x4
snorm16
snorm16x2
snorm16x4
snorm8
snorm8x2
snorm8x4
u16
uint16
uint16x2
uint16x4
uint32
uint32x2
uint32x3
uint32x4
uint8
uint8x2
uint8x4
unorm10_10_10_2
unorm16
unorm16x2
unorm16x4
unorm8
unorm8x2
unorm8x4
unorm8x4_bgra
Void
Functions
align
alignmentOf
arrayOf
atomic
bool
disarrayOf
f16
f32
i32
interpolate
invariant
isAlignAttrib
isAtomic
isBuiltin
isBuiltinAttrib
isData
isDecorated
isDisarray
isInterpolateAttrib
isLocationAttrib
isLooseData
isLooseDecorated
isPackedData
isPtr
isSizeAttrib
isUnstruct
isWgslArray
isWgslData
isWgslStruct
location
mat2x2f
mat3x3f
mat4x4f
matToArray
ptrFn
ptrHandle
ptrPrivate
ptrStorage
ptrUniform
ptrWorkgroup
size
sizeOf
struct
u32
unstruct
vec2b
vec2f
vec2h
vec2i
vec2u
vec3b
vec3f
vec3h
vec3i
vec3u
vec4b
vec4f
vec4h
vec4i
vec4u
typegpu/std
Functions
abs
acos
acosh
add
all
allEq
and
any
arrayLength
asin
asinh
atan
atan2
atanh
atomicAdd
atomicAnd
atomicLoad
atomicMax
atomicMin
atomicOr
atomicStore
atomicSub
atomicXor
ceil
clamp
cos
cosh
countLeadingZeros
countOneBits
countTrailingZeros
cross
degrees
determinant
discard
distance
div
dot
dot4I8Packed
dot4U8Packed
dpdx
dpdxCoarse
dpdxFine
dpdy
dpdyCoarse
dpdyFine
eq
exp
exp2
extractBits
faceForward
firstLeadingBit
firstTrailingBit
floor
fma
fract
frexp
fwidth
fwidthCoarse
fwidthFine
ge
gt
identity2
identity3
identity4
insertBits
inverseSqrt
isCloseTo
ldexp
le
length
log
log2
lt
max
min
mix
mod
modf
mul
ne
neg
normalize
not
or
pack2x16float
pack4x8unorm
pow
quantizeToF16
radians
reflect
refract
reverseBits
rotateX4
rotateY4
rotateZ4
rotationX4
rotationY4
rotationZ4
round
saturate
scale4
scaling4
select
sign
sin
sinh
smoothstep
sqrt
step
storageBarrier
sub
tan
tanh
textureBarrier
textureDimensions
textureLoad
textureSample
textureSampleLevel
textureStore
translate4
translation4
transpose
trunc
unpack2x16float
unpack4x8unorm
workgroupBarrier
GitHub
RSS
Documentation
Examples
Blog
Select theme
Dark
Light
Auto
discard
discard
():
never
Defined in:
packages/typegpu/src/std/discard.ts:7
Returns
Section titled “Returns”
never
