Back to Filament

TextureSampler

docs/android/dokka/filament-android/com.google.android.filament/-texture-sampler/index.md

1.75.05.1 KB
Original Source

//filament-android/com.google.android.filament/TextureSampler

TextureSampler

[main]
open class TextureSampler

TextureSampler defines how a texture is accessed.

Constructors

TextureSampler[main]
constructor()
Initializes the TextureSampler with default values.
constructor(minMag: TextureSampler.MagFilter)
Initializes the TextureSampler with default values, but specifying the minification and magnification filters.
constructor(minMag: TextureSampler.MagFilter, wrap: TextureSampler.WrapMode)
Initializes the TextureSampler with user specified values.
constructor(min: TextureSampler.MinFilter, mag: TextureSampler.MagFilter, wrap: TextureSampler.WrapMode)
Initializes the TextureSampler with user specified values.
constructor(min: TextureSampler.MinFilter, mag: TextureSampler.MagFilter, s: TextureSampler.WrapMode, t: TextureSampler.WrapMode, r: TextureSampler.WrapMode)
Initializes the TextureSampler with user specified values.
constructor(mode: TextureSampler.CompareMode)
Initializes the TextureSampler with user specified comparison mode.
constructor(mode: TextureSampler.CompareMode, function: TextureSampler.CompareFunction)
Initializes the TextureSampler with user specified comparison mode and function.

Types

NameSummary
CompareFunction[main]
enum CompareFunction
Comparison functions for the depth sampler.
CompareMode[main]
enum CompareMode
MagFilter[main]
enum MagFilter
MinFilter[main]
enum MinFilter
WrapMode[main]
enum WrapMode

Functions

NameSummary
getAnisotropy[main]
open fun getAnisotropy(): Float
getCompareFunction[main]
open fun getCompareFunction(): TextureSampler.CompareFunction
getCompareMode[main]
open fun getCompareMode(): TextureSampler.CompareMode
getMagFilter[main]
open fun getMagFilter(): TextureSampler.MagFilter
getMinFilter[main]
open fun getMinFilter(): TextureSampler.MinFilter
getWrapModeR[main]
open fun getWrapModeR(): TextureSampler.WrapMode
getWrapModeS[main]
open fun getWrapModeS(): TextureSampler.WrapMode
getWrapModeT[main]
open fun getWrapModeT(): TextureSampler.WrapMode
setAnisotropy[main]
open fun setAnisotropy(anisotropy: Float)
This controls anisotropic filtering.
setCompareFunction[main]
open fun setCompareFunction(function: TextureSampler.CompareFunction)
Sets the comparison function.
setCompareMode[main]
open fun setCompareMode(mode: TextureSampler.CompareMode)
Sets the comparison mode.
setMagFilter[main]
open fun setMagFilter(filter: TextureSampler.MagFilter)
Sets the magnification filter.
setMinFilter[main]
open fun setMinFilter(filter: TextureSampler.MinFilter)
Sets the minification filter.
setWrapModeR[main]
open fun setWrapModeR(mode: TextureSampler.WrapMode)
Sets the wrapping mode in the r (depth) direction.
setWrapModeS[main]
open fun setWrapModeS(mode: TextureSampler.WrapMode)
Sets the wrapping mode in the s (horizontal) direction.
setWrapModeT[main]
open fun setWrapModeT(mode: TextureSampler.WrapMode)
Sets the wrapping mode in the t (vertical) direction.