| Alex Sakhartchouk | 14607a6 | 2012-03-21 09:58:15 -0700 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright (C) 2012 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | /*! \mainpage notitle |
| 18 | * |
| 19 | * Renderscript is a high-performance runtime that provides graphics rendering and |
| 20 | * compute operations at the native level. Renderscript code is compiled on devices |
| 21 | * at runtime to allow platform-independence as well. |
| 22 | * This reference documentation describes the Renderscript runtime APIs, which you |
| 23 | * can utilize to write Renderscript code in C99. The Renderscript header |
| 24 | * files are automatically included for you, except for the rs_graphics.rsh header. If |
| 25 | * you are doing graphics rendering, include the graphics header file like this: |
| 26 | * |
| 27 | * <code>#include "rs_graphics.rsh"</code> |
| 28 | * |
| 29 | * To use Renderscript, you need to utilize the Renderscript runtime APIs documented here |
| 30 | * as well as the Android framework APIs for Renderscript. |
| 31 | * For documentation on the Android framework APIs, see the <a target="_parent" href= |
| 32 | * "http://developer.android.com/reference/android/renderscript/package-summary.html"> |
| 33 | * android.renderscript</a> package reference. |
| 34 | * For more information on how to develop with Renderscript and how the runtime and |
| 35 | * Android framework APIs interact, see the <a target="_parent" href= |
| 36 | * "http://developer.android.com/guide/topics/renderscript/index.html">Renderscript |
| 37 | * developer guide</a> and the <a target="_parent" href= |
| 38 | * "http://developer.android.com/resources/samples/RenderScript/index.html"> |
| 39 | * Renderscript samples</a>. |
| 40 | */ |
| 41 | |
| 42 | /** @file rs_sampler.rsh |
| 43 | * \brief Sampler routines |
| 44 | * |
| 45 | * |
| 46 | */ |
| 47 | |
| 48 | #ifndef __RS_SAMPLER_RSH__ |
| 49 | #define __RS_SAMPLER_RSH__ |
| 50 | |
| 51 | /** |
| 52 | * @hide |
| 53 | * Get sampler minification value |
| 54 | * |
| 55 | * @param pr |
| 56 | */ |
| 57 | extern rs_sampler_value __attribute__((overloadable)) |
| 58 | rsSamplerGetMinification(rs_sampler s); |
| 59 | |
| 60 | /** |
| 61 | * @hide |
| 62 | * Get sampler magnification value |
| 63 | * |
| 64 | * @param pr |
| 65 | */ |
| 66 | extern rs_sampler_value __attribute__((overloadable)) |
| 67 | rsSamplerGetMagnification(rs_sampler s); |
| 68 | |
| 69 | /** |
| 70 | * @hide |
| 71 | * Get sampler wrap S value |
| 72 | * |
| 73 | * @param pr |
| 74 | */ |
| 75 | extern rs_sampler_value __attribute__((overloadable)) |
| 76 | rsSamplerGetWrapS(rs_sampler s); |
| 77 | |
| 78 | /** |
| 79 | * @hide |
| 80 | * Get sampler wrap T value |
| 81 | * |
| 82 | * @param pr |
| 83 | */ |
| 84 | extern rs_sampler_value __attribute__((overloadable)) |
| 85 | rsSamplerGetWrapT(rs_sampler s); |
| 86 | |
| 87 | /** |
| 88 | * @hide |
| 89 | * Get sampler anisotropy |
| 90 | * |
| 91 | * @param pr |
| 92 | */ |
| 93 | extern float __attribute__((overloadable)) |
| 94 | rsSamplerGetAnisotropy(rs_sampler s); |
| 95 | |
| 96 | #endif // __RS_SAMPLER_RSH__ |
| 97 | |