Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 8bf69a48 authored by Jean-Luc Brouillet's avatar Jean-Luc Brouillet
Browse files

Update the RenderScript runtime documentation for MNC. 

Update the documentation to include the features introduced in MNC.

b/23190418

Change-Id: I2c6dc11029a9bc0c2ca9bb8b712d4fd4660c3b29
parent 7e7d79ef

docs/html/guide/topics/renderscript/reference/index.jd

+160 −0
Original line number Diff line number Diff line
@@ -184,6 +184,38 @@ page.title=RenderScript Index 
      Four 32 bit floats

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_value_types.html#android_rs:half'>half</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      16 bit floating point value

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_value_types.html#android_rs:half2'>half2</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Two 16 bit floats

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_value_types.html#android_rs:half3'>half3</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Three 16 bit floats

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_value_types.html#android_rs:half4'>half4</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Four 16 bit floats

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_value_types.html#android_rs:int16_t'>int16_t</a>
@@ -320,6 +352,14 @@ page.title=RenderScript Index 
      Suggested cell processing order

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rs_kernel_context'>rs_kernel_context</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Handle to a kernel invocation context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_value_types.html#android_rs:rs_matrix2x2'>rs_matrix2x2</a>
@@ -1803,6 +1843,110 @@ page.title=RenderScript Index 
      Invoke the root kernel of a script

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetArray0'>rsGetArray0</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Index in the Array0 dimension for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetArray1'>rsGetArray1</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Index in the Array1 dimension for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetArray2'>rsGetArray2</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Index in the Array2 dimension for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetArray3'>rsGetArray3</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Index in the Array3 dimension for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetDimArray0'>rsGetDimArray0</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Size of the Array0 dimension for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetDimArray1'>rsGetDimArray1</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Size of the Array1 dimension for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetDimArray2'>rsGetDimArray2</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Size of the Array2 dimension for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetDimArray3'>rsGetDimArray3</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Size of the Array3 dimension for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetDimHasFaces'>rsGetDimHasFaces</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Presence of more than one face for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetDimLod'>rsGetDimLod</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Number of levels of detail for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetDimX'>rsGetDimX</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Size of the X dimension for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetDimY'>rsGetDimY</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Size of the Y dimension for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetDimZ'>rsGetDimZ</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Size of the Z dimension for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_time.html#android_rs:rsGetDt'>rsGetDt</a>
@@ -1843,6 +1987,22 @@ page.title=RenderScript Index 
      Get the Y component of an allocation of YUVs

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetFace'>rsGetFace</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Coordinate of the Face for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetLod'>rsGetLod</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Index in the Levels of Detail dimension for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_object_info.html#android_rs:rsIsObject'>rsIsObject</a>

docs/html/guide/topics/renderscript/reference/overview.jd

+167 −2
Original line number Diff line number Diff line
@@ -30,7 +30,7 @@ framework APIs interact, see the <a target="_parent" href="http://developer.andr 
<tr><td>                 </td>  <td>8 bits        </td>   <td>16 bits         </td>   <td>32 bits       </td>   <td>64 bits</td></tr>

<tr><td>Integer:         </td>  <td>char, <a href='rs_value_types.html#android_rs:int8_t'>int8_t</a>  </td>   <td>short, <a href='rs_value_types.html#android_rs:int16_t'>int16_t</a>  </td>   <td><a href='rs_value_types.html#android_rs:int32_t'>int32_t</a>       </td>   <td>long, long long, <a href='rs_value_types.html#android_rs:int64_t'>int64_t</a></td></tr>

<tr><td>Unsigned integer:</td>  <td>uchar, <a href='rs_value_types.html#android_rs:uint8_t'>uint8_t</a></td>   <td>ushort, <a href='rs_value_types.html#android_rs:uint16_t'>uint16_t</a></td>   <td>uint, <a href='rs_value_types.html#android_rs:uint32_t'>uint32_t</a></td>   <td>ulong, <a href='rs_value_types.html#android_rs:uint64_t'>uint64_t</a></td></tr>

<tr><td>Floating point:  </td>  <td>              </td>   <td>                </td>   <td>float         </td>   <td>double</td></tr>

<tr><td>Floating point:  </td>  <td>              </td>   <td>half            </td>   <td>float         </td>   <td>double</td></tr>

</table>

</p>
@@ -178,6 +178,38 @@ of operations. 
      Four 32 bit floats

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_value_types.html#android_rs:half'>half</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      16 bit floating point value

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_value_types.html#android_rs:half2'>half2</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Two 16 bit floats

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_value_types.html#android_rs:half3'>half3</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Three 16 bit floats

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_value_types.html#android_rs:half4'>half4</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Four 16 bit floats

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_value_types.html#android_rs:int16_t'>int16_t</a>
@@ -2585,6 +2617,11 @@ See <a href='http://developer.android.com/reference/android/renderscript/Sampler 
<h2>Kernel Invocation Functions and Types</h2>

<p> The <a href='rs_for_each.html#android_rs:rsForEach'>rsForEach</a>() function can be used to invoke the root kernel of a script.

</p>



<p> The other functions are used to get the characteristics of the invocation of

an executing kernel, like dimensions and current indices.  These functions take

a <a href='rs_for_each.html#android_rs:rs_kernel_context'>rs_kernel_context</a> as argument.

</p>

<table class='jd-sumtable'><tbody>

  <tr><th colspan='2'>Types</th></tr>

  <tr class='alt-color api apilevel-1'>
@@ -2595,6 +2632,14 @@ See <a href='http://developer.android.com/reference/android/renderscript/Sampler 
      Suggested cell processing order

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rs_kernel_context'>rs_kernel_context</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Handle to a kernel invocation context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rs_script_call_t'>rs_script_call_t</a>
@@ -2614,6 +2659,126 @@ See <a href='http://developer.android.com/reference/android/renderscript/Sampler 
      Invoke the root kernel of a script

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetArray0'>rsGetArray0</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Index in the Array0 dimension for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetArray1'>rsGetArray1</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Index in the Array1 dimension for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetArray2'>rsGetArray2</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Index in the Array2 dimension for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetArray3'>rsGetArray3</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Index in the Array3 dimension for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetDimArray0'>rsGetDimArray0</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Size of the Array0 dimension for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetDimArray1'>rsGetDimArray1</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Size of the Array1 dimension for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetDimArray2'>rsGetDimArray2</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Size of the Array2 dimension for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetDimArray3'>rsGetDimArray3</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Size of the Array3 dimension for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetDimHasFaces'>rsGetDimHasFaces</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Presence of more than one face for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetDimLod'>rsGetDimLod</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Number of levels of detail for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetDimX'>rsGetDimX</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Size of the X dimension for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetDimY'>rsGetDimY</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Size of the Y dimension for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetDimZ'>rsGetDimZ</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Size of the Z dimension for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetFace'>rsGetFace</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Coordinate of the Face for the specified kernel context

    </td>

  </tr>

  <tr class='alt-color api apilevel-1'>

    <td class='jd-linkcol'>

      <a href='rs_for_each.html#android_rs:rsGetLod'>rsGetLod</a>

    </td>

    <td class='jd-descrcol' width='100%'>

      Index in the Levels of Detail dimension for the specified kernel context

    </td>

  </tr>

</tbody></table>

<h2>Input/Output Functions</h2>

<p> These functions are used to:<ul>
@@ -2671,6 +2836,6 @@ They should not be used in shipping applications. 
  </tr>

</tbody></table>

<h2>Graphics Functions and Types</h2>

<p> The graphics subsystem of RenderScript has been deprecated.

<p> The graphics subsystem of RenderScript was removed at API level 23.

</p>

</div>

docs/html/guide/topics/renderscript/reference/rs_allocation_data.jd

+145 −1

File changed.

Preview size limit exceeded, changes collapsed.

docs/html/guide/topics/renderscript/reference/rs_convert.jd

+8 −3
Original line number Diff line number Diff line
@@ -1765,9 +1765,14 @@ Use <a href='rs_math.html#android_rs:clamp'>clamp</a>() to avoid this. 
    </tbody></table>

  </div>

  <div class='jd-tagdata jd-tagdescr'>

<p> Packs three or four floating point RGBA values into a uchar4.  The RGBA values should be

between 0.0 and 1.0 inclusive.  Values outside of this range are clamped to this range.

However numbers greater than INT_MAX or less than INT_MIN can result in undefined behavior.

<p> Packs three or four floating point RGBA values into a uchar4.

</p>



<p> The input values are typically between 0.0f and 1.0f inclusive.  For input values outside

of this range, the resulting outputs will be clamped to be between 0 and 255.  As this

clamping may be done after the input is multiplied by 255.f and converted to an integer,

input numbers greater than INT_MAX/255.f or less than INT_MIN/255.f result in

undefined behavior.

</p>



<p> If the alpha component is not specified, it is assumed to be 1.0, i.e. the result will

docs/html/guide/topics/renderscript/reference/rs_debug.jd

+18 −0
Original line number Diff line number Diff line
@@ -77,6 +77,24 @@ They should not be used in shipping applications. 
</td>

        <td>        </td>

      </tr>

      <tr>

        <td>void rsDebug(const char* message, <a href='rs_value_types.html#android_rs:double2'>double2</a> a);

</td>

        <td>    Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 23</a>

        </td>

      </tr>

      <tr>

        <td>void rsDebug(const char* message, <a href='rs_value_types.html#android_rs:double3'>double3</a> a);

</td>

        <td>    Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 23</a>

        </td>

      </tr>

      <tr>

        <td>void rsDebug(const char* message, <a href='rs_value_types.html#android_rs:double4'>double4</a> a);

</td>

        <td>    Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 23</a>

        </td>

      </tr>

      <tr>

        <td>void rsDebug(const char* message, float a);

</td>