Sampler | API reference | Android Developers (original) (raw)

Stay organized with collections Save and categorize content based on your preferences.

public class Sampler
` extends [BaseObj](/reference/android/renderscript/BaseObj) `

This class was deprecated in API level 31.
Renderscript has been deprecated in API level 31. Please refer to the migration guide for the proposed alternatives.

Sampler object that defines how Allocations can be read as textures within a kernel. Samplers are used in conjunction with the rsSample runtime function to return values from normalized coordinates. Any Allocation used with a Sampler must have been created with [Allocation.USAGE_GRAPHICS_TEXTURE](/reference/android/renderscript/Allocation#USAGE%5FGRAPHICS%5FTEXTURE); using a Sampler on an [Allocation](/reference/android/renderscript/Allocation) that was not created with [Allocation.USAGE_GRAPHICS_TEXTURE](/reference/android/renderscript/Allocation#USAGE%5FGRAPHICS%5FTEXTURE) is undefined.

Summary

Nested classes
class	Sampler.Builder Builder for creating non-standard samplers.

Public methods
staticSampler	CLAMP_LINEAR(RenderScript rs) Retrieve a sampler with min and mag set to linear and wrap modes set to clamp.
staticSampler	CLAMP_LINEAR_MIP_LINEAR(RenderScript rs) Retrieve a sampler with mag set to linear, min linear mipmap linear, and wrap modes set to clamp.
staticSampler	CLAMP_NEAREST(RenderScript rs) Retrieve a sampler with min and mag set to nearest and wrap modes set to clamp.
staticSampler	MIRRORED_REPEAT_LINEAR(RenderScript rs) Retrieve a sampler with min and mag set to linear and wrap modes set to mirrored repeat.
staticSampler	MIRRORED_REPEAT_LINEAR_MIP_LINEAR(RenderScript rs) Retrieve a sampler with min and mag set to linear and wrap modes set to mirrored repeat.
staticSampler	MIRRORED_REPEAT_NEAREST(RenderScript rs) Retrieve a sampler with min and mag set to nearest and wrap modes set to mirrored repeat.
staticSampler	WRAP_LINEAR(RenderScript rs) Retrieve a sampler with min and mag set to linear and wrap modes set to wrap.
staticSampler	WRAP_LINEAR_MIP_LINEAR(RenderScript rs) Retrieve a sampler with mag set to linear, min linear mipmap linear, and wrap modes set to wrap.
staticSampler	WRAP_NEAREST(RenderScript rs) Retrieve a sampler with min and mag set to nearest and wrap modes set to wrap.
float	getAnisotropy()
Sampler.Value	getMagnification()
Sampler.Value	getMinification()
Sampler.Value	getWrapS()
Sampler.Value	getWrapT()

Inherited methods
From class android.renderscript.BaseObj void destroy() Frees any native resources associated with this object. boolean equals(Object obj) Compare the current BaseObj with another BaseObj for equality. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. String getName() int hashCode() Calculates the hash code value for a BaseObj. void setName(String name) setName assigns a name to an object.
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. finalClass<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Inherited methods

From class android.renderscript.BaseObj void destroy() Frees any native resources associated with this object. boolean equals(Object obj) Compare the current BaseObj with another BaseObj for equality. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. String getName() int hashCode() Calculates the hash code value for a BaseObj. void setName(String name) setName assigns a name to an object.

From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. finalClass<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

CLAMP_LINEAR

public static Sampler CLAMP_LINEAR (RenderScript rs)

Retrieve a sampler with min and mag set to linear and wrap modes set to clamp.

Parameters
rs	RenderScript: Context to which the sampler will belong.

Returns
Sampler	Sampler

CLAMP_LINEAR_MIP_LINEAR

public static Sampler CLAMP_LINEAR_MIP_LINEAR (RenderScript rs)

Retrieve a sampler with mag set to linear, min linear mipmap linear, and wrap modes set to clamp.

Parameters
rs	RenderScript: Context to which the sampler will belong.

Returns
Sampler	Sampler

CLAMP_NEAREST

public static Sampler CLAMP_NEAREST (RenderScript rs)

Retrieve a sampler with min and mag set to nearest and wrap modes set to clamp.

Parameters
rs	RenderScript: Context to which the sampler will belong.

Returns
Sampler	Sampler

MIRRORED_REPEAT_LINEAR

public static Sampler MIRRORED_REPEAT_LINEAR (RenderScript rs)

Retrieve a sampler with min and mag set to linear and wrap modes set to mirrored repeat.

Parameters
rs	RenderScript: Context to which the sampler will belong.

Returns
Sampler	Sampler

MIRRORED_REPEAT_LINEAR_MIP_LINEAR

public static Sampler MIRRORED_REPEAT_LINEAR_MIP_LINEAR (RenderScript rs)

Retrieve a sampler with min and mag set to linear and wrap modes set to mirrored repeat.

Parameters
rs	RenderScript: Context to which the sampler will belong.

Returns
Sampler	Sampler

MIRRORED_REPEAT_NEAREST

public static Sampler MIRRORED_REPEAT_NEAREST (RenderScript rs)

Retrieve a sampler with min and mag set to nearest and wrap modes set to mirrored repeat.

Parameters
rs	RenderScript: Context to which the sampler will belong.

Returns
Sampler	Sampler

WRAP_LINEAR

public static Sampler WRAP_LINEAR (RenderScript rs)

Retrieve a sampler with min and mag set to linear and wrap modes set to wrap.

Parameters
rs	RenderScript: Context to which the sampler will belong.

Returns
Sampler	Sampler

WRAP_LINEAR_MIP_LINEAR

public static Sampler WRAP_LINEAR_MIP_LINEAR (RenderScript rs)

Retrieve a sampler with mag set to linear, min linear mipmap linear, and wrap modes set to wrap.

Parameters
rs	RenderScript: Context to which the sampler will belong.

Returns
Sampler	Sampler

WRAP_NEAREST

public static Sampler WRAP_NEAREST (RenderScript rs)

Retrieve a sampler with min and mag set to nearest and wrap modes set to wrap.

Parameters
rs	RenderScript: Context to which the sampler will belong.

Returns
Sampler	Sampler

getAnisotropy

public float getAnisotropy ()

Returns
float	anisotropy setting for the sampler