rsDefines.h revision 9e2bda58db9e6427a1640ea302d4df079ffa0252 
1/*
2 * Copyright (C) 2007-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#ifndef RENDER_SCRIPT_DEFINES_H
18#define RENDER_SCRIPT_DEFINES_H
19
20#include <stdint.h>
21#include <sys/types.h>
22
23#ifdef __cplusplus
24extern "C" {
25#endif
26
27//////////////////////////////////////////////////////
28//
29
30typedef void * RsAsyncVoidPtr;
31
32typedef void * RsAdapter1D;
33typedef void * RsAdapter2D;
34typedef void * RsAllocation;
35typedef void * RsAnimation;
36typedef void * RsContext;
37typedef void * RsDevice;
38typedef void * RsElement;
39typedef void * RsFile;
40typedef void * RsFont;
41typedef void * RsSampler;
42typedef void * RsScript;
43typedef void * RsScriptKernelID;
44typedef void * RsScriptFieldID;
45typedef void * RsScriptMethodID;
46typedef void * RsScriptGroup;
47typedef void * RsMesh;
48typedef void * RsPath;
49typedef void * RsType;
50typedef void * RsObjectBase;
51
52typedef void * RsProgram;
53typedef void * RsProgramVertex;
54typedef void * RsProgramFragment;
55typedef void * RsProgramStore;
56typedef void * RsProgramRaster;
57
58typedef void * RsNativeWindow;
59
60typedef void (* RsBitmapCallback_t)(void *);
61
62typedef struct {
63    float m[16];
64} rs_matrix4x4;
65
66typedef struct {
67    float m[9];
68} rs_matrix3x3;
69
70typedef struct {
71    float m[4];
72} rs_matrix2x2;
73
74enum RsDeviceParam {
75    RS_DEVICE_PARAM_FORCE_SOFTWARE_GL,
76    RS_DEVICE_PARAM_COUNT
77};
78
79typedef struct {
80    uint32_t colorMin;
81    uint32_t colorPref;
82    uint32_t alphaMin;
83    uint32_t alphaPref;
84    uint32_t depthMin;
85    uint32_t depthPref;
86    uint32_t stencilMin;
87    uint32_t stencilPref;
88    uint32_t samplesMin;
89    uint32_t samplesPref;
90    float samplesQ;
91} RsSurfaceConfig;
92
93enum RsMessageToClientType {
94    RS_MESSAGE_TO_CLIENT_NONE = 0,
95    RS_MESSAGE_TO_CLIENT_EXCEPTION = 1,
96    RS_MESSAGE_TO_CLIENT_RESIZE = 2,
97    RS_MESSAGE_TO_CLIENT_ERROR = 3,
98    RS_MESSAGE_TO_CLIENT_USER = 4
99};
100
101enum RsAllocationUsageType {
102    RS_ALLOCATION_USAGE_SCRIPT = 0x0001,
103    RS_ALLOCATION_USAGE_GRAPHICS_TEXTURE = 0x0002,
104    RS_ALLOCATION_USAGE_GRAPHICS_VERTEX = 0x0004,
105    RS_ALLOCATION_USAGE_GRAPHICS_CONSTANTS = 0x0008,
106    RS_ALLOCATION_USAGE_GRAPHICS_RENDER_TARGET = 0x0010,
107    RS_ALLOCATION_USAGE_IO_INPUT = 0x0020,
108    RS_ALLOCATION_USAGE_IO_OUTPUT = 0x0040,
109    RS_ALLOCATION_USAGE_SHARED = 0x0080,
110
111    RS_ALLOCATION_USAGE_ALL = 0x00FF
112};
113
114enum RsAllocationMipmapControl {
115    RS_ALLOCATION_MIPMAP_NONE = 0,
116    RS_ALLOCATION_MIPMAP_FULL = 1,
117    RS_ALLOCATION_MIPMAP_ON_SYNC_TO_TEXTURE = 2
118};
119
120enum RsAllocationCubemapFace {
121    RS_ALLOCATION_CUBEMAP_FACE_POSITIVE_X = 0,
122    RS_ALLOCATION_CUBEMAP_FACE_NEGATIVE_X = 1,
123    RS_ALLOCATION_CUBEMAP_FACE_POSITIVE_Y = 2,
124    RS_ALLOCATION_CUBEMAP_FACE_NEGATIVE_Y = 3,
125    RS_ALLOCATION_CUBEMAP_FACE_POSITIVE_Z = 4,
126    RS_ALLOCATION_CUBEMAP_FACE_NEGATIVE_Z = 5
127};
128
129enum RsDataType {
130    RS_TYPE_NONE,
131    RS_TYPE_FLOAT_16,
132    RS_TYPE_FLOAT_32,
133    RS_TYPE_FLOAT_64,
134    RS_TYPE_SIGNED_8,
135    RS_TYPE_SIGNED_16,
136    RS_TYPE_SIGNED_32,
137    RS_TYPE_SIGNED_64,
138    RS_TYPE_UNSIGNED_8,
139    RS_TYPE_UNSIGNED_16,
140    RS_TYPE_UNSIGNED_32,
141    RS_TYPE_UNSIGNED_64,
142
143    RS_TYPE_BOOLEAN,
144
145    RS_TYPE_UNSIGNED_5_6_5,
146    RS_TYPE_UNSIGNED_5_5_5_1,
147    RS_TYPE_UNSIGNED_4_4_4_4,
148
149    RS_TYPE_MATRIX_4X4,
150    RS_TYPE_MATRIX_3X3,
151    RS_TYPE_MATRIX_2X2,
152
153    RS_TYPE_ELEMENT = 1000,
154    RS_TYPE_TYPE,
155    RS_TYPE_ALLOCATION,
156    RS_TYPE_SAMPLER,
157    RS_TYPE_SCRIPT,
158    RS_TYPE_MESH,
159    RS_TYPE_PROGRAM_FRAGMENT,
160    RS_TYPE_PROGRAM_VERTEX,
161    RS_TYPE_PROGRAM_RASTER,
162    RS_TYPE_PROGRAM_STORE,
163    RS_TYPE_FONT,
164
165    RS_TYPE_INVALID = 10000,
166};
167
168enum RsDataKind {
169    RS_KIND_USER,
170
171    RS_KIND_PIXEL_L = 7,
172    RS_KIND_PIXEL_A,
173    RS_KIND_PIXEL_LA,
174    RS_KIND_PIXEL_RGB,
175    RS_KIND_PIXEL_RGBA,
176    RS_KIND_PIXEL_DEPTH,
177
178    RS_KIND_INVALID = 100,
179};
180
181enum RsSamplerParam {
182    RS_SAMPLER_MIN_FILTER,
183    RS_SAMPLER_MAG_FILTER,
184    RS_SAMPLER_WRAP_S,
185    RS_SAMPLER_WRAP_T,
186    RS_SAMPLER_WRAP_R,
187    RS_SAMPLER_ANISO
188};
189
190enum RsSamplerValue {
191    RS_SAMPLER_NEAREST,
192    RS_SAMPLER_LINEAR,
193    RS_SAMPLER_LINEAR_MIP_LINEAR,
194    RS_SAMPLER_WRAP,
195    RS_SAMPLER_CLAMP,
196    RS_SAMPLER_LINEAR_MIP_NEAREST,
197
198    RS_SAMPLER_INVALID = 100,
199};
200
201enum RsTextureTarget {
202    RS_TEXTURE_2D,
203    RS_TEXTURE_CUBE
204};
205
206enum RsDimension {
207    RS_DIMENSION_X,
208    RS_DIMENSION_Y,
209    RS_DIMENSION_Z,
210    RS_DIMENSION_LOD,
211    RS_DIMENSION_FACE,
212
213    RS_DIMENSION_ARRAY_0 = 100,
214    RS_DIMENSION_ARRAY_1,
215    RS_DIMENSION_ARRAY_2,
216    RS_DIMENSION_ARRAY_3,
217    RS_DIMENSION_MAX = RS_DIMENSION_ARRAY_3
218};
219
220enum RsDepthFunc {
221    RS_DEPTH_FUNC_ALWAYS,
222    RS_DEPTH_FUNC_LESS,
223    RS_DEPTH_FUNC_LEQUAL,
224    RS_DEPTH_FUNC_GREATER,
225    RS_DEPTH_FUNC_GEQUAL,
226    RS_DEPTH_FUNC_EQUAL,
227    RS_DEPTH_FUNC_NOTEQUAL
228};
229
230enum RsBlendSrcFunc {
231    RS_BLEND_SRC_ZERO,                  // 0
232    RS_BLEND_SRC_ONE,                   // 1
233    RS_BLEND_SRC_DST_COLOR,             // 2
234    RS_BLEND_SRC_ONE_MINUS_DST_COLOR,   // 3
235    RS_BLEND_SRC_SRC_ALPHA,             // 4
236    RS_BLEND_SRC_ONE_MINUS_SRC_ALPHA,   // 5
237    RS_BLEND_SRC_DST_ALPHA,             // 6
238    RS_BLEND_SRC_ONE_MINUS_DST_ALPHA,   // 7
239    RS_BLEND_SRC_SRC_ALPHA_SATURATE,    // 8
240    RS_BLEND_SRC_INVALID = 100,
241};
242
243enum RsBlendDstFunc {
244    RS_BLEND_DST_ZERO,                  // 0
245    RS_BLEND_DST_ONE,                   // 1
246    RS_BLEND_DST_SRC_COLOR,             // 2
247    RS_BLEND_DST_ONE_MINUS_SRC_COLOR,   // 3
248    RS_BLEND_DST_SRC_ALPHA,             // 4
249    RS_BLEND_DST_ONE_MINUS_SRC_ALPHA,   // 5
250    RS_BLEND_DST_DST_ALPHA,             // 6
251    RS_BLEND_DST_ONE_MINUS_DST_ALPHA,   // 7
252
253    RS_BLEND_DST_INVALID = 100,
254};
255
256enum RsTexEnvMode {
257    RS_TEX_ENV_MODE_NONE,
258    RS_TEX_ENV_MODE_REPLACE,
259    RS_TEX_ENV_MODE_MODULATE,
260    RS_TEX_ENV_MODE_DECAL
261};
262
263enum RsProgramParam {
264    RS_PROGRAM_PARAM_INPUT,
265    RS_PROGRAM_PARAM_OUTPUT,
266    RS_PROGRAM_PARAM_CONSTANT,
267    RS_PROGRAM_PARAM_TEXTURE_TYPE,
268};
269
270enum RsPrimitive {
271    RS_PRIMITIVE_POINT,
272    RS_PRIMITIVE_LINE,
273    RS_PRIMITIVE_LINE_STRIP,
274    RS_PRIMITIVE_TRIANGLE,
275    RS_PRIMITIVE_TRIANGLE_STRIP,
276    RS_PRIMITIVE_TRIANGLE_FAN,
277
278    RS_PRIMITIVE_INVALID = 100,
279};
280
281enum RsPathPrimitive {
282    RS_PATH_PRIMITIVE_QUADRATIC_BEZIER,
283    RS_PATH_PRIMITIVE_CUBIC_BEZIER
284};
285
286enum RsError {
287    RS_ERROR_NONE = 0,
288    RS_ERROR_BAD_SHADER = 1,
289    RS_ERROR_BAD_SCRIPT = 2,
290    RS_ERROR_BAD_VALUE = 3,
291    RS_ERROR_OUT_OF_MEMORY = 4,
292    RS_ERROR_DRIVER = 5,
293
294    RS_ERROR_FATAL_UNKNOWN = 0x1000,
295    RS_ERROR_FATAL_DRIVER = 0x1001,
296    RS_ERROR_FATAL_PROGRAM_LINK = 0x1002
297};
298
299enum RsAnimationInterpolation {
300    RS_ANIMATION_INTERPOLATION_STEP,
301    RS_ANIMATION_INTERPOLATION_LINEAR,
302    RS_ANIMATION_INTERPOLATION_BEZIER,
303    RS_ANIMATION_INTERPOLATION_CARDINAL,
304    RS_ANIMATION_INTERPOLATION_HERMITE,
305    RS_ANIMATION_INTERPOLATION_BSPLINE
306};
307
308enum RsAnimationEdge {
309    RS_ANIMATION_EDGE_UNDEFINED,
310    RS_ANIMATION_EDGE_CONSTANT,
311    RS_ANIMATION_EDGE_GRADIENT,
312    RS_ANIMATION_EDGE_CYCLE,
313    RS_ANIMATION_EDGE_OSCILLATE,
314    RS_ANIMATION_EDGE_CYLE_RELATIVE
315};
316
317enum RsA3DClassID {
318    RS_A3D_CLASS_ID_UNKNOWN,
319    RS_A3D_CLASS_ID_MESH,
320    RS_A3D_CLASS_ID_TYPE,
321    RS_A3D_CLASS_ID_ELEMENT,
322    RS_A3D_CLASS_ID_ALLOCATION,
323    RS_A3D_CLASS_ID_PROGRAM_VERTEX,
324    RS_A3D_CLASS_ID_PROGRAM_RASTER,
325    RS_A3D_CLASS_ID_PROGRAM_FRAGMENT,
326    RS_A3D_CLASS_ID_PROGRAM_STORE,
327    RS_A3D_CLASS_ID_SAMPLER,
328    RS_A3D_CLASS_ID_ANIMATION,
329    RS_A3D_CLASS_ID_ADAPTER_1D,
330    RS_A3D_CLASS_ID_ADAPTER_2D,
331    RS_A3D_CLASS_ID_SCRIPT_C,
332    RS_A3D_CLASS_ID_SCRIPT_KERNEL_ID,
333    RS_A3D_CLASS_ID_SCRIPT_FIELD_ID,
334    RS_A3D_CLASS_ID_SCRIPT_METHOD_ID,
335    RS_A3D_CLASS_ID_SCRIPT_GROUP
336};
337
338enum RsCullMode {
339    RS_CULL_BACK,
340    RS_CULL_FRONT,
341    RS_CULL_NONE,
342    RS_CULL_INVALID = 100,
343};
344
345enum RsScriptIntrinsicID {
346    RS_SCRIPT_INTRINSIC_ID_UNDEFINED = 0,
347    RS_SCRIPT_INTRINSIC_ID_CONVOLVE_3x3 = 1,
348    RS_SCRIPT_INTRINSIC_ID_COLOR_MATRIX = 2,
349    RS_SCRIPT_INTRINSIC_ID_LUT = 3,
350    RS_SCRIPT_INTRINSIC_ID_CONVOLVE_5x5 = 4,
351    RS_SCRIPT_INTRINSIC_ID_BLUR = 5,
352    RS_SCRIPT_INTRINSIC_ID_YUV_TO_RGB = 6,
353    RS_SCRIPT_INTRINSIC_ID_BLEND = 7
354};
355
356typedef struct {
357    RsA3DClassID classID;
358    const char* objectName;
359} RsFileIndexEntry;
360
361enum RsForEachStrategy {
362    RS_FOR_EACH_STRATEGY_SERIAL = 0,
363    RS_FOR_EACH_STRATEGY_DONT_CARE = 1,
364    RS_FOR_EACH_STRATEGY_DST_LINEAR = 2,
365    RS_FOR_EACH_STRATEGY_TILE_SMALL = 3,
366    RS_FOR_EACH_STRATEGY_TILE_MEDIUM = 4,
367    RS_FOR_EACH_STRATEGY_TILE_LARGE = 5
368};
369
370// Script to Script
371typedef struct {
372    enum RsForEachStrategy strategy;
373    uint32_t xStart;
374    uint32_t xEnd;
375    uint32_t yStart;
376    uint32_t yEnd;
377    uint32_t zStart;
378    uint32_t zEnd;
379    uint32_t arrayStart;
380    uint32_t arrayEnd;
381
382} RsScriptCall;
383
384#ifdef __cplusplus
385};
386#endif
387
388#endif // RENDER_SCRIPT_DEFINES_H
389
390
391
392
393