diff options
| author | 2015-09-08 18:53:51 -0700 | |
|---|---|---|
| committer | 2015-09-10 18:52:40 -0700 | |
| commit | 663c81b4c3287bb17d77616aceef8c776269fc45 (patch) | |
| tree | 78dae2dcf8fa822bf370d19bdde3940245bb86ff | |
| parent | 5f785909f3c1a571f81f1cfd543308980a6edd79 (diff) | |
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
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. <span class='normal'>: Handle to a kernel invocation context</span> </h4> <div class='jd-details-descr'> -<p>A typedef of: const struct rs_kernel_context_t * Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 23</a> +<p>A typedef of: const struct rs_kernel_context_t * Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 23</a> </p> <p> 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 </h4> <div class='jd-details-descr'> <p>An enum with the following values: - When compiling for 32 bits. <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 16 - 22</a> +When compiling for 32 bits. <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 16 - 22</a> </p> <table class='jd-tagtable'><tbody> <tr><th>RS_BLEND_DST_ZERO = 0</th><td></td></tr> @@ -527,7 +527,7 @@ page.title=RenderScript Graphics Functions and Types </h4> <div class='jd-details-descr'> <p>An enum with the following values: - When compiling for 32 bits. <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 16 - 22</a> +When compiling for 32 bits. <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 16 - 22</a> </p> <table class='jd-tagtable'><tbody> <tr><th>RS_BLEND_SRC_ZERO = 0</th><td></td></tr> @@ -553,7 +553,7 @@ page.title=RenderScript Graphics Functions and Types </h4> <div class='jd-details-descr'> <p>An enum with the following values: - When compiling for 32 bits. <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 16 - 22</a> +When compiling for 32 bits. <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 16 - 22</a> </p> <table class='jd-tagtable'><tbody> <tr><th>RS_CULL_BACK = 0</th><td></td></tr> @@ -573,7 +573,7 @@ page.title=RenderScript Graphics Functions and Types </h4> <div class='jd-details-descr'> <p>An enum with the following values: - When compiling for 32 bits. <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 16 - 22</a> +When compiling for 32 bits. <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 16 - 22</a> </p> <table class='jd-tagtable'><tbody> <tr><th>RS_DEPTH_FUNC_ALWAYS = 0</th><td>Always drawn</td></tr> @@ -599,11 +599,7 @@ depth to that found in the depth buffer. <span class='normal'>: Handle to a Font</span> </h4> <div class='jd-details-descr'> -<p>A typedef of: _RS_HANDLE __attribute__(( -#if (defined(RS_VERSION) && (RS_VERSION >= 1)) -deprecated -#endif -)) When compiling for 32 bits. Removed from <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 23 and higher</a> +<p>When compiling for 32 bits. Removed from <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 23 and higher</a> </p> <p><b>Deprecated.</b> Do not use.</p> <p> Opaque handle to a RenderScript font object. @@ -619,11 +615,7 @@ See: android.renderscript.Font <span class='normal'>: Handle to a Mesh</span> </h4> <div class='jd-details-descr'> -<p>A typedef of: _RS_HANDLE __attribute__(( -#if (defined(RS_VERSION) && (RS_VERSION >= 1)) -deprecated -#endif -)) When compiling for 32 bits. Removed from <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 23 and higher</a> +<p>When compiling for 32 bits. Removed from <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 23 and higher</a> </p> <p><b>Deprecated.</b> Do not use.</p> <p> Opaque handle to a RenderScript mesh object. @@ -640,7 +632,7 @@ See: android.renderscript.Mesh </h4> <div class='jd-details-descr'> <p>An enum with the following values: - When compiling for 32 bits. <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 16 - 22</a> +When compiling for 32 bits. <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 16 - 22</a> </p> <table class='jd-tagtable'><tbody> <tr><th>RS_PRIMITIVE_POINT = 0</th><td>Vertex data will be rendered as a series of points</td></tr> @@ -664,11 +656,7 @@ See: android.renderscript.Mesh <span class='normal'>: Handle to a ProgramFragment</span> </h4> <div class='jd-details-descr'> -<p>A typedef of: _RS_HANDLE __attribute__(( -#if (defined(RS_VERSION) && (RS_VERSION >= 1)) -deprecated -#endif -)) When compiling for 32 bits. Removed from <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 23 and higher</a> +<p>When compiling for 32 bits. Removed from <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 23 and higher</a> </p> <p><b>Deprecated.</b> Do not use.</p> <p> Opaque handle to a RenderScript ProgramFragment object. @@ -684,11 +672,7 @@ See: android.renderscript.ProgramFragment <span class='normal'>: Handle to a ProgramRaster</span> </h4> <div class='jd-details-descr'> -<p>A typedef of: _RS_HANDLE __attribute__(( -#if (defined(RS_VERSION) && (RS_VERSION >= 1)) -deprecated -#endif -)) When compiling for 32 bits. Removed from <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 23 and higher</a> +<p>When compiling for 32 bits. Removed from <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 23 and higher</a> </p> <p><b>Deprecated.</b> Do not use.</p> <p> Opaque handle to a RenderScript ProgramRaster object. @@ -704,11 +688,7 @@ See: android.renderscript.ProgramRaster <span class='normal'>: Handle to a ProgramStore</span> </h4> <div class='jd-details-descr'> -<p>A typedef of: _RS_HANDLE __attribute__(( -#if (defined(RS_VERSION) && (RS_VERSION >= 1)) -deprecated -#endif -)) When compiling for 32 bits. Removed from <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 23 and higher</a> +<p>When compiling for 32 bits. Removed from <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 23 and higher</a> </p> <p><b>Deprecated.</b> Do not use.</p> <p> Opaque handle to a RenderScript ProgramStore object. @@ -724,11 +704,7 @@ See: android.renderscript.ProgramStore <span class='normal'>: Handle to a ProgramVertex</span> </h4> <div class='jd-details-descr'> -<p>A typedef of: _RS_HANDLE __attribute__(( -#if (defined(RS_VERSION) && (RS_VERSION >= 1)) -deprecated -#endif -)) When compiling for 32 bits. Removed from <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 23 and higher</a> +<p>When compiling for 32 bits. Removed from <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 23 and higher</a> </p> <p><b>Deprecated.</b> Do not use.</p> <p> 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 <span class='normal'>: Handle to an allocation</span> </h4> <div class='jd-details-descr'> -<p>A typedef of: _RS_HANDLE </p> +<p></p> <p> An opaque handle to a RenderScript allocation. </p> @@ -116,7 +116,7 @@ elements, and scripts. Most of these object are created using the Java RenderSc </h4> <div class='jd-details-descr'> <p>An enum with the following values: - Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 14</a> +Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 14</a> </p> <table class='jd-tagtable'><tbody> <tr><th>RS_ALLOCATION_CUBEMAP_FACE_POSITIVE_X = 0</th><td></td></tr> @@ -139,7 +139,7 @@ elements, and scripts. Most of these object are created using the Java RenderSc </h4> <div class='jd-details-descr'> <p>An enum with the following values: - Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 14</a> +Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 14</a> </p> <table class='jd-tagtable'><tbody> <tr><th>RS_ALLOCATION_USAGE_SCRIPT = 0x0001</th><td>Allocation is bound to and accessed by scripts.</td></tr> @@ -165,7 +165,7 @@ relevant to an allocation or an operation on an allocation. </h4> <div class='jd-details-descr'> <p>An enum with the following values: - Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 16</a> +Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 16</a> </p> <table class='jd-tagtable'><tbody> <tr><th>RS_KIND_USER = 0</th><td>No special interpretation.</td></tr> @@ -202,7 +202,7 @@ texture formats. </h4> <div class='jd-details-descr'> <p>An enum with the following values: - Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 16</a> +Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 16</a> </p> <table class='jd-tagtable'><tbody> <tr><th>RS_TYPE_NONE = 0</th><td>Element is a complex type, i.e. a struct.</td></tr> @@ -253,7 +253,7 @@ as a single unit for packing and alignment purposes. <span class='normal'>: Handle to an element</span> </h4> <div class='jd-details-descr'> -<p>A typedef of: _RS_HANDLE </p> +<p></p> <p> An opaque handle to a RenderScript element. </p> @@ -269,7 +269,7 @@ as a single unit for packing and alignment purposes. <span class='normal'>: Handle to a Sampler</span> </h4> <div class='jd-details-descr'> -<p>A typedef of: _RS_HANDLE </p> +<p></p> <p> An opaque handle to a RenderScript sampler object. </p> @@ -286,7 +286,7 @@ as a single unit for packing and alignment purposes. </h4> <div class='jd-details-descr'> <p>An enum with the following values: - Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 16</a> +Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 16</a> </p> <table class='jd-tagtable'><tbody> <tr><th>RS_SAMPLER_NEAREST = 0</th><td></td></tr> @@ -308,7 +308,7 @@ as a single unit for packing and alignment purposes. <span class='normal'>: Handle to a Script</span> </h4> <div class='jd-details-descr'> -<p>A typedef of: _RS_HANDLE </p> +<p></p> <p> An opaque handle to a RenderScript script object. </p> @@ -324,7 +324,7 @@ as a single unit for packing and alignment purposes. <span class='normal'>: Handle to a Type</span> </h4> <div class='jd-details-descr'> -<p>A typedef of: _RS_HANDLE </p> +<p></p> <p> An opaque handle to a RenderScript type. </p> 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 <span class='normal'>: Seconds since January 1, 1970</span> </h4> <div class='jd-details-descr'> -<p>A typedef of: int When compiling for 32 bits. +<p>A typedef of: int When compiling for 32 bits. </p> -<p>A typedef of: long When compiling for 64 bits. +<p>A typedef of: long When compiling for 64 bits. </p> <p> 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. <span class='normal'>: 16 bit floating point value</span> </h4> <div class='jd-details-descr'> -<p>A typedef of: __fp16 Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 23</a> +<p>A typedef of: __fp16 Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 23</a> </p> <p> A 16 bit floating point value. </p> @@ -658,7 +658,7 @@ with a 128 bit alignment. <span class='normal'>: Two 16 bit floats</span> </h4> <div class='jd-details-descr'> -<p>A typedef of: half __attribute__((ext_vector_type(2))) Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 23</a> +<p>A typedef of: half __attribute__((ext_vector_type(2))) Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 23</a> </p> <p> 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. <span class='normal'>: Three 16 bit floats</span> </h4> <div class='jd-details-descr'> -<p>A typedef of: half __attribute__((ext_vector_type(3))) Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 23</a> +<p>A typedef of: half __attribute__((ext_vector_type(3))) Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 23</a> </p> <p> 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. <span class='normal'>: Four 16 bit floats</span> </h4> <div class='jd-details-descr'> -<p>A typedef of: half __attribute__((ext_vector_type(4))) Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 23</a> +<p>A typedef of: half __attribute__((ext_vector_type(4))) Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 23</a> </p> <p> 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. <span class='normal'>: 64 bit signed integer</span> </h4> <div class='jd-details-descr'> -<p>A typedef of: long long Removed from <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 21 and higher</a> +<p>A typedef of: long long Removed from <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 21 and higher</a> </p> -<p>A typedef of: long Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 21</a> +<p>A typedef of: long Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 21</a> </p> <p> A 64 bit signed integer type. </p> @@ -960,9 +960,9 @@ with a 64 bit alignment. <span class='normal'>: Unsigned size type</span> </h4> <div class='jd-details-descr'> -<p>A typedef of: uint64_t When compiling for 64 bits. +<p>A typedef of: uint64_t When compiling for 64 bits. </p> -<p>A typedef of: uint32_t When compiling for 32 bits. +<p>A typedef of: uint32_t When compiling for 32 bits. </p> <p> Unsigned size type. The number of bits depend on the compilation flags. </p> @@ -976,9 +976,9 @@ with a 64 bit alignment. <span class='normal'>: Signed size type</span> </h4> <div class='jd-details-descr'> -<p>A typedef of: int64_t When compiling for 64 bits. +<p>A typedef of: int64_t When compiling for 64 bits. </p> -<p>A typedef of: int32_t When compiling for 32 bits. +<p>A typedef of: int32_t When compiling for 32 bits. </p> <p> Signed size type. The number of bits depend on the compilation flags. </p> @@ -1128,9 +1128,9 @@ with a 128 bit alignment. <span class='normal'>: 64 bit unsigned integer</span> </h4> <div class='jd-details-descr'> -<p>A typedef of: unsigned long long Removed from <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 21 and higher</a> +<p>A typedef of: unsigned long long Removed from <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 21 and higher</a> </p> -<p>A typedef of: unsigned long Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 21</a> +<p>A typedef of: unsigned long Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 21</a> </p> <p> A 64 bit unsigned integer type. </p> |