Data Structures | Public Member Functions | Static Public Member Functions
android::RSC::Type Class Reference

#include <rsCppStructs.h>

Inheritance diagram for android::RSC::Type:
android::RSC::BaseObj

Data Structures

class  Builder

Public Member Functions

RSYuvFormat getYuvFormat () const
sp< const Element > getElement () const
uint32_t getX () const
uint32_t getY () const
uint32_t getZ () const
bool hasMipmaps () const
bool hasFaces () const
size_t getCount () const
size_t getSizeBytes () const

Static Public Member Functions

static sp< const Type > create (sp< RS > rs, sp< const Element > e, uint32_t dimX, uint32_t dimY, uint32_t dimZ)

Detailed Description

A Type describes the Element and dimensions used for an Allocation or a parallel operation.

A Type always includes an Element and an X dimension. A Type may be multidimensional, up to three dimensions. A nonzero value in the Y or Z dimensions indicates that the dimension is present. Note that a Type with only a given X dimension and a Type with the same X dimension but Y = 1 are not equivalent.

A Type also supports inclusion of level of detail (LOD) or cube map faces. LOD and cube map faces are booleans to indicate present or not present.

A Type also supports YUV format information to support an Allocation in a YUV format. The YUV formats supported are YV12 and NV21.

Definition at line 1183 of file rsCppStructs.h.

Member Function Documentation

static sp<const Type> android::RSC::Type::create ( sp< RS >  rs,
sp< const Element >  e,
uint32_t  dimX,
uint32_t  dimY,
uint32_t  dimZ 
) [static]

Creates a new Type with the given Element and dimensions.

Parameters:
[in]rsRenderScript context
[in]eElement
[in]dimXX dimension
[in]dimYY dimension
[in]dimZZ dimension
Returns:
new Type
size_t android::RSC::Type::getCount ( ) const [inline]

Returns number of accessible Elements in the Allocation

Returns:
number of accessible Elements in the Allocation

Definition at line 1263 of file rsCppStructs.h.

sp<const Element> android::RSC::Type::getElement ( ) const [inline]

Returns the Element of the Allocation.

Returns:
YUV format of the Allocation

Definition at line 1215 of file rsCppStructs.h.

size_t android::RSC::Type::getSizeBytes ( ) const [inline]

Returns size in bytes of all Elements in the Allocation

Returns:
size in bytes of all Elements in the Allocation

Definition at line 1271 of file rsCppStructs.h.

uint32_t android::RSC::Type::getX ( ) const [inline]

Returns the X dimension of the Allocation.

Returns:
X dimension of the allocation

Definition at line 1223 of file rsCppStructs.h.

uint32_t android::RSC::Type::getY ( ) const [inline]

Returns the Y dimension of the Allocation.

Returns:
Y dimension of the allocation

Definition at line 1231 of file rsCppStructs.h.

RSYuvFormat android::RSC::Type::getYuvFormat ( ) const [inline]

Returns the YUV format.

Returns:
YUV format of the Allocation

Definition at line 1207 of file rsCppStructs.h.

uint32_t android::RSC::Type::getZ ( ) const [inline]

Returns the Z dimension of the Allocation.

Returns:
Z dimension of the allocation

Definition at line 1239 of file rsCppStructs.h.

bool android::RSC::Type::hasFaces ( ) const [inline]

Returns true if the Allocation is a cube map

Returns:
true if the Allocation is a cube map

Definition at line 1255 of file rsCppStructs.h.

bool android::RSC::Type::hasMipmaps ( ) const [inline]

Returns true if the Allocation has mipmaps.

Returns:
true if the Allocation has mipmaps

Definition at line 1247 of file rsCppStructs.h.

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