From 663c81b4c3287bb17d77616aceef8c776269fc45 Mon Sep 17 00:00:00 2001 From: Stephen Hines Date: Tue, 8 Sep 2015 18:53:51 -0700 Subject: [PATCH] Update docs for RS object API fixes. Bug: 22926131 This is the documentation update corresponding to our new named structures for RS object types. Change-Id: I282ce78192da7c9f68951ce05100819a306694f0 --- .../topics/renderscript/reference/rs_for_each.jd | 2 +- .../topics/renderscript/reference/rs_graphics.jd | 46 ++++++---------------- .../renderscript/reference/rs_object_types.jd | 20 +++++----- .../guide/topics/renderscript/reference/rs_time.jd | 4 +- .../renderscript/reference/rs_value_types.jd | 24 +++++------ 5 files changed, 36 insertions(+), 60 deletions(-) diff --git a/docs/html/guide/topics/renderscript/reference/rs_for_each.jd b/docs/html/guide/topics/renderscript/reference/rs_for_each.jd index abbbda78ba3a..9ba56149f142 100644 --- a/docs/html/guide/topics/renderscript/reference/rs_for_each.jd +++ b/docs/html/guide/topics/renderscript/reference/rs_for_each.jd @@ -205,7 +205,7 @@ locality when the processing is distributed over multiple cores. : Handle to a kernel invocation context
-

A typedef of: const struct rs_kernel_context_t *      Added in API level 23 +

A typedef of: const struct rs_kernel_context_t *     Added in API level 23

The kernel context contains common characteristics of the allocations being iterated over, like dimensions. It also contains rarely used indices of the currently processed diff --git a/docs/html/guide/topics/renderscript/reference/rs_graphics.jd b/docs/html/guide/topics/renderscript/reference/rs_graphics.jd index 1b115fe9a793..b04451c7a526 100644 --- a/docs/html/guide/topics/renderscript/reference/rs_graphics.jd +++ b/docs/html/guide/topics/renderscript/reference/rs_graphics.jd @@ -502,7 +502,7 @@ page.title=RenderScript Graphics Functions and Types

An enum with the following values:      - When compiling for 32 bits. API level 16 - 22 +When compiling for 32 bits. API level 16 - 22

@@ -527,7 +527,7 @@ page.title=RenderScript Graphics Functions and Types

An enum with the following values:      - When compiling for 32 bits. API level 16 - 22 +When compiling for 32 bits. API level 16 - 22

RS_BLEND_DST_ZERO = 0
@@ -553,7 +553,7 @@ page.title=RenderScript Graphics Functions and Types

An enum with the following values:      - When compiling for 32 bits. API level 16 - 22 +When compiling for 32 bits. API level 16 - 22

RS_BLEND_SRC_ZERO = 0
@@ -573,7 +573,7 @@ page.title=RenderScript Graphics Functions and Types

An enum with the following values:      - When compiling for 32 bits. API level 16 - 22 +When compiling for 32 bits. API level 16 - 22

RS_CULL_BACK = 0
@@ -599,11 +599,7 @@ depth to that found in the depth buffer. : Handle to a Font
-

A typedef of: _RS_HANDLE __attribute__(( -#if (defined(RS_VERSION) && (RS_VERSION >= 1)) -deprecated -#endif -))      When compiling for 32 bits. Removed from API level 23 and higher +

When compiling for 32 bits. Removed from API level 23 and higher

Deprecated. Do not use.

Opaque handle to a RenderScript font object. @@ -619,11 +615,7 @@ See: android.renderscript.Font : Handle to a Mesh

-

A typedef of: _RS_HANDLE __attribute__(( -#if (defined(RS_VERSION) && (RS_VERSION >= 1)) -deprecated -#endif -))      When compiling for 32 bits. Removed from API level 23 and higher +

When compiling for 32 bits. Removed from API level 23 and higher

Deprecated. Do not use.

Opaque handle to a RenderScript mesh object. @@ -640,7 +632,7 @@ See: android.renderscript.Mesh

An enum with the following values:      - When compiling for 32 bits. API level 16 - 22 +When compiling for 32 bits. API level 16 - 22

RS_DEPTH_FUNC_ALWAYS = 0Always drawn
@@ -664,11 +656,7 @@ See: android.renderscript.Mesh : Handle to a ProgramFragment
-

A typedef of: _RS_HANDLE __attribute__(( -#if (defined(RS_VERSION) && (RS_VERSION >= 1)) -deprecated -#endif -))      When compiling for 32 bits. Removed from API level 23 and higher +

When compiling for 32 bits. Removed from API level 23 and higher

Deprecated. Do not use.

Opaque handle to a RenderScript ProgramFragment object. @@ -684,11 +672,7 @@ See: android.renderscript.ProgramFragment : Handle to a ProgramRaster

-

A typedef of: _RS_HANDLE __attribute__(( -#if (defined(RS_VERSION) && (RS_VERSION >= 1)) -deprecated -#endif -))      When compiling for 32 bits. Removed from API level 23 and higher +

When compiling for 32 bits. Removed from API level 23 and higher

Deprecated. Do not use.

Opaque handle to a RenderScript ProgramRaster object. @@ -704,11 +688,7 @@ See: android.renderscript.ProgramRaster : Handle to a ProgramStore

-

A typedef of: _RS_HANDLE __attribute__(( -#if (defined(RS_VERSION) && (RS_VERSION >= 1)) -deprecated -#endif -))      When compiling for 32 bits. Removed from API level 23 and higher +

When compiling for 32 bits. Removed from API level 23 and higher

Deprecated. Do not use.

Opaque handle to a RenderScript ProgramStore object. @@ -724,11 +704,7 @@ See: android.renderscript.ProgramStore : Handle to a ProgramVertex

-

A typedef of: _RS_HANDLE __attribute__(( -#if (defined(RS_VERSION) && (RS_VERSION >= 1)) -deprecated -#endif -))      When compiling for 32 bits. Removed from API level 23 and higher +

When compiling for 32 bits. Removed from API level 23 and higher

Deprecated. Do not use.

Opaque handle to a RenderScript ProgramVertex object. diff --git a/docs/html/guide/topics/renderscript/reference/rs_object_types.jd b/docs/html/guide/topics/renderscript/reference/rs_object_types.jd index f3428966c7de..ac4745482d1f 100644 --- a/docs/html/guide/topics/renderscript/reference/rs_object_types.jd +++ b/docs/html/guide/topics/renderscript/reference/rs_object_types.jd @@ -99,7 +99,7 @@ elements, and scripts. Most of these object are created using the Java RenderSc : Handle to an allocation

-

A typedef of: _RS_HANDLE     

+

An opaque handle to a RenderScript allocation.

@@ -116,7 +116,7 @@ elements, and scripts. Most of these object are created using the Java RenderSc

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

RS_PRIMITIVE_POINT = 0Vertex data will be rendered as a series of points
@@ -139,7 +139,7 @@ elements, and scripts. Most of these object are created using the Java RenderSc

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

RS_ALLOCATION_CUBEMAP_FACE_POSITIVE_X = 0
@@ -165,7 +165,7 @@ relevant to an allocation or an operation on an allocation.

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

RS_ALLOCATION_USAGE_SCRIPT = 0x0001Allocation is bound to and accessed by scripts.
@@ -202,7 +202,7 @@ texture formats.

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

RS_KIND_USER = 0No special interpretation.
@@ -253,7 +253,7 @@ as a single unit for packing and alignment purposes. : Handle to an element
-

A typedef of: _RS_HANDLE     

+

An opaque handle to a RenderScript element.

@@ -269,7 +269,7 @@ as a single unit for packing and alignment purposes. : Handle to a Sampler
-

A typedef of: _RS_HANDLE     

+

An opaque handle to a RenderScript sampler object.

@@ -286,7 +286,7 @@ as a single unit for packing and alignment purposes.

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

RS_TYPE_NONE = 0Element is a complex type, i.e. a struct.
@@ -308,7 +308,7 @@ as a single unit for packing and alignment purposes. : Handle to a Script
-

A typedef of: _RS_HANDLE     

+

An opaque handle to a RenderScript script object.

@@ -324,7 +324,7 @@ as a single unit for packing and alignment purposes. : Handle to a Type
-

A typedef of: _RS_HANDLE     

+

An opaque handle to a RenderScript type.

diff --git a/docs/html/guide/topics/renderscript/reference/rs_time.jd b/docs/html/guide/topics/renderscript/reference/rs_time.jd index 27044a3d3126..a1cedfb954db 100644 --- a/docs/html/guide/topics/renderscript/reference/rs_time.jd +++ b/docs/html/guide/topics/renderscript/reference/rs_time.jd @@ -78,9 +78,9 @@ system up time. It is not recommended to call these functions inside of a kerne : Seconds since January 1, 1970
-

A typedef of: int      When compiling for 32 bits. +

A typedef of: int     When compiling for 32 bits.

-

A typedef of: long      When compiling for 64 bits. +

A typedef of: long     When compiling for 64 bits.

Calendar time interpreted as seconds elapsed since the Epoch (00:00:00 on January 1, 1970, Coordinated Universal Time (UTC)). diff --git a/docs/html/guide/topics/renderscript/reference/rs_value_types.jd b/docs/html/guide/topics/renderscript/reference/rs_value_types.jd index d53caf92d74a..2bd49dc5cf7c 100644 --- a/docs/html/guide/topics/renderscript/reference/rs_value_types.jd +++ b/docs/html/guide/topics/renderscript/reference/rs_value_types.jd @@ -644,7 +644,7 @@ with a 128 bit alignment. : 16 bit floating point value

-

A typedef of: __fp16      Added in API level 23 +

A typedef of: __fp16     Added in API level 23

A 16 bit floating point value.

@@ -658,7 +658,7 @@ with a 128 bit alignment. : Two 16 bit floats
-

A typedef of: half __attribute__((ext_vector_type(2)))      Added in API level 23 +

A typedef of: half __attribute__((ext_vector_type(2)))     Added in API level 23

Vector version of the half float type. Provides two half fields packed into a single 32 bit field with 32 bit alignment. @@ -673,7 +673,7 @@ into a single 32 bit field with 32 bit alignment. : Three 16 bit floats

-

A typedef of: half __attribute__((ext_vector_type(3)))      Added in API level 23 +

A typedef of: half __attribute__((ext_vector_type(3)))     Added in API level 23

Vector version of the half float type. Provides three half fields packed into a single 64 bit field with 64 bit alignment. @@ -688,7 +688,7 @@ into a single 64 bit field with 64 bit alignment. : Four 16 bit floats

-

A typedef of: half __attribute__((ext_vector_type(4)))      Added in API level 23 +

A typedef of: half __attribute__((ext_vector_type(4)))     Added in API level 23

Vector version of the half float type. Provides four half fields packed into a single 64 bit field with 64 bit alignment. @@ -771,9 +771,9 @@ with a 128 bit alignment. : 64 bit signed integer

-

A typedef of: long long      Removed from API level 21 and higher +

A typedef of: long long     Removed from API level 21 and higher

-

A typedef of: long      Added in API level 21 +

A typedef of: long     Added in API level 21

A 64 bit signed integer type.

@@ -960,9 +960,9 @@ with a 64 bit alignment. : Unsigned size type
-

A typedef of: uint64_t      When compiling for 64 bits. +

A typedef of: uint64_t     When compiling for 64 bits.

-

A typedef of: uint32_t      When compiling for 32 bits. +

A typedef of: uint32_t     When compiling for 32 bits.

Unsigned size type. The number of bits depend on the compilation flags.

@@ -976,9 +976,9 @@ with a 64 bit alignment. : Signed size type
-

A typedef of: int64_t      When compiling for 64 bits. +

A typedef of: int64_t     When compiling for 64 bits.

-

A typedef of: int32_t      When compiling for 32 bits. +

A typedef of: int32_t     When compiling for 32 bits.

Signed size type. The number of bits depend on the compilation flags.

@@ -1128,9 +1128,9 @@ with a 128 bit alignment. : 64 bit unsigned integer
-

A typedef of: unsigned long long      Removed from API level 21 and higher +

A typedef of: unsigned long long     Removed from API level 21 and higher

-

A typedef of: unsigned long      Added in API level 21 +

A typedef of: unsigned long     Added in API level 21

A 64 bit unsigned integer type.

-- 2.11.0
RS_SAMPLER_NEAREST = 0