android::RSC::Sampler Class Reference

#include <rsCppStructs.h>

Inheritance diagram for android::RSC::Sampler:

Public Member Functions
RsSamplerValue	getMinification ()
RsSamplerValue	getMagnification ()
RsSamplerValue	getWrapS ()
RsSamplerValue	getWrapT ()
float	getAnisotropy ()
Static Public Member Functions
static sp< Sampler >	create (sp< RS > rs, RsSamplerValue min, RsSamplerValue mag, RsSamplerValue wrapS, RsSamplerValue wrapT, float anisotropy)
static sp< const Sampler >	CLAMP_NEAREST (sp< RS > rs)
static sp< const Sampler >	CLAMP_LINEAR (sp< RS > rs)
static sp< const Sampler >	CLAMP_LINEAR_MIP_LINEAR (sp< RS > rs)
static sp< const Sampler >	WRAP_NEAREST (sp< RS > rs)
static sp< const Sampler >	WRAP_LINEAR (sp< RS > rs)
static sp< const Sampler >	WRAP_LINEAR_MIP_LINEAR (sp< RS > rs)
static sp< const Sampler >	MIRRORED_REPEAT_NEAREST (sp< RS > rs)
static sp< const Sampler >	MIRRORED_REPEAT_LINEAR (sp< RS > rs)
static sp< const Sampler >	MIRRORED_REPEAT_LINEAR_MIP_LINEAR (sp< RS > rs)

---

Detailed Description

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

Definition at line 1874 of file rsCppStructs.h.

---

Member Function Documentation

static sp<const Sampler> android::RSC::Sampler::CLAMP_LINEAR

(

sp< RS >

rs

)

[static]

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

static sp<const Sampler> android::RSC::Sampler::CLAMP_LINEAR_MIP_LINEAR

(

sp< RS >

rs

)

[static]

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

static sp<const Sampler> android::RSC::Sampler::CLAMP_NEAREST

(

sp< RS >

rs

)

[static]

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

static sp<Sampler> android::RSC::Sampler::create	(	sp< RS >	rs,
		RsSamplerValue	min,
		RsSamplerValue	mag,
		RsSamplerValue	wrapS,
		RsSamplerValue	wrapT,
		float	anisotropy
	)		[static]

Creates a non-standard Sampler.

Parameters:

[in]	rs	RenderScript context
[in]	min	minification
[in]	mag	magnification
[in]	wrapS	S wrapping mode
[in]	wrapT	T wrapping mode
[in]	anisotropy	anisotropy setting

float android::RSC::Sampler::getAnisotropy

(

)

Returns:

anisotropy setting for the sampler

RsSamplerValue android::RSC::Sampler::getMagnification

(

)

Returns:

magnification setting for the sampler

RsSamplerValue android::RSC::Sampler::getMinification

(

)

Returns:

minification setting for the sampler

RsSamplerValue android::RSC::Sampler::getWrapS

(

)

Returns:

S wrapping mode for the sampler

RsSamplerValue android::RSC::Sampler::getWrapT

(

)

Returns:

T wrapping mode for the sampler

static sp<const Sampler> android::RSC::Sampler::MIRRORED_REPEAT_LINEAR

(

sp< RS >

rs

)

[static]

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

static sp<const Sampler> android::RSC::Sampler::MIRRORED_REPEAT_LINEAR_MIP_LINEAR

(

sp< RS >

rs

)

[static]

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

static sp<const Sampler> android::RSC::Sampler::MIRRORED_REPEAT_NEAREST

(

sp< RS >

rs

)

[static]

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

static sp<const Sampler> android::RSC::Sampler::WRAP_LINEAR

(

sp< RS >

rs

)

[static]

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

static sp<const Sampler> android::RSC::Sampler::WRAP_LINEAR_MIP_LINEAR

(

sp< RS >

rs

)

[static]

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

static sp<const Sampler> android::RSC::Sampler::WRAP_NEAREST

(

sp< RS >

rs

)

[static]

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

---

The documentation for this class was generated from the following file:

• rsCppStructs.h