added in API level 11

Summary: Nested Classes | Methods | Inherited Methods

Element

public class Element
extends BaseObj

java.lang.Object
↳	android.renderscript.BaseObj
	↳	android.renderscript.Element

An Element represents one item within an Allocation. An Element is roughly equivalent to a C type in a RenderScript kernel. Elements may be basic or complex. Some basic elements are

A single float value (equivalent to a float in a kernel)
A four-element float vector (equivalent to a float4 in a kernel)
An unsigned 32-bit integer (equivalent to an unsigned int in a kernel)
A single signed 8-bit integer (equivalent to a char in a kernel)

A complex element is roughly equivalent to a C struct and contains a number of basic or complex Elements. From Java code, a complex element contains a list of sub-elements and names that represents a particular data structure. Structs used in RS scripts are available to Java code by using the ScriptField_structname class that is reflected from a particular script.

Basic Elements are comprised of a Element.DataType and a Element.DataKind. The DataType encodes C type information of an Element, while the DataKind encodes how that Element should be interpreted by a Sampler. Note that Allocation objects with DataKind Element.DataKind.USER cannot be used as input for a Sampler. In general, Allocation objects that are intended for use with a Sampler should use bitmap-derived Elements such as RGBA_8888(RenderScript) or android.renderscript.

Developer Guides

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

Summary

Nested classes
`class`	`Element.Builder` Builder class for producing complex elements with matching field and name pairs.
`enum`	`Element.DataKind` The special interpretation of the data if required.
`enum`	`Element.DataType` DataType represents the basic type information for a basic element.

Public methods
`static Element`	`ALLOCATION(RenderScript rs)`
`static Element`	`A_8(RenderScript rs)`
`static Element`	`BOOLEAN(RenderScript rs)` Utility function for returning an Element containing a single Boolean.
`static Element`	`ELEMENT(RenderScript rs)`
`static Element`	`F16(RenderScript rs)`
`static Element`	`F16_2(RenderScript rs)`
`static Element`	`F16_3(RenderScript rs)`
`static Element`	`F16_4(RenderScript rs)`
`static Element`	`F32(RenderScript rs)`
`static Element`	`F32_2(RenderScript rs)`
`static Element`	`F32_3(RenderScript rs)`
`static Element`	`F32_4(RenderScript rs)`
`static Element`	`F64(RenderScript rs)`
`static Element`	`F64_2(RenderScript rs)`
`static Element`	`F64_3(RenderScript rs)`
`static Element`	`F64_4(RenderScript rs)`
`static Element`	`FONT(RenderScript rs)`
`static Element`	`I16(RenderScript rs)`
`static Element`	`I16_2(RenderScript rs)`
`static Element`	`I16_3(RenderScript rs)`
`static Element`	`I16_4(RenderScript rs)`
`static Element`	`I32(RenderScript rs)`
`static Element`	`I32_2(RenderScript rs)`
`static Element`	`I32_3(RenderScript rs)`
`static Element`	`I32_4(RenderScript rs)`
`static Element`	`I64(RenderScript rs)`
`static Element`	`I64_2(RenderScript rs)`
`static Element`	`I64_3(RenderScript rs)`
`static Element`	`I64_4(RenderScript rs)`
`static Element`	`I8(RenderScript rs)` Utility function for returning an Element containing a single SIGNED_8.
`static Element`	`I8_2(RenderScript rs)`
`static Element`	`I8_3(RenderScript rs)`
`static Element`	`I8_4(RenderScript rs)`
`static Element`	`MATRIX4X4(RenderScript rs)` This method was deprecated in API level 16. use MATRIX_4X4
`static Element`	`MATRIX_2X2(RenderScript rs)`
`static Element`	`MATRIX_3X3(RenderScript rs)`
`static Element`	`MATRIX_4X4(RenderScript rs)`
`static Element`	`MESH(RenderScript rs)`
`static Element`	`PROGRAM_FRAGMENT(RenderScript rs)`
`static Element`	`PROGRAM_RASTER(RenderScript rs)`
`static Element`	`PROGRAM_STORE(RenderScript rs)`
`static Element`	`PROGRAM_VERTEX(RenderScript rs)`
`static Element`	`RGBA_4444(RenderScript rs)`
`static Element`	`RGBA_5551(RenderScript rs)`
`static Element`	`RGBA_8888(RenderScript rs)`
`static Element`	`RGB_565(RenderScript rs)`
`static Element`	`RGB_888(RenderScript rs)`
`static Element`	`SAMPLER(RenderScript rs)`
`static Element`	`SCRIPT(RenderScript rs)`
`static Element`	`TYPE(RenderScript rs)`
`static Element`	`U16(RenderScript rs)`
`static Element`	`U16_2(RenderScript rs)`
`static Element`	`U16_3(RenderScript rs)`
`static Element`	`U16_4(RenderScript rs)`
`static Element`	`U32(RenderScript rs)`
`static Element`	`U32_2(RenderScript rs)`
`static Element`	`U32_3(RenderScript rs)`
`static Element`	`U32_4(RenderScript rs)`
`static Element`	`U64(RenderScript rs)`
`static Element`	`U64_2(RenderScript rs)`
`static Element`	`U64_3(RenderScript rs)`
`static Element`	`U64_4(RenderScript rs)`
`static Element`	`U8(RenderScript rs)` Utility function for returning an Element containing a single UNSIGNED_8.
`static Element`	`U8_2(RenderScript rs)`
`static Element`	`U8_3(RenderScript rs)`
`static Element`	`U8_4(RenderScript rs)`
`static Element`	`YUV(RenderScript rs)`
`static Element`	`createPixel(RenderScript rs, Element.DataType dt, Element.DataKind dk)` Create a new pixel Element type.
`static Element`	`createVector(RenderScript rs, Element.DataType dt, int size)` Create a custom vector element of the specified DataType and vector size.
`int`	`getBytesSize()`
`Element.DataKind`	`getDataKind()`
`Element.DataType`	`getDataType()`
`Element`	`getSubElement(int index)` For complex elements, this function will return the sub-element at index
`int`	`getSubElementArraySize(int index)` For complex elements, some sub-elements could be statically sized arrays.
`int`	`getSubElementCount()` Elements could be simple, such as an int or a float, or a structure with multiple sub elements, such as a collection of floats, float2, float4.
`String`	`getSubElementName(int index)` For complex elements, this function will return the sub-element name at index
`int`	`getSubElementOffsetBytes(int index)` This function specifies the location of a sub-element within the element
`int`	`getVectorSize()` Returns the number of vector components.
`boolean`	`isCompatible(Element e)` Check if the current Element is compatible with another Element.
`boolean`	`isComplex()` Return if a element is too complex for use as a data source for a Mesh or a Program.

Inherited methods

From class


        
          android.renderscript.BaseObj

`void`	`destroy()` Frees any native resources associated with this object.
`boolean`	`equals(Object obj)` Compare the current BaseObj with another BaseObj for equality.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`String`	`getName()`
`int`	`hashCode()` Calculates the hash code value for a BaseObj.
`void`	`setName(String name)` setName assigns a name to an object.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Public methods

ALLOCATION

added in API level 11

public static Element ALLOCATION (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

A_8

added in API level 11

public static Element A_8 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

BOOLEAN

added in API level 11

public static Element BOOLEAN (RenderScript rs)

Utility function for returning an Element containing a single Boolean.

Parameters
`rs`	`RenderScript`: Context to which the element will belong.

Returns
`Element`	Element

ELEMENT

added in API level 11

public static Element ELEMENT (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

F16

added in API level 23

public static Element F16 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

F16_2

added in API level 23

public static Element F16_2 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

F16_3

added in API level 23

public static Element F16_3 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

F16_4

added in API level 23

public static Element F16_4 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

F32

added in API level 11

public static Element F32 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

F32_2

added in API level 11

public static Element F32_2 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

F32_3

added in API level 11

public static Element F32_3 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

F32_4

added in API level 11

public static Element F32_4 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

F64

added in API level 11

public static Element F64 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

F64_2

added in API level 14

public static Element F64_2 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

F64_3

added in API level 14

public static Element F64_3 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

F64_4

added in API level 14

public static Element F64_4 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

FONT

added in API level 16

public static Element FONT (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

I16

added in API level 11

public static Element I16 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

I16_2

added in API level 14

public static Element I16_2 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

I16_3

added in API level 14

public static Element I16_3 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

I16_4

added in API level 14

public static Element I16_4 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

I32

added in API level 11

public static Element I32 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

I32_2

added in API level 14

public static Element I32_2 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

I32_3

added in API level 14

public static Element I32_3 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

I32_4

added in API level 14

public static Element I32_4 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

I64

added in API level 11

public static Element I64 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

I64_2

added in API level 14

public static Element I64_2 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

I64_3

added in API level 14

public static Element I64_3 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

I64_4

added in API level 14

public static Element I64_4 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

I8

added in API level 11

public static Element I8 (RenderScript rs)

Utility function for returning an Element containing a single SIGNED_8.

Parameters
`rs`	`RenderScript`: Context to which the element will belong.

Returns
`Element`	Element

I8_2

added in API level 14

public static Element I8_2 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

I8_3

added in API level 14

public static Element I8_3 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

I8_4

added in API level 14

public static Element I8_4 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

MATRIX4X4

added in API level 11

public static Element MATRIX4X4 (RenderScript rs)

This method was deprecated in API level 16.
use MATRIX_4X4

Parameters
`rs`	`RenderScript`

Returns
`Element`

MATRIX_2X2

added in API level 11

public static Element MATRIX_2X2 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

MATRIX_3X3

added in API level 11

public static Element MATRIX_3X3 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

MATRIX_4X4

added in API level 11

public static Element MATRIX_4X4 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

MESH

added in API level 11

public static Element MESH (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

PROGRAM_FRAGMENT

added in API level 11

public static Element PROGRAM_FRAGMENT (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

PROGRAM_RASTER

added in API level 11

public static Element PROGRAM_RASTER (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

PROGRAM_STORE

added in API level 11

public static Element PROGRAM_STORE (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

PROGRAM_VERTEX

added in API level 11

public static Element PROGRAM_VERTEX (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

RGBA_4444

added in API level 11

public static Element RGBA_4444 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

RGBA_5551

added in API level 11

public static Element RGBA_5551 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

RGBA_8888

added in API level 11

public static Element RGBA_8888 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

RGB_565

added in API level 11

public static Element RGB_565 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

RGB_888

added in API level 11

public static Element RGB_888 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

SAMPLER

added in API level 11

public static Element SAMPLER (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

SCRIPT

added in API level 11

public static Element SCRIPT (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

TYPE

added in API level 11

public static Element TYPE (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

U16

added in API level 11

public static Element U16 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

U16_2

added in API level 14

public static Element U16_2 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

U16_3

added in API level 14

public static Element U16_3 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

U16_4

added in API level 14

public static Element U16_4 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

U32

added in API level 11

public static Element U32 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

U32_2

added in API level 14

public static Element U32_2 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

U32_3

added in API level 14

public static Element U32_3 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

U32_4

added in API level 14

public static Element U32_4 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

U64

added in API level 11

public static Element U64 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

U64_2

added in API level 14

public static Element U64_2 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

U64_3

added in API level 14

public static Element U64_3 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

U64_4

added in API level 14

public static Element U64_4 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

U8

added in API level 11

public static Element U8 (RenderScript rs)

Utility function for returning an Element containing a single UNSIGNED_8.

Parameters
`rs`	`RenderScript`: Context to which the element will belong.

Returns
`Element`	Element

U8_2

added in API level 14

public static Element U8_2 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

U8_3

added in API level 14

public static Element U8_3 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

U8_4

added in API level 11

public static Element U8_4 (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

YUV

added in API level 19

public static Element YUV (RenderScript rs)

Parameters
`rs`	`RenderScript`

Returns
`Element`

createPixel

added in API level 11

public static Element createPixel (RenderScript rs, 
                Element.DataType dt, 
                Element.DataKind dk)

Create a new pixel Element type. A matching DataType and DataKind must be provided. The DataType and DataKind must contain the same number of components. Vector size will be set to 1.

Parameters
`rs`	`RenderScript`: The context associated with the new Element.
`dt`	`Element.DataType`: The DataType for the new element.
`dk`	`Element.DataKind`: The DataKind to specify the mapping of each component in the DataType.

Returns
`Element`	Element

createVector

added in API level 11

public static Element createVector (RenderScript rs, 
                Element.DataType dt, 
                int size)

Create a custom vector element of the specified DataType and vector size. DataKind will be set to USER. Only primitive types (FLOAT_32, FLOAT_64, SIGNED_8, SIGNED_16, SIGNED_32, SIGNED_64, UNSIGNED_8, UNSIGNED_16, UNSIGNED_32, UNSIGNED_64, BOOLEAN) are supported.

Parameters
`rs`	`RenderScript`: The context associated with the new Element.
`dt`	`Element.DataType`: The DataType for the new Element.
`size`	`int`: Vector size for the new Element. Range 2-4 inclusive supported.

Returns
`Element`	Element

getBytesSize

added in API level 16

public int getBytesSize ()

Returns
`int`	element size in bytes

getDataKind

added in API level 16

public Element.DataKind getDataKind ()

Returns
`Element.DataKind`	element data kind

getDataType

added in API level 16

public Element.DataType getDataType ()

Returns
`Element.DataType`	element data type

getSubElement

added in API level 16

public Element getSubElement (int index)

For complex elements, this function will return the sub-element at index

Parameters
`index`	`int`: index of the sub-element to return

Returns
`Element`	sub-element in this element at given index

getSubElementArraySize

added in API level 16

public int getSubElementArraySize (int index)

For complex elements, some sub-elements could be statically sized arrays. This function will return the array size for sub-element at index

Parameters
`index`	`int`: index of the sub-element

Returns
`int`	array size of sub-element in this element at given index

getSubElementCount

added in API level 16

public int getSubElementCount ()

Elements could be simple, such as an int or a float, or a structure with multiple sub elements, such as a collection of floats, float2, float4. This function returns zero for simple elements or the number of sub-elements otherwise.

Returns
`int`	number of sub-elements in this element

getSubElementName

added in API level 16

public String getSubElementName (int index)

For complex elements, this function will return the sub-element name at index

Parameters
`index`	`int`: index of the sub-element

Returns
`String`	sub-element in this element at given index

getSubElementOffsetBytes

added in API level 16

public int getSubElementOffsetBytes (int index)

This function specifies the location of a sub-element within the element

Parameters
`index`	`int`: index of the sub-element

Returns
`int`	offset in bytes of sub-element in this element at given index

getVectorSize

added in API level 16

public int getVectorSize ()

Returns the number of vector components. 2 for float2, 4 for float4, etc.

Returns
`int`	element vector size

isCompatible

added in API level 14

public boolean isCompatible (Element e)

Check if the current Element is compatible with another Element. Primitive Elements are compatible if they share the same underlying size and type (i.e. U8 is compatible with A_8). User-defined Elements must be equal in order to be compatible. This requires strict name equivalence for all sub-Elements (in addition to structural equivalence).

Parameters
`e`	`Element`: The Element to check compatibility with.

Returns
`boolean`	boolean true if the Elements are compatible, otherwise false.

isComplex

added in API level 11

public boolean isComplex ()

Return if a element is too complex for use as a data source for a Mesh or a Program.

Returns
`boolean`	boolean

Interfaces
- Allocation.OnBufferAvailableListener
Classes
Enums
Exceptions

Element

Developer Guides

Summary

Nested classes

Public methods

Inherited methods

Public methods

ALLOCATION

A_8

BOOLEAN

ELEMENT

F16

F16_2

F16_3

F16_4

F32

F32_2

F32_3

F32_4

F64

F64_2

F64_3

F64_4

FONT

I16

I16_2

I16_3

I16_4

I32

I32_2

I32_3

I32_4

I64

I64_2

I64_3

I64_4

I8

I8_2

I8_3

I8_4

MATRIX4X4

MATRIX_2X2

MATRIX_3X3

MATRIX_4X4

MESH

PROGRAM_FRAGMENT

PROGRAM_RASTER

PROGRAM_STORE

PROGRAM_VERTEX

RGBA_4444

RGBA_5551

RGBA_8888

RGB_565

RGB_888

SAMPLER

SCRIPT

TYPE

U16

U16_2

U16_3

U16_4

U32

U32_2

U32_3

U32_4

U64

U64_2

U64_3

U64_4

U8

U8_2

U8_3

U8_4

YUV

createPixel

createVector

getBytesSize

getDataKind

getDataType

getSubElement