Commit Graph

47 Commits

Author SHA1 Message Date
Yang Ni
51f1e93be7 Updated API reference doc for Single-Source RS
Bug: 29544612
Bug: 29879448

This is auto-generated by running frameworks/rs/api/generate.sh, but
only for rsForEach() and rsCreateAllocation().
Editings to the .spec files in frameworks/rs/api were made based on
feedbacks here.

Staging server:
http://yangni.mtv.corp.google.com/guide/topics/renderscript/reference/rs_for_each.html
http://yangni.mtv.corp.google.com/guide/topics/renderscript/reference/rs_allocation_create.html

Change-Id: I072f2f3fffaa9a1a2af101fa8061f61089daf208
2016-09-02 16:04:34 -07:00
Yang Ni
c069ed7f8c Updated user document for Single-Source RenderScript
Bug: 29875503
Bug: 29879448

Added a section introducing the new single-source feature.

Local staging:
http://yangni.mtv.corp.google.com/guide/topics/renderscript/compute.html

This updates
https://developer.android.com/guide/topics/renderscript/compute.html

Change-Id: I62dda3ab60b1678a9580fd2873f64f33d9696e13
2016-08-22 23:33:13 +00:00
David Gross
b50e856fc7 Update RenderScript docs: reduction, other API 23/24 changes, cleanup.
Substantive changes:
- Add discussion of reduction kernels.
- Use RS_KERNEL in place of __attribute__((kernel)).
- Discuss "context" special argument.
- Special arguments x, y, z may be of type int.
- Discuss multiple inputs for mapping kernels.
- Mention that script-side global writes are not visible in Java.
- Rewrite part of discussion regarding when to use support library.
- Change minimum device version for support library from Android 2.2 (API level 8)
  to Android 2.3 (API level 9).

Stylistic changes (better conformance with style guide):
- Proper use of <i> (italic) versus <em> (emphasis).
- Proper case for headings.
- Proper pattern for Android version numbers.
- Do not use e.g. or i.e.
- Prefer active rather than passive voice.
- Prefer present rather than future tense.

Miscellaneous minor editorial changes.

Bug: 27299393
Bug: 30000147

Change-Id: Ie0a26152714cf8f619d4914218f7262d675bb25f
(cherry picked from commit 05eef3040e)
2016-08-12 11:06:29 -07:00
Elliot Waite
c4ae7827e2 Fix code tags that contain html encoded characters, and fix at links.
Change-Id: I1ab2275ac17d75afaa8f3f0039b26633365bcb3a
2016-07-22 18:29:36 -07:00
Mark Lu
c4a0139e26 docs: remove trailing white space from jd files
Change-Id: Id7fb958460bf2f28d88c6120df0395690f32783a
2016-07-18 10:42:11 -07:00
Hemal Patel
2a3336813a Docs: Changed sample link under Related Samples am: ab5de09e7e
am: d5af0a1214

Change-Id: I70c520f7ee4141b3c7c193aef6e4559ea5b35cc9
2016-06-20 22:01:02 +00:00
Hemal Patel
ab5de09e7e Docs: Changed sample link under Related Samples
Changed the Hello Compute sample link to point to Github Android Samples page

Bug: 28928053
Change-Id: I0673620f8beb03297b5dea0b50f4ddbd9d6e25db
2016-06-17 16:29:47 -07:00
Trevor Johns
682c24e228 Resolve merge conflicts of a5060ee to nyc-dev
This undoes the automerger skip which occured in
commit e740c84dc3 and
replays it as a standard (NOT -s ours) merge.

Change-Id: If5a47be26f73d6a0735c425cd66310a3e2a89086
2016-04-19 02:03:59 -07:00
Miao Wang
a51f9c0418 [RenderScript] Update documentation about API level and RS Support Lib.
Bug: 22767853

  - Correct the description about renderscriptTargetApi: Use the lowest
    API level providing all the functionality in the code.
  - Update the sample gradle config to use the up-to-date and stable
    version of Build-Tools.

Change-Id: Ie8008acafb270fda9e2c928953568461f6f6f476
2016-03-29 14:51:02 -07:00
Brian Carlstrom
b61a0dae09 Fix typo in Conversion Functions doc
Bug: 27529815
Change-Id: I470348a232d9955d23463ec32c2de60abb44bc3f
2016-03-29 14:49:09 -07:00
Joe Fernandez
a7a294cfcb docs: Android Eclipse ADT update and removals - Batch 03
b/25192800

Change-Id: I2ec275ba81449db5d695483e0adee70e4eb579f3
2015-12-17 14:48:55 -08:00
Stephen Hines
a13980ceaa am ce6b9db4: Merge "Update docs for RS object API fixes."
* commit 'ce6b9db498b67c8136a9267c2f87b432a5f22206':
  Update docs for RS object API fixes.
2015-09-15 23:09:59 +00:00
Stephen Hines
12f2724bc9 am 3460304c: Merge "Update RS docs for M-related changes."
* commit '3460304c5c656b2cbf2b371720edff4fd662b02d':
  Update RS docs for M-related changes.
2015-09-11 02:47:16 +00:00
Stephen Hines
663c81b4c3 Update docs for RS object API fixes.
Bug: 22926131

This is the documentation update corresponding to our new named
structures for RS object types.

Change-Id: I282ce78192da7c9f68951ce05100819a306694f0
2015-09-10 18:52:40 -07:00
Stephen Hines
5f785909f3 Update RS docs for M-related changes.
This includes FP16 and the rs_kernel_context object.

Change-Id: If5574bba85060e2bfe6c4d8f2b3cc1b49827a05a
2015-09-10 11:08:29 -07:00
Stephen Hines
fd1fd6eefb Don't make bad RS API level recommendations.
This document was recommending that users always target the latest
available API level, but that will prevent optimization on older
devices. Instead, they should be setting the minimum value that they
require.

Change-Id: I27c65872d124ed0beaeb2125d68d1d636ffa9352
2015-08-18 17:41:41 -07:00
Joe Fernandez
bee84879a9 am 5c7817bc: Merge "Update the RenderScript runtime documentation for MNC." into mnc-dev
* commit '5c7817bc2f784e6f48a7d26aadf901ac3eb7aca2':
  Update the RenderScript runtime documentation for MNC.
2015-08-16 22:17:14 +00:00
Jean-Luc Brouillet
8bf69a4867 Update the RenderScript runtime documentation for MNC.
Update the documentation to include the features introduced in MNC.

b/23190418

Change-Id: I2c6dc11029a9bc0c2ca9bb8b712d4fd4660c3b29
2015-08-14 18:18:15 -07:00
Stephen Hines
905ff51c22 am a8b8fe91: am 61e8329b: Merge "Replace parentheses with curly braces to fix vector doc bug."
* commit 'a8b8fe91ee2781805eb310b8775162a6d4de4e31':
  Replace parentheses with curly braces to fix vector doc bug.
2015-06-30 01:33:56 +00:00
Stephen Hines
6c304d36b9 Replace parentheses with curly braces to fix vector doc bug.
https://code.google.com/p/android/issues/detail?id=178299

Change-Id: I3ae31d48a39e8db9976fdedde560e870b23e2c83
2015-06-29 18:06:10 -07:00
Rich Slogar
a27dd186b2 am e78f136b: Merge "docs: renderscript using gradle settings" into lmp-docs
* commit 'e78f136b1dbe11dc98c5699da24df49fd9dae795':
  docs: renderscript using gradle settings
2015-05-12 17:05:40 +00:00
Joe Fernandez
1dc26b8c1e docs: remove obsolete renderscript reference framer page
Change-Id: I9ec7ad462584d2e2b7132b1ddbf9306c9df83b10
2015-05-07 15:14:31 -07:00
Jean-Luc Brouillet
e9f17cda80 docs: Overhaul of the RenderScript reference documentation.
cherry-pick from CL: https://android-review.googlesource.com/148241

This CL replaces the Doxygen generated documentation by one that's created
by our internal tool found in framework/rs/api.  The big advantages:

- Can handle overloaded functions.  Doxygen could not and RenderScript has many.
- Can have version information.
- Can match the look of the Java documentation.
- Cleaner look and no leaking of internal paths.

This CL also include changes introduced by the L release which was missing
previously.

Change-Id: Icade41d04d35e45c445ad952bb8ce14389f9f59f
2015-05-05 15:20:50 -07:00
Jean-Luc Brouillet
57e1e8bf52 Overhaul of the RenderScript reference documentation.
This CL replaces the Doxygen generated documentation by one that's created
by our internal tool found in framework/rs/api.  The big advantages:

- Can handle overloaded functions.  Doxygen could not and RenderScript has many.
- Can have version information.
- Can match the look of the Java documentation.
- Cleaner look and no leaking of internal paths.

This CL also include changes introduced by the L release which was missing
previously.

Change-Id: I5ff712cb6dc9993a93cb3c356602825fdfc8d81e
2015-04-30 17:52:33 -07:00
Rich Slogar
8f2eabb5e4 docs: renderscript using gradle settings
b/13532631

Change-Id: I35808faf3fae8706ca6f9e46408c791594ab1467
2015-03-12 11:23:57 -07:00
Tim Murray
e87234f3ba Update RenderScript docs.
android.renderscript is *not* deprecated at all and continues to
be under heavy development.

Change-Id: Ia5fcfbe89d30e92b97439c2864fd67de32b81fa4
2014-08-25 11:08:24 -07:00
Stephen Hines
7f75eaa218 Add message to RS docs about application vs. library packaging.
Change-Id: I49b694629ded066e5ee9c1af29970c59cb637fdd
2014-01-30 19:43:20 -08:00
Joe Fernandez
38f8b7371a docs: RenderScript Dev Guide fixes
Change-Id: I0d0ef44df989419e9335789e2957fbd94c49615f
2013-09-18 16:08:25 -07:00
Joe Fernandez
0edad69ab4 Update RenderScript docs to include Support Library APIs
Added new section to explain how to access the Support Library
RenderScript APIs in Eclipse.

Change-Id: Ife6e25bcc7b91c39bb399d1ace624e106a3f38bc
(cherry picked from commit f82b04d4ec)
2013-09-16 17:27:08 +00:00
Tim Murray
015d26837c Update RenderScript API guide.
bug 8570568
Change-Id: Ib49a63f15ce421115179764a14597b2746a1f2e7
2013-06-05 11:28:46 -07:00
Dirk Dougherty
20d47ca81d Doc change: add developer video to carousel and spotlight pages.
Change-Id: Ia12eb98f4d86edea72dfa1142d782ea24d3373f7
2013-01-14 20:47:11 -08:00
Robert Ly
3419e07873 docs: add fs to rs
Change-Id: Icb08977ecf5acbddff35965fa1d7360cece0dd31
2012-11-12 21:56:32 -08:00
Scott Main
b111b5785e docs: fix hdef variable
Change-Id: I737258d454f426506e529e3d48fefb1397b9e8d3
2012-08-07 13:59:12 -07:00
Robert Ly
864090eeaa docs: remove graphics rs docs and restructure existing docs
Change-Id: I8603c827095143327053e8eba855177ec466a948
2012-06-26 17:51:19 -07:00
Scott Main
50e990c64f Massive clobber of all HTML files in developer docs for new site design
Change-Id: Idc55a0b368c1d2c1e7d4999601b739dd57f08eb3
2012-06-21 21:27:30 -07:00
Robert Ly
af16675097 docs: fixing renderscript doc bug 6111834
Change-Id: Iea6fdaf03a0064462d57e4b62500ad689ba2b824
2012-04-10 11:56:33 -07:00
Robert Ly
f11ffc1178 docs: fixing bug 5942573
Change-Id: I2479dc8916f98a8bf7dbec95dc29cbd871c51be5
2012-02-22 16:35:42 -08:00
Robert Ly
4e552533ea resolved conflicts for merge of b078d942 to ics-mr1
Change-Id: I831c06f2c198cc8825788a05770397457e8d511c
2012-01-19 13:25:07 -08:00
Robert Ly
b078d94291 cherrypick from master docs: Renderscript changes Change-Id: Ic84b7d8c5c48e118f337e60c8bb5b8bc68b0da16
Change-Id: I8bd2ba1f0a4f284c52cfd6de817744264d2c50de
2012-01-19 12:36:06 -08:00
Robert Ly
013dbcf078 Merge "docs: adding rs api docs" into ics-mr1 2012-01-18 13:18:11 -08:00
Robert Ly
dc6720f34b docs: adding rs api docs
Change-Id: Ib56ee177439e9c124d0ac4053ed4173f8a4be1aa
2012-01-17 16:14:44 -08:00
Scott Main
cd1b08e1e2 docs: fix broken links in .jd docs
Change-Id: Ide8bb1a11a704d6821b52a0128b24a76de2e707f
2012-01-03 15:12:51 -08:00
Scott Main
acf1038a26 docs: remove broken link from renderscript docs
bug: 5696178

Change-Id: I78285ac67749fb3936e359968d28bbeb539ea7dc
2011-12-01 11:11:08 -08:00
Robert Ly
93f97f53df Merge "docs: rs link fixes" into ics-mr0 2011-10-18 17:20:57 -07:00
Robert Ly
849759380e docs: rs link fixes
Change-Id: I5c8e16a914b314522da3ba6f1a75c36a831b4668
2011-10-18 17:16:17 -07:00
Scott Main
19aad293c0 docs: fix misc broken links
Change-Id: Ie0406bce6c4f1fa03b16bba76ed82ac75bfbb5f7
2011-10-18 16:57:32 -07:00
Robert Ly
f197b639ec cherrypick from hc mr1 Change-Id: I106cddd6e22d72c48edeaadbf296b0453813d06a
Change-Id: I8b7848139e93df385d0727f9536be73124687cc7
2011-06-14 11:27:41 -07:00