Skip to content

Most visited

Recently visited

navigation

RenderScript Object Types

Overview

The types below are used to manipulate RenderScript objects like allocations, samplers, elements, and scripts. Most of these object are created using the Java RenderScript APIs.

Summary

Types
rs_allocation Handle to an allocation
rs_allocation_cubemap_face Enum for selecting cube map faces
rs_allocation_usage_type Bitfield to specify how an allocation is used
rs_data_kind Element data kind
rs_data_type Element basic data type
rs_element Handle to an element
rs_sampler Handle to a Sampler
rs_sampler_value Sampler wrap T value
rs_script Handle to a Script
rs_type Handle to a Type
rs_yuv_format YUV format

Types

rs_allocation : Handle to an allocation

An opaque handle to a RenderScript allocation.

See android.renderscript.Allocation.

rs_allocation_cubemap_face : Enum for selecting cube map faces

An enum with the following values:      Added in API level 14

RS_ALLOCATION_CUBEMAP_FACE_POSITIVE_X = 0
RS_ALLOCATION_CUBEMAP_FACE_NEGATIVE_X = 1
RS_ALLOCATION_CUBEMAP_FACE_POSITIVE_Y = 2
RS_ALLOCATION_CUBEMAP_FACE_NEGATIVE_Y = 3
RS_ALLOCATION_CUBEMAP_FACE_POSITIVE_Z = 4
RS_ALLOCATION_CUBEMAP_FACE_NEGATIVE_Z = 5

An enum used to specify one the six faces of a cubemap.

rs_allocation_usage_type : Bitfield to specify how an allocation is used

An enum with the following values:      Added in API level 14

RS_ALLOCATION_USAGE_SCRIPT = 0x0001Allocation is bound to and accessed by scripts.
RS_ALLOCATION_USAGE_GRAPHICS_TEXTURE = 0x0002Allocation is used as a texture source.
RS_ALLOCATION_USAGE_GRAPHICS_VERTEX = 0x0004Deprecated.
RS_ALLOCATION_USAGE_GRAPHICS_CONSTANTS = 0x0008Deprecated.
RS_ALLOCATION_USAGE_GRAPHICS_RENDER_TARGET = 0x0010Deprecated.
RS_ALLOCATION_USAGE_IO_INPUT = 0x0020Allocation is used as a Surface consumer.
RS_ALLOCATION_USAGE_IO_OUTPUT = 0x0040Allocation is used as a Surface producer.
RS_ALLOCATION_USAGE_SHARED = 0x0080Allocation's backing store is shared with another object (usually a Bitmap). Copying to or from the original source Bitmap will cause a synchronization rather than a full copy.

These values are ORed together to specify which usages or memory spaces are relevant to an allocation or an operation on an allocation.

rs_data_kind : Element data kind

An enum with the following values:      Added in API level 16

RS_KIND_USER = 0No special interpretation.
RS_KIND_PIXEL_L = 7Luminance.
RS_KIND_PIXEL_A = 8Alpha.
RS_KIND_PIXEL_LA = 9Luminance and Alpha.
RS_KIND_PIXEL_RGB = 10Red, Green, Blue.
RS_KIND_PIXEL_RGBA = 11Red, Green, Blue, and Alpha.
RS_KIND_PIXEL_DEPTH = 12Depth for a depth texture.
RS_KIND_PIXEL_YUV = 13Luminance and chrominance.
RS_KIND_INVALID = 100

This enumeration is primarly useful for graphical data. It provides additional information to help interpret the rs_data_type.

RS_KIND_USER indicates no special interpretation is expected.

The RS_KIND_PIXEL_* values are used in conjunction with the standard data types for representing texture formats.

See the Element.createPixel() method.

rs_data_type : Element basic data type

An enum with the following values:      Added in API level 16

RS_TYPE_NONE = 0Element is a complex type, i.e. a struct.
RS_TYPE_FLOAT_16 = 1A 16 bit floating point value.
RS_TYPE_FLOAT_32 = 2A 32 bit floating point value.
RS_TYPE_FLOAT_64 = 3A 64 bit floating point value.
RS_TYPE_SIGNED_8 = 4An 8 bit signed integer.
RS_TYPE_SIGNED_16 = 5A 16 bit signed integer.
RS_TYPE_SIGNED_32 = 6A 32 bit signed integer.
RS_TYPE_SIGNED_64 = 7A 64 bit signed integer.
RS_TYPE_UNSIGNED_8 = 8An 8 bit unsigned integer.
RS_TYPE_UNSIGNED_16 = 9A 16 bit unsigned integer.
RS_TYPE_UNSIGNED_32 = 10A 32 bit unsigned integer.
RS_TYPE_UNSIGNED_64 = 11A 64 bit unsigned integer.
RS_TYPE_BOOLEAN = 120 or 1 (false or true) stored in an 8 bit container.
RS_TYPE_UNSIGNED_5_6_5 = 13A 16 bit unsigned integer packing graphical data in 5, 6, and 5 bit sections.
RS_TYPE_UNSIGNED_5_5_5_1 = 14A 16 bit unsigned integer packing graphical data in 5, 5, 5, and 1 bit sections.
RS_TYPE_UNSIGNED_4_4_4_4 = 15A 16 bit unsigned integer packing graphical data in 4, 4, 4, and 4 bit sections.
RS_TYPE_MATRIX_4X4 = 16A 4x4 matrix of 32 bit floats, aligned on a 32 bit boundary.
RS_TYPE_MATRIX_3X3 = 17A 3x3 matrix of 32 bit floats, aligned on a 32 bit boundary.
RS_TYPE_MATRIX_2X2 = 18A 2x2 matrix of 32 bit floats, aligned on a 32 bit boundary.
RS_TYPE_ELEMENT = 1000A handle to an Element.
RS_TYPE_TYPE = 1001A handle to a Type.
RS_TYPE_ALLOCATION = 1002A handle to an Allocation.
RS_TYPE_SAMPLER = 1003A handle to a Sampler.
RS_TYPE_SCRIPT = 1004A handle to a Script.
RS_TYPE_MESH = 1005Deprecated.
RS_TYPE_PROGRAM_FRAGMENT = 1006Deprecated.
RS_TYPE_PROGRAM_VERTEX = 1007Deprecated.
RS_TYPE_PROGRAM_RASTER = 1008Deprecated.
RS_TYPE_PROGRAM_STORE = 1009Deprecated.
RS_TYPE_FONT = 1010Deprecated.
RS_TYPE_INVALID = 10000

rs_data_type is used to encode the type information of a basic element.

RS_TYPE_UNSIGNED_5_6_5, RS_TYPE_UNSIGNED_5_5_5_1, RS_TYPE_UNSIGNED_4_4_4_4 are for packed graphical data formats and represent vectors with per vector member sizes which are treated as a single unit for packing and alignment purposes.

rs_element : Handle to an element

An opaque handle to a RenderScript element.

See android.renderscript.Element.

rs_sampler : Handle to a Sampler

An opaque handle to a RenderScript sampler object.

See android.renderscript.Sampler.

rs_sampler_value : Sampler wrap T value

An enum with the following values:      Added in API level 16

RS_SAMPLER_NEAREST = 0
RS_SAMPLER_LINEAR = 1
RS_SAMPLER_LINEAR_MIP_LINEAR = 2
RS_SAMPLER_WRAP = 3
RS_SAMPLER_CLAMP = 4
RS_SAMPLER_LINEAR_MIP_NEAREST = 5
RS_SAMPLER_MIRRORED_REPEAT = 6
RS_SAMPLER_INVALID = 100

rs_script : Handle to a Script

An opaque handle to a RenderScript script object.

See android.renderscript.ScriptC.

rs_type : Handle to a Type

An opaque handle to a RenderScript type.

See android.renderscript.Type.

rs_yuv_format : YUV format

An enum with the following values:      Added in API level 24

RS_YUV_NONE = 0
RS_YUV_YV12 = 0x32315659
RS_YUV_NV21 = 0x11
RS_YUV_420_888 = 0x23

Android YUV formats that can be associated with a RenderScript Type.

See android.graphics.ImageFormat for a description of each format.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience.
(Sep 2017 survey)