Sampler

Kotlin |Java

open class Sampler : BaseObj

kotlin.Any
↳	android.renderscript.BaseObj
	↳	android.renderscript.Sampler

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 ; using a Sampler on an android.renderscript.Allocation that was not created with is undefined.

Summary

Nested classes
open	`Builder` Builder for creating non-standard samplers.
	`Value`

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

Inherited functions

From class BaseObj

`Unit`	`destroy()` Frees any native resources associated with this object. The primary use is to force immediate cleanup of resources when it is believed the GC will not respond quickly enough.
`Boolean`	`equals(other: Any?)` Compare the current BaseObj with another BaseObj for equality.
`Unit`	`finalize()`
`String!`	`getName()`
`Int`	`hashCode()` Calculates the hash code value for a BaseObj.
`Unit`	`setName(name: String!)` setName assigns a name to an object. This object can later be looked up by this name.

Public methods

CLAMP_LINEAR

Added in API level 11

open static fun CLAMP_LINEAR(rs: RenderScript!): Sampler!

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.

Return
`Sampler!`	Sampler

CLAMP_LINEAR_MIP_LINEAR

Added in API level 11

open static fun CLAMP_LINEAR_MIP_LINEAR(rs: RenderScript!): Sampler!

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.

Return
`Sampler!`	Sampler

CLAMP_NEAREST

Added in API level 11

open static fun CLAMP_NEAREST(rs: RenderScript!): Sampler!

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.

Return
`Sampler!`	Sampler

MIRRORED_REPEAT_LINEAR

Added in API level 18

open static fun MIRRORED_REPEAT_LINEAR(rs: RenderScript!): Sampler!

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.

Return
`Sampler!`	Sampler

MIRRORED_REPEAT_LINEAR_MIP_LINEAR

Added in API level 18

open static fun MIRRORED_REPEAT_LINEAR_MIP_LINEAR(rs: RenderScript!): Sampler!

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.

Return
`Sampler!`	Sampler

MIRRORED_REPEAT_NEAREST

Added in API level 18

open static fun MIRRORED_REPEAT_NEAREST(rs: RenderScript!): Sampler!

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.

Return
`Sampler!`	Sampler

WRAP_LINEAR

Added in API level 11

open static fun WRAP_LINEAR(rs: RenderScript!): Sampler!

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.

Return
`Sampler!`	Sampler

WRAP_LINEAR_MIP_LINEAR

Added in API level 11

open static fun WRAP_LINEAR_MIP_LINEAR(rs: RenderScript!): Sampler!

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.

Return
`Sampler!`	Sampler

WRAP_NEAREST

Added in API level 11

open static fun WRAP_NEAREST(rs: RenderScript!): Sampler!

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.

Return
`Sampler!`	Sampler

getAnisotropy

Added in API level 16

open fun getAnisotropy(): Float

Return
`Float`	anisotropy setting for the sampler

getMagnification

Added in API level 16

open fun getMagnification(): Sampler.Value!

Return
`Sampler.Value!`	magnification setting for the sampler

getMinification

Added in API level 16

open fun getMinification(): Sampler.Value!

Return
`Sampler.Value!`	minification setting for the sampler

getWrapS

Added in API level 16

open fun getWrapS(): Sampler.Value!

Return
`Sampler.Value!`	S wrapping mode for the sampler

getWrapT

Added in API level 16

open fun getWrapT(): Sampler.Value!

Return
`Sampler.Value!`	T wrapping mode for the sampler