Android APIs
public class

Type

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

Class Overview

A Type describes the Element and dimensions used for an Allocation or a parallel operation. Types are created through Type.Builder.

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, NV21, and YUV_420_888

Developer Guides

For more information about creating an application that uses RenderScript, read the RenderScript developer guide.

Summary

Nested Classes
class Type.Builder Builder class for Type. 
enum Type.CubemapFace  
Public Methods
static Type createX(RenderScript rs, Element e, int dimX)
Utility function for creating basic 1D types.
static Type createXY(RenderScript rs, Element e, int dimX, int dimY)
Utility function for creating basic 2D types.
static Type createXYZ(RenderScript rs, Element e, int dimX, int dimY, int dimZ)
Utility function for creating basic 3D types.
int getCount()
Return the total number of accessable cells in the Type.
Element getElement()
Return the element associated with this Type.
int getX()
Return the value of the X dimension.
int getY()
Return the value of the Y dimension or 0 for a 1D allocation.
int getYuv()
Get the YUV format
int getZ()
Return the value of the Z dimension or 0 for a 1D or 2D allocation.
boolean hasFaces()
Return if the Type is a cube map.
boolean hasMipmaps()
Return if the Type has a mipmap chain.
[Expand]
Inherited Methods
From class android.renderscript.BaseObj
From class java.lang.Object

Public Methods

public static Type createX (RenderScript rs, Element e, int dimX)

Added in API level 21

Utility function for creating basic 1D types. The type is created without mipmaps enabled.

Parameters
rs RenderScript: The RenderScript context
e Element: The Element for the Type
dimX int: The X dimension, must be > 0
Returns
Type Type

public static Type createXY (RenderScript rs, Element e, int dimX, int dimY)

Added in API level 21

Utility function for creating basic 2D types. The type is created without mipmaps or cubemaps.

Parameters
rs RenderScript: The RenderScript context
e Element: The Element for the Type
dimX int: The X dimension, must be > 0
dimY int: The Y dimension, must be > 0
Returns
Type Type

public static Type createXYZ (RenderScript rs, Element e, int dimX, int dimY, int dimZ)

Added in API level 21

Utility function for creating basic 3D types. The type is created without mipmaps.

Parameters
rs RenderScript: The RenderScript context
e Element: The Element for the Type
dimX int: The X dimension, must be > 0
dimY int: The Y dimension, must be > 0
dimZ int: The Z dimension, must be > 0
Returns
Type Type

public int getCount ()

Added in API level 11

Return the total number of accessable cells in the Type.

Returns
int int

public Element getElement ()

Added in API level 11

Return the element associated with this Type.

Returns
Element Element

public int getX ()

Added in API level 11

Return the value of the X dimension.

Returns
int int

public int getY ()

Added in API level 11

Return the value of the Y dimension or 0 for a 1D allocation.

Returns
int int

public int getYuv ()

Added in API level 18

Get the YUV format

Returns
int int

public int getZ ()

Added in API level 11

Return the value of the Z dimension or 0 for a 1D or 2D allocation.

Returns
int int

public boolean hasFaces ()

Added in API level 11

Return if the Type is a cube map.

Returns
boolean boolean

public boolean hasMipmaps ()

Added in API level 11

Return if the Type has a mipmap chain.

Returns
boolean boolean