Google is committed to advancing racial equity for Black communities. See how.
Added in API level 11

Element

open class Element : BaseObj
kotlin.Any
   ↳ android.renderscript.BaseObj
   ↳ android.renderscript.Element

An Element represents one item within an . 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 and a . The DataType encodes C type information of an Element, while the DataKind encodes how that Element should be interpreted by a android.renderscript.Sampler. Note that objects with DataKind cannot be used as input for a android.renderscript.Sampler. In general, objects that are intended for use with a android.renderscript.Sampler should use bitmap-derived Elements such as android.renderscript.Element#RGBA_8888 or android.renderscript#Element.A_8.

Summary

Nested classes
open

Builder class for producing complex elements with matching field and name pairs.

The special interpretation of the data if required.

DataType represents the basic type information for a basic element.
Public methods
open static Element!

open static Element!

open static Element!

Utility function for returning an Element containing a single Boolean.
open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

Utility function for returning an Element containing a single SIGNED_8.
open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

Utility function for returning an Element containing a single UNSIGNED_8.
open static Element!

open static Element!

open static Element!

open static Element!

open static Element!

Create a new pixel Element type.
open static Element!

Create a custom vector element of the specified DataType and vector size.
open Int

open Element.DataKind!

open Element.DataType!

open Element!

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

For complex elements, some sub-elements could be statically sized arrays.
open Int

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.
open String!

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

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

Returns the number of vector components.
open Boolean

Check if the current Element is compatible with another Element.
open Boolean

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

Public methods

ALLOCATION

Added in API level 11
open static fun ALLOCATION(rs: RenderScript!): Element!

A_8

Added in API level 11
open static fun A_8(rs: RenderScript!): Element!

BOOLEAN

Added in API level 11
open static fun BOOLEAN(rs: RenderScript!): Element!

Utility function for returning an Element containing a single Boolean.

Parameters
rs RenderScript!: Context to which the element will belong.
Return
Element! Element

ELEMENT

Added in API level 11
open static fun ELEMENT(rs: RenderScript!): Element!

F16

Added in API level 23
open static fun F16(rs: RenderScript!): Element!

F16_2

Added in API level 23
open static fun F16_2(rs: RenderScript!): Element!

F16_3

Added in API level 23
open static fun F16_3(rs: RenderScript!): Element!

F16_4

Added in API level 23
open static fun F16_4(rs: RenderScript!): Element!

F32

Added in API level 11
open static fun F32(rs: RenderScript!): Element!

F32_2

Added in API level 11
open static fun F32_2(rs: RenderScript!): Element!

F32_3

Added in API level 11
open static fun F32_3(rs: RenderScript!): Element!

F32_4

Added in API level 11
open static fun F32_4(rs: RenderScript!): Element!

F64

Added in API level 11
open static fun F64(rs: RenderScript!): Element!

F64_2

Added in API level 14
open static fun F64_2(rs: RenderScript!): Element!

F64_3

Added in API level 14
open static fun F64_3(rs: RenderScript!): Element!

F64_4

Added in API level 14
open static fun F64_4(rs: RenderScript!): Element!

FONT

Added in API level 16
open static fun FONT(rs: RenderScript!): Element!

I16

Added in API level 11
open static fun I16(rs: RenderScript!): Element!

I16_2

Added in API level 14
open static fun I16_2(rs: RenderScript!): Element!

I16_3

Added in API level 14
open static fun I16_3(rs: RenderScript!): Element!

I16_4

Added in API level 14
open static fun I16_4(rs: RenderScript!): Element!

I32

Added in API level 11
open static fun I32(rs: RenderScript!): Element!

I32_2

Added in API level 14
open static fun I32_2(rs: RenderScript!): Element!

I32_3

Added in API level 14
open static fun I32_3(rs: RenderScript!): Element!

I32_4

Added in API level 14
open static fun I32_4(rs: RenderScript!): Element!

I64

Added in API level 11
open static fun I64(rs: RenderScript!): Element!

I64_2

Added in API level 14
open static fun I64_2(rs: RenderScript!): Element!

I64_3

Added in API level 14
open static fun I64_3(rs: RenderScript!): Element!

I64_4

Added in API level 14
open static fun I64_4(rs: RenderScript!): Element!

I8

Added in API level 11
open static fun I8(rs: RenderScript!): Element!

Utility function for returning an Element containing a single SIGNED_8.

Parameters
rs RenderScript!: Context to which the element will belong.
Return
Element! Element

I8_2

Added in API level 14
open static fun I8_2(rs: RenderScript!): Element!

I8_3

Added in API level 14
open static fun I8_3(rs: RenderScript!): Element!

I8_4

Added in API level 14
open static fun I8_4(rs: RenderScript!): Element!

MATRIX4X4

Added in API level 11
Deprecated in API level 16
open static fun MATRIX4X4(rs: RenderScript!): Element!

Deprecated: use MATRIX_4X4

MATRIX_2X2

Added in API level 11
open static fun MATRIX_2X2(rs: RenderScript!): Element!

MATRIX_3X3

Added in API level 11
open static fun MATRIX_3X3(rs: RenderScript!): Element!

MATRIX_4X4

Added in API level 11
open static fun MATRIX_4X4(rs: RenderScript!): Element!

MESH

Added in API level 11
open static fun MESH(rs: RenderScript!): Element!

PROGRAM_FRAGMENT

Added in API level 11
open static fun PROGRAM_FRAGMENT(rs: RenderScript!): Element!

PROGRAM_RASTER

Added in API level 11
open static fun PROGRAM_RASTER(rs: RenderScript!): Element!

PROGRAM_STORE

Added in API level 11
open static fun PROGRAM_STORE(rs: RenderScript!): Element!

PROGRAM_VERTEX

Added in API level 11
open static fun PROGRAM_VERTEX(rs: RenderScript!): Element!

RGBA_4444

Added in API level 11
open static fun RGBA_4444(rs: RenderScript!): Element!

RGBA_5551

Added in API level 11
open static fun RGBA_5551(rs: RenderScript!): Element!

RGBA_8888

Added in API level 11
open static fun RGBA_8888(rs: RenderScript!): Element!

RGB_565

Added in API level 11
open static fun RGB_565(rs: RenderScript!): Element!

RGB_888

Added in API level 11
open static fun RGB_888(rs: RenderScript!): Element!

SAMPLER

Added in API level 11
open static fun SAMPLER(rs: RenderScript!): Element!

SCRIPT

Added in API level 11
open static fun SCRIPT(rs: RenderScript!): Element!

TYPE

Added in API level 11
open static fun TYPE(rs: RenderScript!): Element!

U16

Added in API level 11
open static fun U16(rs: RenderScript!): Element!

U16_2

Added in API level 14
open static fun U16_2(rs: RenderScript!): Element!

U16_3

Added in API level 14
open static fun U16_3(rs: RenderScript!): Element!

U16_4

Added in API level 14
open static fun U16_4(rs: RenderScript!): Element!

U32

Added in API level 11
open static fun U32(rs: RenderScript!): Element!

U32_2

Added in API level 14
open static fun U32_2(rs: RenderScript!): Element!

U32_3

Added in API level 14
open static fun U32_3(rs: RenderScript!): Element!

U32_4

Added in API level 14
open static fun U32_4(rs: RenderScript!): Element!

U64

Added in API level 11
open static fun U64(rs: RenderScript!): Element!

U64_2

Added in API level 14
open static fun U64_2(rs: RenderScript!): Element!

U64_3

Added in API level 14
open static fun U64_3(rs: RenderScript!): Element!

U64_4

Added in API level 14
open static fun U64_4(rs: RenderScript!): Element!

U8

Added in API level 11
open static fun U8(rs: RenderScript!): Element!

Utility function for returning an Element containing a single UNSIGNED_8.

Parameters
rs RenderScript!: Context to which the element will belong.
Return
Element! Element

U8_2

Added in API level 14
open static fun U8_2(rs: RenderScript!): Element!

U8_3

Added in API level 14
open static fun U8_3(rs: RenderScript!): Element!

U8_4

Added in API level 11
open static fun U8_4(rs: RenderScript!): Element!

YUV

Added in API level 19
open static fun YUV(rs: RenderScript!): Element!

createPixel

Added in API level 11
open static fun createPixel(
    rs: RenderScript!, 
    dt: Element.DataType!, 
    dk: Element.DataKind!
): Element!

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.
Return
Element! Element

createVector

Added in API level 11
open static fun createVector(
    rs: RenderScript!, 
    dt: Element.DataType!, 
    size: Int
): Element!

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.
Return
Element! Element

getBytesSize

Added in API level 16
open fun getBytesSize(): Int
Return
Int element size in bytes

getDataKind

Added in API level 16
open fun getDataKind(): Element.DataKind!
Return
Element.DataKind! element data kind

getDataType

Added in API level 16
open fun getDataType(): Element.DataType!
Return
Element.DataType! element data type

getSubElement

Added in API level 16
open fun getSubElement(index: Int): Element!

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

Parameters
index Int: index of the sub-element to return
Return
Element! sub-element in this element at given index

getSubElementArraySize

Added in API level 16
open fun getSubElementArraySize(index: Int): Int

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
Return
Int array size of sub-element in this element at given index

getSubElementCount

Added in API level 16
open fun getSubElementCount(): Int

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.

Return
Int number of sub-elements in this element

getSubElementName

Added in API level 16
open fun getSubElementName(index: Int): String!

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

Parameters
index Int: index of the sub-element
Return
String! sub-element in this element at given index

getSubElementOffsetBytes

Added in API level 16
open fun getSubElementOffsetBytes(index: Int): Int

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

Parameters
index Int: index of the sub-element
Return
Int offset in bytes of sub-element in this element at given index

getVectorSize

Added in API level 16
open fun getVectorSize(): Int

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

Return
Int element vector size

isCompatible

Added in API level 14
open fun isCompatible(e: Element!): Boolean

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.
Return
Boolean boolean true if the Elements are compatible, otherwise false.

isComplex

Added in API level 11
open fun isComplex(): Boolean

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

Return
Boolean boolean