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