Skip to content

Commit 0272f1d

Browse files
author
Robert Ly
committed
cherrypick from master - add overview description for RS API reference Change-Id: Id5554c607ad4c435f92bfa939e4ce4833a638f62
Change-Id: Iff4b4bd171818208bb3be46dd3ef7e91b6cbd80f
1 parent dacbf67 commit 0272f1d

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

libs/rs/scriptc/rs_allocation.rsh

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,31 @@
1414
* limitations under the License.
1515
*/
1616

17+
/*! \mainpage notitle
18+
*
19+
* Renderscript is a high-performance runtime that provides graphics rendering and
20+
* compute operations at the native level. Renderscript code is compiled on devices
21+
* at runtime to allow platform-independence as well.
22+
* This reference documentation describes the Renderscript runtime APIs, which you
23+
* can utilize to write Renderscript code in C99. The Renderscript header
24+
* files are automatically included for you, except for the rs_graphics.rsh header. If
25+
* you are doing graphics rendering, include the graphics header file like this:
26+
*
27+
* <code>#include "rs_graphics.rsh"</code>
28+
*
29+
* To use Renderscript, you need to utilize the Renderscript runtime APIs documented here
30+
* as well as the Android framework APIs for Renderscript.
31+
* For documentation on the Android framework APIs, see the <a href=
32+
* "http://developer.android.com/reference/android/renderscript/package-summary.html">
33+
* android.renderscript</a> package reference.
34+
* For more information on how to develop with Renderscript and how the runtime and
35+
* Android framework APIs interact, see the <a href=
36+
* "http://developer.android.com/guide/topics/renderscript/index.html">Renderscript
37+
* developer guide</a> and the <a href=
38+
* "http://developer.android.com/resources/samples/RenderScript/index.html">
39+
* Renderscript samples</a>.
40+
*/
41+
1742
/** @file rs_allocation.rsh
1843
* \brief Allocation routines
1944
*

0 commit comments

Comments
 (0)