diff options
author | Tim Murray <timmurray@google.com> | 2013-04-05 22:06:43 +0000 |
---|---|---|
committer | Tim Murray <timmurray@google.com> | 2013-04-05 15:17:54 -0700 |
commit | a90842283e322b1210e2bea5850b05177e3d87af (patch) | |
tree | 1b814376dc63adeee70854711a94a29a51f3eb00 /graphics | |
parent | b2cb8e41f93e8a26241e3de20e862ffa66dedaa4 (diff) | |
download | frameworks_base-a90842283e322b1210e2bea5850b05177e3d87af.zip frameworks_base-a90842283e322b1210e2bea5850b05177e3d87af.tar.gz frameworks_base-a90842283e322b1210e2bea5850b05177e3d87af.tar.bz2 |
Remove all public mention of RS graphics from docs.
Change-Id: Ie43b5fb0353149aa9af433b6f5c5141349388ea0
Diffstat (limited to 'graphics')
14 files changed, 28 insertions, 89 deletions
diff --git a/graphics/java/android/renderscript/FileA3D.java b/graphics/java/android/renderscript/FileA3D.java index 42b508b..8b0222a 100644 --- a/graphics/java/android/renderscript/FileA3D.java +++ b/graphics/java/android/renderscript/FileA3D.java @@ -28,6 +28,7 @@ import android.util.Log; import android.util.TypedValue; /** + * @hide * @deprecated in API 16 * FileA3D allows users to load Renderscript objects from files * or resources stored on disk. It could be used to load items diff --git a/graphics/java/android/renderscript/Font.java b/graphics/java/android/renderscript/Font.java index 8a49abb..1a8d5bf 100644 --- a/graphics/java/android/renderscript/Font.java +++ b/graphics/java/android/renderscript/Font.java @@ -30,8 +30,9 @@ import android.util.Log; import android.util.TypedValue; /** + * @hide * @deprecated in API 16 - * <p>This class gives users a simple way to draw hardware accelerated text. + * <p>This class gives users a simple way to draw hardware accelerated text. * Internally, the glyphs are rendered using the Freetype library and an internal cache of * rendered glyph bitmaps is maintained. Each font object represents a combination of a typeface, * and point size. You can create multiple font objects to represent styles such as bold or italic text, @@ -43,7 +44,7 @@ import android.util.TypedValue; * render large batches of text in sequence. It is also more efficient to render multiple * characters at once instead of one by one to improve draw call batching.</p> * <p>Font color and transparency are not part of the font object and you can freely modify - * them in the script to suit the user's rendering needs. Font colors work as a state machine. + * them in the script to suit the user's rendering needs. Font colors work as a state machine. * Every new call to draw text uses the last color set in the script.</p> **/ public class Font extends BaseObj { diff --git a/graphics/java/android/renderscript/Mesh.java b/graphics/java/android/renderscript/Mesh.java index 7210513..d0d383d 100644 --- a/graphics/java/android/renderscript/Mesh.java +++ b/graphics/java/android/renderscript/Mesh.java @@ -21,6 +21,7 @@ import java.util.Vector; import android.util.Log; /** + * @hide * @deprecated in API 16 * <p>This class is a container for geometric data displayed with * Renderscript. Internally, a mesh is a collection of allocations that diff --git a/graphics/java/android/renderscript/Program.java b/graphics/java/android/renderscript/Program.java index d9f64c6..9bd103e 100644 --- a/graphics/java/android/renderscript/Program.java +++ b/graphics/java/android/renderscript/Program.java @@ -26,6 +26,7 @@ import android.util.Log; /** + * @hide * * Program is a base class for all the objects that modify * various stages of the graphics pipeline diff --git a/graphics/java/android/renderscript/ProgramFragment.java b/graphics/java/android/renderscript/ProgramFragment.java index 69968ac..dd0f9f5 100644 --- a/graphics/java/android/renderscript/ProgramFragment.java +++ b/graphics/java/android/renderscript/ProgramFragment.java @@ -21,6 +21,7 @@ import android.util.Log; /** + * @hide * @deprecated in API 16 * <p>The Renderscript fragment program, also known as fragment shader is responsible * for manipulating pixel data in a user defined way. It's constructed from a GLSL diff --git a/graphics/java/android/renderscript/ProgramFragmentFixedFunction.java b/graphics/java/android/renderscript/ProgramFragmentFixedFunction.java index 848c5a3..8ae1777 100644 --- a/graphics/java/android/renderscript/ProgramFragmentFixedFunction.java +++ b/graphics/java/android/renderscript/ProgramFragmentFixedFunction.java @@ -21,6 +21,7 @@ import android.util.Log; /** + * @hide * @deprecated in API 16 * <p>ProgramFragmentFixedFunction is a helper class that provides * a way to make a simple fragment shader without writing any diff --git a/graphics/java/android/renderscript/ProgramRaster.java b/graphics/java/android/renderscript/ProgramRaster.java index c44521b..216cb4e 100644 --- a/graphics/java/android/renderscript/ProgramRaster.java +++ b/graphics/java/android/renderscript/ProgramRaster.java @@ -21,6 +21,7 @@ import android.util.Log; /** + * @hide * @deprecated in API 16 * Program raster is primarily used to specify whether point sprites are enabled and to control * the culling mode. By default, back faces are culled. diff --git a/graphics/java/android/renderscript/ProgramStore.java b/graphics/java/android/renderscript/ProgramStore.java index d0fd6e5..dac9e76 100644 --- a/graphics/java/android/renderscript/ProgramStore.java +++ b/graphics/java/android/renderscript/ProgramStore.java @@ -21,6 +21,7 @@ import android.util.Log; /** + * @hide * <p>ProgramStore contains a set of parameters that control how * the graphics hardware handles writes to the framebuffer. * It could be used to:</p> diff --git a/graphics/java/android/renderscript/ProgramVertex.java b/graphics/java/android/renderscript/ProgramVertex.java index 2bd5124..50e32f6 100644 --- a/graphics/java/android/renderscript/ProgramVertex.java +++ b/graphics/java/android/renderscript/ProgramVertex.java @@ -14,7 +14,8 @@ * limitations under the License. */ - /** +/** + * @hide * <p>The Renderscript vertex program, also known as a vertex shader, describes a stage in * the graphics pipeline responsible for manipulating geometric data in a user-defined way. * The object is constructed by providing the Renderscript system with the following data:</p> @@ -43,6 +44,7 @@ import android.util.Log; /** + * @hide * @deprecated in API 16 * ProgramVertex, also know as a vertex shader, describes a * stage in the graphics pipeline responsible for manipulating @@ -76,14 +78,15 @@ public class ProgramVertex extends Program { } /** - * @deprecated in API 16 - * Builder class for creating ProgramVertex objects. - * The builder starts empty and the user must minimally provide - * the GLSL shader code, and the varying inputs. Constant, or - * uniform parameters to the shader may optionally be provided as - * well. - * - **/ + * @hide + * @deprecated in API 16 + * Builder class for creating ProgramVertex objects. + * The builder starts empty and the user must minimally provide + * the GLSL shader code, and the varying inputs. Constant, or + * uniform parameters to the shader may optionally be provided as + * well. + * + **/ public static class Builder extends BaseProgramBuilder { /** * @deprecated in API 16 diff --git a/graphics/java/android/renderscript/ProgramVertexFixedFunction.java b/graphics/java/android/renderscript/ProgramVertexFixedFunction.java index 88cade4..ad486f3 100644 --- a/graphics/java/android/renderscript/ProgramVertexFixedFunction.java +++ b/graphics/java/android/renderscript/ProgramVertexFixedFunction.java @@ -22,6 +22,7 @@ import android.util.Log; /** + * @hide * @deprecated in API 16 * ProgramVertexFixedFunction is a helper class that provides a * simple way to create a fixed function emulation vertex shader diff --git a/graphics/java/android/renderscript/RSSurfaceView.java b/graphics/java/android/renderscript/RSSurfaceView.java index 82ed95c..3c6c720 100644 --- a/graphics/java/android/renderscript/RSSurfaceView.java +++ b/graphics/java/android/renderscript/RSSurfaceView.java @@ -30,6 +30,7 @@ import android.view.SurfaceHolder; import android.view.SurfaceView; /** + * @hide * @deprecated in API 16 * The Surface View for a graphics renderscript (RenderScriptGL) to draw on. * diff --git a/graphics/java/android/renderscript/RSTextureView.java b/graphics/java/android/renderscript/RSTextureView.java index ed04000..7eeeeae 100644 --- a/graphics/java/android/renderscript/RSTextureView.java +++ b/graphics/java/android/renderscript/RSTextureView.java @@ -29,6 +29,7 @@ import android.util.Log; import android.view.TextureView; /** + * @hide * @deprecated in API 16 * The Texture View for a graphics renderscript (RenderScriptGL) * to draw on. diff --git a/graphics/java/android/renderscript/RenderScriptGL.java b/graphics/java/android/renderscript/RenderScriptGL.java index 5269405..52034b1 100644 --- a/graphics/java/android/renderscript/RenderScriptGL.java +++ b/graphics/java/android/renderscript/RenderScriptGL.java @@ -29,6 +29,7 @@ import android.view.SurfaceHolder; import android.view.SurfaceView; /** + * @hide * @deprecated in API 16 * The Graphics derivitive of Renderscript. Extends the basic context to add a * root script which is the display window for graphical output. When the diff --git a/graphics/java/android/renderscript/package.html b/graphics/java/android/renderscript/package.html index 5eab23c..eb178c1 100644 --- a/graphics/java/android/renderscript/package.html +++ b/graphics/java/android/renderscript/package.html @@ -1,86 +1,10 @@ <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.</p> +<p>RenderScript provides support for high-performance computation across heterogeneous processors.</p> <p>For more information, see the -<a href="{@docRoot}guide/topics/renderscript/index.html">Renderscript</a> developer guide.</p> +<a href="{@docRoot}guide/topics/renderscript/index.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 -allocation and lifecycle management of the Renderscript enabled application and calls the Renderscript -code through high level entry points. The Android build tools generate these entry points through reflection on -the native Renderscript code, which you write in C (C99 standard). The Renderscript code -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-11/renderscript</code> directory. -The Android system APIs are broken into a few main groups:</p> - -<h4>Core</h4> -<p>These classes are used internally by the system for memory allocation. They are used by the classes that -are generated by the build tools:</p> -<ul> - <li>Allocation</li> - <li>Element</li> - <li>Type</li> - <li>Script</li> -</ul> - - -<h4>Data Types</h4> -<p>These data types are used by the classes that are generated -by the build tools. They are the reflected counterparts of the native data types that -are defined by the native Renderscript APIs and used by your Renderscript code. The -classes include:</p> -<ul> - <li>Byte2, Byte3, and Byte4</li> - <li>Float2, Float3, Float4</li> - <li>Int2, Int3, Int4</li> - <li>Long2, Long3, Long4</li> - <li>Matrix2f, Matrix3f, Matrix4f</li> - <li>Short2, Short3, Short4</li> -</ul> - -<p>For example, if you declared the following struct in your .rs Renderscript file:</p> - -<pre>struct Hello { float3 position; rs_matrix4x4 transform; }</pre> - -<p>The build tools generate a class through reflection that looks like the following:</p> -<pre> -class Hello { - static public class Item { - Float4 position; - Matrix4f transform; - } -Element createElement(RenderScript rs) { - Element.Builder eb = new Element.Builder(rs); - eb.add(Element.F32_3(rs), "position"); - eb.add(Element.MATRIX_4X4(rs), "transform"); - return eb.create(); - } -} -</pre> - -<h4>Graphics</h4> -<p>These classes are specific to graphics Renderscripts and support a typical rendering -pipeline.</p> -<ul> -<li>Mesh</li> -<li>ProgramFragment</li> -<li>ProgramRaster</li> -<li>ProgramStore</li> -<li>ProgramVertex</li> -<li>RSSurfaceView</li> -<li>Sampler</li> -</ul> - -</p> </BODY> </HTML> |