API reference
API reference
Select your platform
No SDKs available
No versions available

SamplerConfig Class

Modifiers: final
Data class representing a sampler configuration.
This class holds various parameters that control how a texture is sampled in a shader. Visualizations of these functions can be found here.

Signature

data class SamplerConfig(val minFilter: Filter = Filter.LINEAR, val magFilter: Filter = Filter.LINEAR, val mipmapMode: Filter = Filter.LINEAR, val addressModeU: AddressMode = AddressMode.REPEAT, val addressModeV: AddressMode = AddressMode.REPEAT, val lodBias: Float = 0.0f)

Constructors

SamplerConfig ( minFilter , magFilter , mipmapMode , addressModeU , addressModeV , lodBias ) : SamplerConfig
Signature
constructor(minFilter: Filter = Filter.LINEAR, magFilter: Filter = Filter.LINEAR, mipmapMode: Filter = Filter.LINEAR, addressModeU: AddressMode = AddressMode.REPEAT, addressModeV: AddressMode = AddressMode.REPEAT, lodBias: Float = 0.0f)
Parameters
minFilter: Filter
magFilter: Filter
mipmapMode: Filter
addressModeU: AddressMode
addressModeV: AddressMode
lodBias: Float

Properties

addressModeU : AddressMode
[Get]
Addressing mode for U texture coordinates outside the range of 0, 1.
Signature
val addressModeU: AddressMode
addressModeV : AddressMode
[Get]
Addressing mode for V texture coordinates outside the range of 0, 1.
Signature
val addressModeV: AddressMode
lodBias : Float
[Get]
Bias value added to the LOD (Level of Detail) calculation in the shader.
Negative values result in a slightly sharper image. Positive values will allow detail to be lowered when far away.
Signature
val lodBias: Float = 0.0f
magFilter : Filter
[Get]
Filter mode for magnification (when texel coverage is finer than pixel coverage).
Signature
val magFilter: Filter
minFilter : Filter
[Get]
Filter mode for minification (when texel coverage is coarser than pixel coverage).
Signature
val minFilter: Filter
mipmapMode : Filter
[Get]
Filter mode for mipmapping (when texel coverage is between mipmap levels).
Signature
val mipmapMode: Filter
Did you find this page helpful?
Thumbs up icon
Thumbs down icon