diff options
| author | Robert Ly <robertly@google.com> | 2011-11-22 16:21:45 -0800 |
|---|---|---|
| committer | Android (Google) Code Review <android-gerrit@google.com> | 2011-11-22 16:21:45 -0800 |
| commit | b1e72b6826455a19a80dab14612da7f22e0e1a75 (patch) | |
| tree | f824b11cf5eb377ccfb6e084169817e41e41a213 /libs | |
| parent | 7e254a37d0beb1fe307ca45617fbe7cc394d275f (diff) | |
| parent | 77228be41788c1fc582e195d9b17f5eeb58ef6e9 (diff) | |
| download | frameworks_base-b1e72b6826455a19a80dab14612da7f22e0e1a75.zip frameworks_base-b1e72b6826455a19a80dab14612da7f22e0e1a75.tar.gz frameworks_base-b1e72b6826455a19a80dab14612da7f22e0e1a75.tar.bz2 | |
Merge "add overview description for RS API reference"
Diffstat (limited to 'libs')
| -rw-r--r-- | libs/rs/scriptc/rs_allocation.rsh | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/libs/rs/scriptc/rs_allocation.rsh b/libs/rs/scriptc/rs_allocation.rsh index 154a099..1cb3a99 100644 --- a/libs/rs/scriptc/rs_allocation.rsh +++ b/libs/rs/scriptc/rs_allocation.rsh @@ -14,6 +14,31 @@ * limitations under the License. */ +/*! \mainpage notitle + * + * Renderscript is a high-performance runtime that provides graphics rendering and + * compute operations at the native level. Renderscript code is compiled on devices + * at runtime to allow platform-independence as well. + * This reference documentation describes the Renderscript runtime APIs, which you + * can utilize to write Renderscript code in C99. The Renderscript header + * files are automatically included for you, except for the rs_graphics.rsh header. If + * you are doing graphics rendering, include the graphics header file like this: + * + * <code>#include "rs_graphics.rsh"</code> + * + * To use Renderscript, you need to utilize the Renderscript runtime APIs documented here + * as well as the Android framework APIs for Renderscript. + * For documentation on the Android framework APIs, see the <a href= + * "http://developer.android.com/reference/android/renderscript/package-summary.html"> + * android.renderscript</a> package reference. + * For more information on how to develop with Renderscript and how the runtime and + * Android framework APIs interact, see the <a href= + * "http://developer.android.com/guide/topics/renderscript/index.html">Renderscript + * developer guide</a> and the <a href= + * "http://developer.android.com/resources/samples/RenderScript/index.html"> + * Renderscript samples</a>. + */ + /** @file rs_allocation.rsh * \brief Allocation routines * |