README.md
1 Android BasicRenderScript Sample
2 ===================================
3
4 This sample demonstrates using RenderScript to perform basic image manipulation. Specifically, it allows users
5 to dynamically adjust the saturation for an image using a slider. A custom RenderScript kernel performs the saturation
6 adjustment, running the computation on the device's GPU or other compute hardware as deemed appropriate by the system.
7
8 Introduction
9 ------------
10
11 [RenderScript][1] is a framework for running computationally intensive tasks at high performance on Android. RenderScript is
12 primarily oriented for use with data-parallel computation, although serial computationally intensive workloads can
13 benefit as well.
14
15 The RenderScript runtime will parallelize work across all processors available on a device, such as multi-core CPUs,
16 GPUs, or DSPs, allowing you to focus on expressing algorithms rather than scheduling work or load balancing.
17 RenderScript is especially useful for applications performing image processing, computational photography, or computer
18 vision.
19
20 This sample demonstrates the fundamentals of writing a RenderScript compute kernel, and using it to perform basic image
21 manipulation. In this case, each pixel is transformed based on a liner interpolation between its original
22 RGB value and it's luminance (black-and-white) value, weighted based on the user's specified saturation target.
23
24 [1]: http://developer.android.com/guide/topics/renderscript/compute.html
25 [2]: http://developer.android.com/reference/renderscript/rs__cl_8rsh.html#a254612a612ff7539b01a1478e03d8697
26
27 Pre-requisites
28 --------------
29
30 - Android SDK v21
31 - Android Build Tools v21.1.1
32 - Android Support Repository
33
34 Screenshots
35 -------------
36
37 <img src="screenshots/main.png" height="400" alt="Screenshot"/>
38
39 Getting Started
40 ---------------
41
42 This sample uses the Gradle build system. To build this project, use the
43 "gradlew build" command or use "Import Project" in Android Studio.
44
45 Support
46 -------
47
48 - Google+ Community: https://plus.google.com/communities/105153134372062985968
49 - Stack Overflow: http://stackoverflow.com/questions/tagged/android
50
51 If you've found an error in this sample, please file an issue:
52 https://github.com/googlesamples/android-BasicRenderScript
53
54 Patches are encouraged, and may be submitted by forking this project and
55 submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
56
57 License
58 -------
59
60 Copyright 2014 The Android Open Source Project, Inc.
61
62 Licensed to the Apache Software Foundation (ASF) under one or more contributor
63 license agreements. See the NOTICE file distributed with this work for
64 additional information regarding copyright ownership. The ASF licenses this
65 file to you under the Apache License, Version 2.0 (the "License"); you may not
66 use this file except in compliance with the License. You may obtain a copy of
67 the License at
68
69 http://www.apache.org/licenses/LICENSE-2.0
70
71 Unless required by applicable law or agreed to in writing, software
72 distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
73 WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
74 License for the specific language governing permissions and limitations under
75 the License.
76