Skip to content

GPUSamplerDescriptor

interface GPUSamplerDescriptor : GPUObjectDescriptorBase
Describes the address modes, filtering modes, and level-of-detail limits for a GPUSampler.

Properties

addressModeU

Specifies the address modes for the texture width, height, and depth coordinates, respectively.

addressModeV

Specifies the address modes for the texture width, height, and depth coordinates, respectively.

addressModeW

Specifies the address modes for the texture width, height, and depth coordinates, respectively.

compare

abstract val compare: GPUCompareFunction?
When provided the sampler will be a comparison sampler with the specified GPUCompareFunction. Note: Comparison samplers may use filtering, but the sampling results will be implementation-dependent and may differ from the normal filtering rules.

label

abstract val label: String
The initial value of GPUObjectBase.label. See [GPUObjectDescriptorBase.label in the WebGPU specification](https://www.w3.org/TR/webgpu/#dom-gpuobjectdescriptorbase-label).

lodMaxClamp

abstract val lodMaxClamp: Float
Specifies the minimum and maximum levels of detail, respectively, used internally when sampling a texture.

lodMinClamp

abstract val lodMinClamp: Float
Specifies the minimum and maximum levels of detail, respectively, used internally when sampling a texture.

magFilter

abstract val magFilter: GPUFilterMode
Specifies the sampling behavior when the sampled area is smaller than or equal to one texel.

maxAnisotropy

abstract val maxAnisotropy: UShort
Specifies the maximum anisotropy value clamp used by the sampler. Anisotropic filtering is enabled when maxAnisotropy is > 1 and the implementation supports it. Anisotropic filtering improves the image quality of textures sampled at oblique viewing angles. Higher maxAnisotropy values indicate the maximum ratio of anisotropy supported when filtering.

minFilter

abstract val minFilter: GPUFilterMode
Specifies the sampling behavior when the sampled area is larger than one texel.

mipmapFilter

Specifies behavior for sampling between mipmap levels.