TextureSampler

public final class TextureSampler

Defines the sampling behavior for a texture.

The fields of this sampler are based on the public Filament TextureSampler class but may diverge over time.

Summary

Nested types

Defines the constants for texture magnification filters.

Defines the constants for texture minification filters.
public final class TextureSampler.WrapMode

Defines the constants for texture wrap modes.

Public constructors
TextureSampler(
    @NonNull TextureSampler.MinificationFilter minificationFilter,
    @NonNull TextureSampler.MagnificationFilter magnificationFilter,
    @NonNull TextureSampler.WrapMode wrapModeHorizontal,
    @NonNull TextureSampler.WrapMode wrapModeVertical,
    @NonNull TextureSampler.WrapMode wrapModeDepth
)

Defines the sampling behavior for a texture.

Public methods
final @NonNull TextureSampler.MagnificationFilter

an Int which describes how neighboring texels are sampled when the rendered size is larger than the texture.
final @NonNull TextureSampler.MinificationFilter

an Int which describes how neighboring texels are sampled when the rendered size is smaller than the texture.
final @NonNull TextureSampler.WrapMode

an Int which describes how texture coordinates outside the 0-1 range are handled along the depth axis.
final @NonNull TextureSampler.WrapMode

an Int which describes how texture coordinates outside the 0-1 range are handled along the horizontal axis.
final @NonNull TextureSampler.WrapMode

an Int which describes how texture coordinates outside the 0-1 range are handled along the vertical axis.

Public constructors

TextureSampler

Added in 1.0.0-alpha09
public TextureSampler(
    @NonNull TextureSampler.MinificationFilter minificationFilter,
    @NonNull TextureSampler.MagnificationFilter magnificationFilter,
    @NonNull TextureSampler.WrapMode wrapModeHorizontal,
    @NonNull TextureSampler.WrapMode wrapModeVertical,
    @NonNull TextureSampler.WrapMode wrapModeDepth
)

Defines the sampling behavior for a texture.

The fields of this sampler are based on the public Filament TextureSampler class but may diverge over time.

Parameters
@NonNull TextureSampler.MinificationFilter minificationFilter

an Int which describes how neighboring texels are sampled when the rendered size is smaller than the texture.
@NonNull TextureSampler.MagnificationFilter magnificationFilter

an Int which describes how neighboring texels are sampled when the rendered size is larger than the texture.
@NonNull TextureSampler.WrapMode wrapModeHorizontal

an Int which describes how texture coordinates outside the 0-1 range are handled along the horizontal axis.
@NonNull TextureSampler.WrapMode wrapModeVertical

an Int which describes how texture coordinates outside the 0-1 range are handled along the vertical axis.
@NonNull TextureSampler.WrapMode wrapModeDepth

an Int which describes how texture coordinates outside the 0-1 range are handled along the depth axis.

Public methods

getMagnificationFilter

Added in 1.0.0-alpha09
public final @NonNull TextureSampler.MagnificationFilter getMagnificationFilter()

an Int which describes how neighboring texels are sampled when the rendered size is larger than the texture.

getMinificationFilter

Added in 1.0.0-alpha09
public final @NonNull TextureSampler.MinificationFilter getMinificationFilter()

an Int which describes how neighboring texels are sampled when the rendered size is smaller than the texture.

getWrapModeDepth

Added in 1.0.0-alpha09
public final @NonNull TextureSampler.WrapMode getWrapModeDepth()

an Int which describes how texture coordinates outside the 0-1 range are handled along the depth axis.

getWrapModeHorizontal

Added in 1.0.0-alpha09
public final @NonNull TextureSampler.WrapMode getWrapModeHorizontal()

an Int which describes how texture coordinates outside the 0-1 range are handled along the horizontal axis.

getWrapModeVertical

Added in 1.0.0-alpha09
public final @NonNull TextureSampler.WrapMode getWrapModeVertical()

an Int which describes how texture coordinates outside the 0-1 range are handled along the vertical axis.