to top
Android APIs
public class

Sampler

extends BaseObj
java.lang.Object
   ↳ android.renderscript.BaseObj
     ↳ android.renderscript.Sampler

Class Overview

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 USAGE_GRAPHICS_TEXTURE; using a Sampler on an Allocation that was not created with 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()
[Expand]
Inherited Methods
From class android.renderscript.BaseObj
From class java.lang.Object

Public Methods

public static Sampler CLAMP_LINEAR (RenderScript rs)

Added in API level 11

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

Parameters
rs Context to which the sampler will belong.
Returns
  • Sampler

public static Sampler CLAMP_LINEAR_MIP_LINEAR (RenderScript rs)

Added in API level 11

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

Parameters
rs Context to which the sampler will belong.
Returns
  • Sampler

public static Sampler CLAMP_NEAREST (RenderScript rs)

Added in API level 11

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

Parameters
rs Context to which the sampler will belong.
Returns
  • Sampler

public static Sampler MIRRORED_REPEAT_LINEAR (RenderScript rs)

Added in API level 18

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

Parameters
rs Context to which the sampler will belong.
Returns
  • Sampler

public static Sampler MIRRORED_REPEAT_LINEAR_MIP_LINEAR (RenderScript rs)

Added in API level 18

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

Parameters
rs Context to which the sampler will belong.
Returns
  • Sampler

public static Sampler MIRRORED_REPEAT_NEAREST (RenderScript rs)

Added in API level 18

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

Parameters
rs Context to which the sampler will belong.
Returns
  • Sampler

public static Sampler WRAP_LINEAR (RenderScript rs)

Added in API level 11

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

Parameters
rs Context to which the sampler will belong.
Returns
  • Sampler

public static Sampler WRAP_LINEAR_MIP_LINEAR (RenderScript rs)

Added in API level 11

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

Parameters
rs Context to which the sampler will belong.
Returns
  • Sampler

public static Sampler WRAP_NEAREST (RenderScript rs)

Added in API level 11

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

Parameters
rs Context to which the sampler will belong.
Returns
  • Sampler

public float getAnisotropy ()

Added in API level 16

Returns
  • anisotropy setting for the sampler

public Sampler.Value getMagnification ()

Added in API level 16

Returns
  • magnification setting for the sampler

public Sampler.Value getMinification ()

Added in API level 16

Returns
  • minification setting for the sampler

public Sampler.Value getWrapS ()

Added in API level 16

Returns
  • S wrapping mode for the sampler

public Sampler.Value getWrapT ()

Added in API level 16

Returns
  • T wrapping mode for the sampler