Package com.google.android.filament

Class TextureSampler

java.lang.Object

com.google.android.filament.TextureSampler

public class TextureSampler
extends java.lang.Object

TextureSampler defines how a texture is accessed.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TextureSampler.CompareFunction	Comparison functions for the depth sampler.
static class	TextureSampler.CompareMode
static class	TextureSampler.MagFilter
static class	TextureSampler.MinFilter
static class	TextureSampler.WrapMode

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
float	getAnisotropy()
TextureSampler.CompareFunction	getCompareFunction()
TextureSampler.CompareMode	getCompareMode()
TextureSampler.MagFilter	getMagFilter()
TextureSampler.MinFilter	getMinFilter()
TextureSampler.WrapMode	getWrapModeR()
TextureSampler.WrapMode	getWrapModeS()
TextureSampler.WrapMode	getWrapModeT()
void	setAnisotropy(float anisotropy)	This controls anisotropic filtering.
void	setCompareFunction(TextureSampler.CompareFunction function)	Sets the comparison function.
void	setCompareMode(TextureSampler.CompareMode mode)	Sets the comparison mode.
void	setMagFilter(TextureSampler.MagFilter filter)	Sets the magnification filter.
void	setMinFilter(TextureSampler.MinFilter filter)	Sets the minification filter.
void	setWrapModeR(TextureSampler.WrapMode mode)	Sets the wrapping mode in the t (depth) direction.
void	setWrapModeS(TextureSampler.WrapMode mode)	Sets the wrapping mode in the s (horizontal) direction.
void	setWrapModeT(TextureSampler.WrapMode mode)	Sets the wrapping mode in the t (vertical) direction.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextureSampler

public TextureSampler()

Initializes the TextureSampler with default values.
Minification filter: TextureSampler.MinFilter.LINEAR_MIPMAP_LINEAR
Magnification filter: TextureSampler.MagFilter.LINEAR
Wrap modes: TextureSampler.WrapMode.REPEAT

TextureSampler

public TextureSampler(@NonNull
                      TextureSampler.MagFilter minMag)

Initializes the TextureSampler with default values, but specifying the minification and magnification filters.

Parameters:

minMag - magnification filter, the minification filter will be set to the same value.

TextureSampler

public TextureSampler(@NonNull
                      TextureSampler.MagFilter minMag,
                      @NonNull
                      TextureSampler.WrapMode wrap)

Initializes the TextureSampler with user specified values.

Parameters:

minMag - magnification filter, the minification filter will be set to the same value.

wrap - wrapping mode for all directions

TextureSampler

public TextureSampler(@NonNull
                      TextureSampler.MinFilter min,
                      @NonNull
                      TextureSampler.MagFilter mag,
                      @NonNull
                      TextureSampler.WrapMode wrap)

Initializes the TextureSampler with user specified values.

Parameters:

min - magnification filter

mag - minification filter

wrap - wrapping mode for all directions

TextureSampler

public TextureSampler(@NonNull
                      TextureSampler.MinFilter min,
                      @NonNull
                      TextureSampler.MagFilter mag,
                      @NonNull
                      TextureSampler.WrapMode s,
                      @NonNull
                      TextureSampler.WrapMode t,
                      @NonNull
                      TextureSampler.WrapMode r)

Initializes the TextureSampler with user specified values.

Parameters:

min - magnification filter

mag - minification filter

s - wrapping mode for the s (horizontal) direction

t - wrapping mode for the t (vertical) direction

r - wrapping mode fot the r (depth) direction

TextureSampler

public TextureSampler(@NonNull
                      TextureSampler.CompareMode mode)

Initializes the TextureSampler with user specified comparison mode. The comparison fonction is set to TextureSampler.CompareFunction.LESS_EQUAL.

Parameters:

mode - comparison mode

TextureSampler

public TextureSampler(@NonNull
                      TextureSampler.CompareMode mode,
                      @NonNull
                      TextureSampler.CompareFunction function)

Initializes the TextureSampler with user specified comparison mode and function.

Parameters:

mode - comparison mode

function - comparison function

Method Detail

getMinFilter

public TextureSampler.MinFilter getMinFilter()

Returns:

the minification filter

setMinFilter

public void setMinFilter(TextureSampler.MinFilter filter)

Sets the minification filter.

Parameters:

filter - minification filter

getMagFilter

public TextureSampler.MagFilter getMagFilter()

Returns:

the magnification filter

setMagFilter

public void setMagFilter(TextureSampler.MagFilter filter)

Sets the magnification filter.

Parameters:

filter - magnification filter

getWrapModeS

public TextureSampler.WrapMode getWrapModeS()

Returns:

the wrapping mode in the s (horizontal) direction

setWrapModeS

public void setWrapModeS(TextureSampler.WrapMode mode)

Sets the wrapping mode in the s (horizontal) direction.

Parameters:

mode - wrapping mode

getWrapModeT

public TextureSampler.WrapMode getWrapModeT()

Returns:

the wrapping mode in the t (vertical) direction

setWrapModeT

public void setWrapModeT(TextureSampler.WrapMode mode)

Sets the wrapping mode in the t (vertical) direction.

Parameters:

mode - wrapping mode

getWrapModeR

public TextureSampler.WrapMode getWrapModeR()

Returns:

the wrapping mode in the r (depth) direction

setWrapModeR

public void setWrapModeR(TextureSampler.WrapMode mode)

Sets the wrapping mode in the t (depth) direction.

Parameters:

mode - wrapping mode

getAnisotropy

public float getAnisotropy()

Returns:

the anisotropy value

See Also:

setAnisotropy(float)

setAnisotropy

public void setAnisotropy(float anisotropy)

This controls anisotropic filtering.

Parameters:

anisotropy - Amount of anisotropy, should be a power-of-two. The default is 0. The maximum permissible value is 7.

getCompareMode

public TextureSampler.CompareMode getCompareMode()

Returns:

the comparison mode

setCompareMode

public void setCompareMode(TextureSampler.CompareMode mode)

Sets the comparison mode.

Parameters:

mode - comparison mode

getCompareFunction

public TextureSampler.CompareFunction getCompareFunction()

Returns:

the comparison function

setCompareFunction

public void setCompareFunction(TextureSampler.CompareFunction function)

Sets the comparison function.

Parameters:

function - the comparison function