blob: 13ae1fb7182efe9f192190e3ae27dd4d9bc7fc1c [file] [log] [blame]
Jason Samsd19f10d2009-05-22 14:03:28 -07001/*
2 * Copyright (C) 2007 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#ifndef RENDER_SCRIPT_H
18#define RENDER_SCRIPT_H
19
20#include <stdint.h>
21#include <sys/types.h>
22
23#ifdef __cplusplus
24extern "C" {
25#endif
26
27//////////////////////////////////////////////////////
Jason Sams1bada8c2009-08-09 17:01:55 -070028//
Jason Samsd19f10d2009-05-22 14:03:28 -070029
30typedef void * RsAdapter1D;
31typedef void * RsAdapter2D;
32typedef void * RsAllocation;
Jason Samsf4687002010-03-10 17:30:41 -080033typedef void * RsAnimation;
Jason Samsd19f10d2009-05-22 14:03:28 -070034typedef void * RsContext;
35typedef void * RsDevice;
36typedef void * RsElement;
Jason Sams64676f32009-07-08 18:01:53 -070037typedef void * RsFile;
Alex Sakhartchouk9b949fc2010-06-24 17:15:34 -070038typedef void * RsFont;
Jason Samsd19f10d2009-05-22 14:03:28 -070039typedef void * RsSampler;
40typedef void * RsScript;
Alex Sakhartchouk164aaed2010-07-01 16:14:06 -070041typedef void * RsMesh;
Jason Samsd19f10d2009-05-22 14:03:28 -070042typedef void * RsType;
Jason Samsbba134c2009-06-22 15:49:21 -070043typedef void * RsLight;
Alex Sakhartchoukaae74ad2010-06-04 10:06:50 -070044typedef void * RsObjectBase;
Jason Samsd19f10d2009-05-22 14:03:28 -070045
Jason Sams0011bcf2009-12-15 12:58:36 -080046typedef void * RsProgram;
Jason Samsd19f10d2009-05-22 14:03:28 -070047typedef void * RsProgramVertex;
48typedef void * RsProgramFragment;
Jason Sams54db59c2010-05-13 18:30:11 -070049typedef void * RsProgramStore;
Jason Samsebfb4362009-09-23 13:57:02 -070050typedef void * RsProgramRaster;
51
Jason Sams8a64743f2010-03-01 15:31:04 -080052typedef void (* RsBitmapCallback_t)(void *);
53
Jason Samsebfb4362009-09-23 13:57:02 -070054enum RsDeviceParam {
55 RS_DEVICE_PARAM_FORCE_SOFTWARE_GL,
56 RS_DEVICE_PARAM_COUNT
57};
Jason Samsd19f10d2009-05-22 14:03:28 -070058
59RsDevice rsDeviceCreate();
60void rsDeviceDestroy(RsDevice);
Jason Samsebfb4362009-09-23 13:57:02 -070061void rsDeviceSetConfig(RsDevice, RsDeviceParam, int32_t value);
Jason Samsd19f10d2009-05-22 14:03:28 -070062
Jason Sams704ff642010-02-09 16:05:07 -080063RsContext rsContextCreate(RsDevice, uint32_t version);
64RsContext rsContextCreateGL(RsDevice, uint32_t version, bool useDepth);
Jason Samsd19f10d2009-05-22 14:03:28 -070065void rsContextDestroy(RsContext);
66
Jason Sams516c3192009-10-06 13:58:47 -070067uint32_t rsContextGetMessage(RsContext, void *data, size_t *receiveLen, size_t bufferLen, bool wait);
68void rsContextInitToClient(RsContext);
69void rsContextDeinitToClient(RsContext);
70
Jason Sams1bada8c2009-08-09 17:01:55 -070071#define RS_MAX_TEXTURE 2
Jason Samsa09a6e12010-01-06 11:57:52 -080072#define RS_MAX_ATTRIBS 16
Jason Sams1bada8c2009-08-09 17:01:55 -070073
Jason Samsd19f10d2009-05-22 14:03:28 -070074enum RsDataType {
Jason Sams718cd1f2009-12-23 14:35:29 -080075 RS_TYPE_NONE,
76 RS_TYPE_FLOAT_16,
77 RS_TYPE_FLOAT_32,
78 RS_TYPE_FLOAT_64,
79 RS_TYPE_SIGNED_8,
80 RS_TYPE_SIGNED_16,
81 RS_TYPE_SIGNED_32,
82 RS_TYPE_SIGNED_64,
83 RS_TYPE_UNSIGNED_8,
84 RS_TYPE_UNSIGNED_16,
85 RS_TYPE_UNSIGNED_32,
86 RS_TYPE_UNSIGNED_64,
87
Jason Samsf110d4b2010-06-21 17:42:41 -070088 RS_TYPE_BOOLEAN,
89
Jason Sams718cd1f2009-12-23 14:35:29 -080090 RS_TYPE_UNSIGNED_5_6_5,
91 RS_TYPE_UNSIGNED_5_5_5_1,
92 RS_TYPE_UNSIGNED_4_4_4_4,
93
Jason Sams1d45c472010-08-25 14:31:48 -070094 RS_TYPE_MATRIX_4X4,
95 RS_TYPE_MATRIX_3X3,
96 RS_TYPE_MATRIX_2X2,
97
98 RS_TYPE_ELEMENT = 1000,
Jason Sams718cd1f2009-12-23 14:35:29 -080099 RS_TYPE_TYPE,
100 RS_TYPE_ALLOCATION,
101 RS_TYPE_SAMPLER,
102 RS_TYPE_SCRIPT,
103 RS_TYPE_MESH,
104 RS_TYPE_PROGRAM_FRAGMENT,
105 RS_TYPE_PROGRAM_VERTEX,
106 RS_TYPE_PROGRAM_RASTER,
Jason Sams1d45c472010-08-25 14:31:48 -0700107 RS_TYPE_PROGRAM_STORE,
Jason Samsd19f10d2009-05-22 14:03:28 -0700108};
109
110enum RsDataKind {
111 RS_KIND_USER,
Jason Sams718cd1f2009-12-23 14:35:29 -0800112
Jason Samse29f3e72010-06-08 15:40:48 -0700113 RS_KIND_PIXEL_L = 7,
Jason Sams718cd1f2009-12-23 14:35:29 -0800114 RS_KIND_PIXEL_A,
115 RS_KIND_PIXEL_LA,
116 RS_KIND_PIXEL_RGB,
117 RS_KIND_PIXEL_RGBA,
Jason Samsd19f10d2009-05-22 14:03:28 -0700118};
119
Jason Samsd19f10d2009-05-22 14:03:28 -0700120enum RsSamplerParam {
121 RS_SAMPLER_MIN_FILTER,
122 RS_SAMPLER_MAG_FILTER,
123 RS_SAMPLER_WRAP_S,
124 RS_SAMPLER_WRAP_T,
Alex Sakhartchoukf5b35102010-09-30 11:36:37 -0700125 RS_SAMPLER_WRAP_R,
126 RS_SAMPLER_ANISO
Jason Sams1bada8c2009-08-09 17:01:55 -0700127};
Jason Samsd19f10d2009-05-22 14:03:28 -0700128
129enum RsSamplerValue {
130 RS_SAMPLER_NEAREST,
131 RS_SAMPLER_LINEAR,
132 RS_SAMPLER_LINEAR_MIP_LINEAR,
133 RS_SAMPLER_WRAP,
134 RS_SAMPLER_CLAMP
Jason Sams1bada8c2009-08-09 17:01:55 -0700135};
Jason Samsd19f10d2009-05-22 14:03:28 -0700136
137enum RsDimension {
138 RS_DIMENSION_X,
139 RS_DIMENSION_Y,
140 RS_DIMENSION_Z,
141 RS_DIMENSION_LOD,
142 RS_DIMENSION_FACE,
143
Jason Sams1bada8c2009-08-09 17:01:55 -0700144 RS_DIMENSION_ARRAY_0 = 100,
145 RS_DIMENSION_ARRAY_1,
146 RS_DIMENSION_ARRAY_2,
Jason Samsd19f10d2009-05-22 14:03:28 -0700147 RS_DIMENSION_ARRAY_3,
148 RS_DIMENSION_MAX = RS_DIMENSION_ARRAY_3
149};
150
151enum RsDepthFunc {
152 RS_DEPTH_FUNC_ALWAYS,
153 RS_DEPTH_FUNC_LESS,
154 RS_DEPTH_FUNC_LEQUAL,
155 RS_DEPTH_FUNC_GREATER,
156 RS_DEPTH_FUNC_GEQUAL,
157 RS_DEPTH_FUNC_EQUAL,
158 RS_DEPTH_FUNC_NOTEQUAL
159};
160
161enum RsBlendSrcFunc {
Jason Samsb0ec1b42009-07-28 12:02:16 -0700162 RS_BLEND_SRC_ZERO, // 0
163 RS_BLEND_SRC_ONE, // 1
164 RS_BLEND_SRC_DST_COLOR, // 2
165 RS_BLEND_SRC_ONE_MINUS_DST_COLOR, // 3
166 RS_BLEND_SRC_SRC_ALPHA, // 4
167 RS_BLEND_SRC_ONE_MINUS_SRC_ALPHA, // 5
168 RS_BLEND_SRC_DST_ALPHA, // 6
169 RS_BLEND_SRC_ONE_MINUS_DST_ALPHA, // 7
170 RS_BLEND_SRC_SRC_ALPHA_SATURATE // 8
Jason Samsd19f10d2009-05-22 14:03:28 -0700171};
172
173enum RsBlendDstFunc {
Jason Samsb0ec1b42009-07-28 12:02:16 -0700174 RS_BLEND_DST_ZERO, // 0
175 RS_BLEND_DST_ONE, // 1
176 RS_BLEND_DST_SRC_COLOR, // 2
177 RS_BLEND_DST_ONE_MINUS_SRC_COLOR, // 3
178 RS_BLEND_DST_SRC_ALPHA, // 4
179 RS_BLEND_DST_ONE_MINUS_SRC_ALPHA, // 5
180 RS_BLEND_DST_DST_ALPHA, // 6
181 RS_BLEND_DST_ONE_MINUS_DST_ALPHA // 7
Jason Samsd19f10d2009-05-22 14:03:28 -0700182};
183
184enum RsTexEnvMode {
Jason Sams68afd012009-12-17 16:55:08 -0800185 RS_TEX_ENV_MODE_NONE,
Jason Samsd19f10d2009-05-22 14:03:28 -0700186 RS_TEX_ENV_MODE_REPLACE,
187 RS_TEX_ENV_MODE_MODULATE,
188 RS_TEX_ENV_MODE_DECAL
189};
190
Jason Sams0011bcf2009-12-15 12:58:36 -0800191enum RsProgramParam {
192 RS_PROGRAM_PARAM_INPUT,
193 RS_PROGRAM_PARAM_OUTPUT,
194 RS_PROGRAM_PARAM_CONSTANT,
Jason Sams7e5ab3b2009-12-15 13:27:04 -0800195 RS_PROGRAM_PARAM_TEXTURE_COUNT,
Jason Sams0011bcf2009-12-15 12:58:36 -0800196};
197
Jason Sams7c878f32009-06-30 14:13:04 -0700198enum RsPrimitive {
199 RS_PRIMITIVE_POINT,
200 RS_PRIMITIVE_LINE,
201 RS_PRIMITIVE_LINE_STRIP,
202 RS_PRIMITIVE_TRIANGLE,
203 RS_PRIMITIVE_TRIANGLE_STRIP,
204 RS_PRIMITIVE_TRIANGLE_FAN
205};
Jason Samsd19f10d2009-05-22 14:03:28 -0700206
Jason Sams156cce62010-03-03 13:03:18 -0800207enum RsError {
208 RS_ERROR_NONE,
209 RS_ERROR_BAD_SHADER,
Jason Samsf4687002010-03-10 17:30:41 -0800210 RS_ERROR_BAD_SCRIPT,
211 RS_ERROR_BAD_VALUE,
212 RS_ERROR_OUT_OF_MEMORY
213};
214
215enum RsAnimationInterpolation {
216 RS_ANIMATION_INTERPOLATION_STEP,
217 RS_ANIMATION_INTERPOLATION_LINEAR,
218 RS_ANIMATION_INTERPOLATION_BEZIER,
219 RS_ANIMATION_INTERPOLATION_CARDINAL,
220 RS_ANIMATION_INTERPOLATION_HERMITE,
221 RS_ANIMATION_INTERPOLATION_BSPLINE
222};
223
224enum RsAnimationEdge {
225 RS_ANIMATION_EDGE_UNDEFINED,
226 RS_ANIMATION_EDGE_CONSTANT,
227 RS_ANIMATION_EDGE_GRADIENT,
228 RS_ANIMATION_EDGE_CYCLE,
229 RS_ANIMATION_EDGE_OSCILLATE,
230 RS_ANIMATION_EDGE_CYLE_RELATIVE
Jason Sams156cce62010-03-03 13:03:18 -0800231};
232
Alex Sakhartchoukaae74ad2010-06-04 10:06:50 -0700233enum RsA3DClassID {
234 RS_A3D_CLASS_ID_UNKNOWN,
235 RS_A3D_CLASS_ID_MESH,
Alex Sakhartchoukaae74ad2010-06-04 10:06:50 -0700236 RS_A3D_CLASS_ID_TYPE,
237 RS_A3D_CLASS_ID_ELEMENT,
238 RS_A3D_CLASS_ID_ALLOCATION,
239 RS_A3D_CLASS_ID_PROGRAM_VERTEX,
240 RS_A3D_CLASS_ID_PROGRAM_RASTER,
241 RS_A3D_CLASS_ID_PROGRAM_FRAGMENT,
242 RS_A3D_CLASS_ID_PROGRAM_STORE,
243 RS_A3D_CLASS_ID_SAMPLER,
244 RS_A3D_CLASS_ID_ANIMATION,
245 RS_A3D_CLASS_ID_LIGHT,
246 RS_A3D_CLASS_ID_ADAPTER_1D,
247 RS_A3D_CLASS_ID_ADAPTER_2D,
248 RS_A3D_CLASS_ID_SCRIPT_C
249};
250
Alex Sakhartchouk80a4c2c2010-07-12 15:50:32 -0700251enum RsCullMode {
252 RS_CULL_BACK,
253 RS_CULL_FRONT,
254 RS_CULL_NONE
255};
256
Alex Sakhartchoukaae74ad2010-06-04 10:06:50 -0700257typedef struct {
258 RsA3DClassID classID;
259 const char* objectName;
260} RsFileIndexEntry;
261
Jason Sams8f8a5722010-07-15 17:11:13 -0700262// Script to Script
263typedef struct {
264 uint32_t xStart;
265 uint32_t xEnd;
266 uint32_t yStart;
267 uint32_t yEnd;
268 uint32_t zStart;
269 uint32_t zEnd;
270 uint32_t arrayStart;
271 uint32_t arrayEnd;
272
273} RsScriptCall;
274
Jason Sams7eecbf22010-02-23 15:27:51 -0800275#ifndef NO_RS_FUNCS
Jason Samsd19f10d2009-05-22 14:03:28 -0700276#include "rsgApiFuncDecl.h"
Jason Sams7eecbf22010-02-23 15:27:51 -0800277#endif
Jason Samsd19f10d2009-05-22 14:03:28 -0700278
279#ifdef __cplusplus
280};
281#endif
282
283#endif // RENDER_SCRIPT_H
284
285
286