diff options
author | Joe Fernandez <joefernandez@google.com> | 2011-12-20 10:38:34 -0800 |
---|---|---|
committer | Joe Fernandez <joefernandez@google.com> | 2011-12-22 15:08:23 -0800 |
commit | 3aef8e1d1b2f0b87d470bcccf37ba4ebb6560c45 (patch) | |
tree | 7600f58de48f6764d476cc9d6a92ed0a5dddf278 /graphics | |
parent | 8f04ae361cd34fdaea41fbedefb85cff2c684e36 (diff) | |
download | frameworks_base-3aef8e1d1b2f0b87d470bcccf37ba4ebb6560c45.zip frameworks_base-3aef8e1d1b2f0b87d470bcccf37ba4ebb6560c45.tar.gz frameworks_base-3aef8e1d1b2f0b87d470bcccf37ba4ebb6560c45.tar.bz2 |
docs: Add developer guide cross-references, Project ACRE, round 4
Change-Id: I1b43414aaec8ea217b39a0d780c80a25409d0991
Diffstat (limited to 'graphics')
8 files changed, 54 insertions, 17 deletions
diff --git a/graphics/java/android/graphics/drawable/AnimationDrawable.java b/graphics/java/android/graphics/drawable/AnimationDrawable.java index 7efdc6c..07de074 100644 --- a/graphics/java/android/graphics/drawable/AnimationDrawable.java +++ b/graphics/java/android/graphics/drawable/AnimationDrawable.java @@ -64,8 +64,13 @@ import android.util.AttributeSet; * // Start the animation (looped playback by default). * frameAnimation.start(); * </pre> - * <p>For more information, see the guide to <a - * href="{@docRoot}guide/topics/resources/animation-resource.html">Animation Resources</a>.</p> + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For more information about animating with {@code AnimationDrawable}, read the + * <a href="{@docRoot}guide/topics/graphics/drawable-animation.html">Drawable Animation</a> + * developer guide.</p> + * </div> * * @attr ref android.R.styleable#AnimationDrawable_visible * @attr ref android.R.styleable#AnimationDrawable_variablePadding diff --git a/graphics/java/android/renderscript/Allocation.java b/graphics/java/android/renderscript/Allocation.java index 12e5ada..f285f5b 100644 --- a/graphics/java/android/renderscript/Allocation.java +++ b/graphics/java/android/renderscript/Allocation.java @@ -62,6 +62,11 @@ import android.util.TypedValue; * The unchecked variants exist to allow apps to copy over arrays of structures from a * control language that does not support structures.</p> * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For more information about creating an application that uses Renderscript, read the + * <a href="{@docRoot}guide/topics/graphics/renderscript.html">Renderscript</a> developer guide.</p> + * </div> **/ public class Allocation extends BaseObj { Type mType; diff --git a/graphics/java/android/renderscript/Element.java b/graphics/java/android/renderscript/Element.java index 8a9ca85..d378a78 100644 --- a/graphics/java/android/renderscript/Element.java +++ b/graphics/java/android/renderscript/Element.java @@ -40,6 +40,12 @@ import android.util.Log; * <p>The primary source of elements are from scripts. A script that exports a * bind point for a data structure generates a Renderscript element to represent the * data exported by the script. The other common source of elements is from bitmap formats.</p> + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For more information about creating an application that uses Renderscript, read the + * <a href="{@docRoot}guide/topics/graphics/renderscript.html">Renderscript</a> developer guide.</p> + * </div> **/ public class Element extends BaseObj { int mSize; diff --git a/graphics/java/android/renderscript/RSSurfaceView.java b/graphics/java/android/renderscript/RSSurfaceView.java index a8e3107..6756fd0 100644 --- a/graphics/java/android/renderscript/RSSurfaceView.java +++ b/graphics/java/android/renderscript/RSSurfaceView.java @@ -31,6 +31,12 @@ import android.view.SurfaceView; /** * The Surface View for a graphics renderscript (RenderScriptGL) to draw on. + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For more information about creating an application that uses Renderscript, read the + * <a href="{@docRoot}guide/topics/graphics/renderscript.html">Renderscript</a> developer guide.</p> + * </div> */ public class RSSurfaceView extends SurfaceView implements SurfaceHolder.Callback { private SurfaceHolder mSurfaceHolder; diff --git a/graphics/java/android/renderscript/RenderScript.java b/graphics/java/android/renderscript/RenderScript.java index 1305633..ad10832 100644 --- a/graphics/java/android/renderscript/RenderScript.java +++ b/graphics/java/android/renderscript/RenderScript.java @@ -32,13 +32,16 @@ import android.view.Surface; /** - * RenderScript base master class. An instance of this class creates native + * Renderscript base master class. An instance of this class creates native * worker threads for processing commands from this object. This base class * does not provide any extended capabilities beyond simple data processing. * For extended capabilities use derived classes such as RenderScriptGL. * - * - * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For more information about creating an application that uses Renderscript, read the + * <a href="{@docRoot}guide/topics/graphics/renderscript.html">Renderscript</a> developer guide.</p> + * </div> **/ public class RenderScript { static final String LOG_TAG = "RenderScript_jni"; diff --git a/graphics/java/android/renderscript/RenderScriptGL.java b/graphics/java/android/renderscript/RenderScriptGL.java index 2dfcc83..2cfeb17 100644 --- a/graphics/java/android/renderscript/RenderScriptGL.java +++ b/graphics/java/android/renderscript/RenderScriptGL.java @@ -29,11 +29,17 @@ import android.view.SurfaceHolder; import android.view.SurfaceView; /** - * The Graphics derivitive of RenderScript. Extends the basic context to add a + * The Graphics derivitive of Renderscript. Extends the basic context to add a * root script which is the display window for graphical output. When the * system needs to update the display the currently bound root script will be * called. This script is expected to issue the rendering commands to repaint * the screen. + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For more information about creating an application that uses Renderscript, read the + * <a href="{@docRoot}guide/topics/graphics/renderscript.html">Renderscript</a> developer guide.</p> + * </div> **/ public class RenderScriptGL extends RenderScript { int mWidth; diff --git a/graphics/java/android/renderscript/Type.java b/graphics/java/android/renderscript/Type.java index f88af8b..70d1de4 100644 --- a/graphics/java/android/renderscript/Type.java +++ b/graphics/java/android/renderscript/Type.java @@ -35,6 +35,11 @@ import android.util.Log; * * <p>The LOD and Faces dimensions are booleans to indicate present or not present.</p> * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For more information about creating an application that uses Renderscript, read the + * <a href="{@docRoot}guide/topics/graphics/renderscript.html">Renderscript</a> developer guide.</p> + * </div> **/ public class Type extends BaseObj { int mDimX; diff --git a/graphics/java/android/renderscript/package.html b/graphics/java/android/renderscript/package.html index 36a24ff..775645f 100644 --- a/graphics/java/android/renderscript/package.html +++ b/graphics/java/android/renderscript/package.html @@ -1,10 +1,16 @@ <HTML> <BODY> <p>The Renderscript rendering and computational APIs offer a low-level, high performance means of -carrying out mathematical calculations and 3D graphics rendering. An example of Renderscript in -applications include the 3D carousel view that is present in Android 3.0 applications such as the -Books and YouTube applications. This API is intended for developers who are comfortable working with -native code and want to maximize their performance critical applications.</p> +carrying out mathematical calculations and 3D graphics rendering.</p> + +<p>For more information, see the +<a href="{@docRoot}guide/topics/graphics/renderscript.html">Renderscript</a> developer guide.</p> +{@more} + +<p>An example of Renderscript in applications include the 3D carousel view that is present in +Android 3.0 applications such as the Books and YouTube applications. This API is intended for +developers who are comfortable working with native code and want to maximize their performance +critical applications.</p> <p>Renderscript adopts a control and slave architecture where the low-level native code is controlled by the higher level Android system that runs in the virtual machine (VM). The VM code handles resource @@ -14,7 +20,7 @@ the native Renderscript code, which you write in C (C99 standard). The Renderscr does the intensive computation and returns the result back to the Android VM.</p> <p>You can find the Renderscript native -APIs in the <code><sdk_root>/platforms/android-3.0/renderscript</code> directory. +APIs in the <code><sdk_root>/platforms/android-11/renderscript</code> directory. The Android system APIs are broken into a few main groups:</p> <h4>Core</h4> @@ -37,7 +43,7 @@ classes include:</p> <li>Byte2, Byte3, and Byte4</li> <li>Float2, Float3, Float4</li> <li>Int2, Int3, Int4</li> - <li>Long2, Long3, Long4</li> + <li>Long2, Long3, Long4</li> <li>Matrix2f, Matrix3f, Matrix4f</li> <li>Short2, Short3, Short4</li> </ul> @@ -76,10 +82,5 @@ pipeline.</p> </ul> </p> -<p> -For information on how to create an application that uses Renderscript, and also the -see <a href="../../../guide/topics/graphics/renderscript.html">3D with -Renderscript</a> dev guide. -</p> </BODY> </HTML> |