Interface SamplerOptions

Options used to create a Sampler.

interface SamplerOptions {
    type?: GPUSamplerBindingType;
    addressModeU?: GPUAddressMode;
    addressModeV?: GPUAddressMode;
    addressModeW?: GPUAddressMode;
    magFilter?: GPUFilterMode;
    minFilter?: GPUFilterMode;
    mipmapFilter?: GPUMipmapFilterMode;
    lodMinClamp?: number;
    lodMaxClamp?: number;
    label?: string;
    compare?: GPUCompareFunction;
    maxAnisotropy?: number;
}

Hierarchy (View Summary)

  • GPUSamplerDescriptor
  • GPUSamplerBindingLayout

Properties

type? addressModeU? addressModeV? addressModeW? magFilter? minFilter? mipmapFilter? lodMinClamp? lodMaxClamp? label? compare? maxAnisotropy?

Properties

Optionaltype

type?: GPUSamplerBindingType

Indicates the required type of a sampler bound to this bindings.

OptionaladdressModeU

addressModeU?: GPUAddressMode

OptionaladdressModeV

addressModeV?: GPUAddressMode

OptionaladdressModeW

addressModeW?: GPUAddressMode

Specifies the {{GPUAddressMode|address modes}} for the texture width, height, and depth coordinates, respectively.

OptionalmagFilter

magFilter?: GPUFilterMode

Specifies the sampling behavior when the sampled area is smaller than or equal to one texel.

OptionalminFilter

minFilter?: GPUFilterMode

Specifies the sampling behavior when the sampled area is larger than one texel.

OptionalmipmapFilter

mipmapFilter?: GPUMipmapFilterMode

Specifies behavior for sampling between mipmap levels.

OptionallodMinClamp

lodMinClamp?: number

OptionallodMaxClamp

lodMaxClamp?: number

Specifies the minimum and maximum levels of detail, respectively, used internally when sampling a texture.

Optionallabel

label?: string

The label of the GPUSampler, useful for debugging purpose.

Optionalcompare

compare?: GPUCompareFunction

When provided the sampler will be a comparison sampler. See GPUCompareFunction (WebGPU API reference).

OptionalmaxAnisotropy

maxAnisotropy?: number

Specifies the maximum anisotropy value clamp used by the sampler. See maxAnisotropy (WebGPU API reference).

Settings

Member Visibility

On This Page

Properties