lightbulb_outline Please take our October 2018 developer survey. Start survey

Sampler

public class Sampler
extends BaseObj

java.lang.Object
   ↳ 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 Allocation.USAGE_GRAPHICS_TEXTURE; using a Sampler on an Allocation that was not created with Allocation.USAGE_GRAPHICS_TEXTURE is undefined.

Summary

Nested classes

class Sampler.Builder

Builder for creating non-standard samplers. 

enum Sampler.Value

 

Public methods

static Sampler CLAMP_LINEAR(RenderScript rs)

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

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.

static Sampler CLAMP_NEAREST(RenderScript rs)

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

static Sampler MIRRORED_REPEAT_LINEAR(RenderScript rs)

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

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.

static Sampler MIRRORED_REPEAT_NEAREST(RenderScript rs)

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

static Sampler WRAP_LINEAR(RenderScript rs)

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

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.

static Sampler 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

Public methods

CLAMP_LINEAR

added in API level 11
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

added in API level 11
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

added in API level 11
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

added in API level 18
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

added in API level 18
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

added in API level 18
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

added in API level 11
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

added in API level 11
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

added in API level 11
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

added in API level 16
public float getAnisotropy ()

Returns
float anisotropy setting for the sampler

getMagnification

added in API level 16
public Sampler.Value getMagnification ()

Returns
Sampler.Value magnification setting for the sampler

getMinification

added in API level 16
public Sampler.Value getMinification ()

Returns
Sampler.Value minification setting for the sampler

getWrapS

added in API level 16
public Sampler.Value getWrapS ()

Returns
Sampler.Value S wrapping mode for the sampler

getWrapT

added in API level 16
public Sampler.Value getWrapT ()

Returns
Sampler.Value T wrapping mode for the sampler