Element  |  API reference  |  Android Developers (original) (raw)

public class Element
` extends [BaseObj](/reference/android/renderscript/BaseObj) `

This class was deprecated in API level 31.
Renderscript has been deprecated in API level 31. Please refer to the migration guide for the proposed alternatives.

An Element represents one item within an [Allocation](/reference/android/renderscript/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](/reference/android/renderscript/Element.DataType) and a [Element.DataKind](/reference/android/renderscript/Element.DataKind). The DataType encodes C type information of an Element, while the DataKind encodes how that Element should be interpreted by a [Sampler](/reference/android/renderscript/Sampler). Note that [Allocation](/reference/android/renderscript/Allocation) objects with DataKind [Element.DataKind.USER](/reference/android/renderscript/Element.DataKind#USER) cannot be used as input for a[Sampler](/reference/android/renderscript/Sampler). In general, [Allocation](/reference/android/renderscript/Allocation) objects that are intended for use with a[Sampler](/reference/android/renderscript/Sampler) should use bitmap-derived Elements such as [RGBA_8888(RenderScript)](/reference/android/renderscript/Element#RGBA%5F8888%28android.renderscript.RenderScript%29) or [android.renderscript](/reference/android/renderscript/package-summary).

Developer Guides

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

Summary

Public methods

BOOLEAN

public static Element BOOLEAN (RenderScript rs)

Utility function for returning an Element containing a single Boolean.

I8

public static Element I8 (RenderScript rs)

Utility function for returning an Element containing a single SIGNED_8.

MATRIX4X4

public static Element MATRIX4X4 (RenderScript rs)

This method was deprecated in API level 16.
use MATRIX_4X4

U8

public static Element U8 (RenderScript rs)

Utility function for returning an Element containing a single UNSIGNED_8.

createPixel

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.

createVector

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.

getBytesSize

public int getBytesSize ()

getSubElement

public Element getSubElement (int index)

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

getSubElementArraySize

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

getSubElementCount

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.

getSubElementName

public String getSubElementName (int index)

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

getSubElementOffsetBytes

public int getSubElementOffsetBytes (int index)

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

getVectorSize

public int getVectorSize ()

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

isCompatible

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).

isComplex

public boolean isComplex ()

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