0d27ff69b6bab17cb66b4f02c06fb04afc7bf070
[platform/core/uifw/dali-toolkit.git] / plugins / dali-script-v8 / docs / content / constants.js
1 /**
2  *
3 ### Dali Constants
4
5 Constants accessible under the dali global object.
6   
7     actor.parentOrigin = dali.TOP_LEFT;
8     actor.color = dali.COLOR_RED;
9     actor.setBlendFunc( dali.BLEND_FACTOR_ONE_MINUS_SRC_COLOR, dali.BLEND_FACTOR_SRC_ALPHA_SATURATE );
10
11
12 | Constant Name | value |
13 |---------------|-------|
14 |  ** actor.parentOrigin and actor.anchorPoint  **      |                      |
15 |TOP_LEFT            |  (0.0f, 0.0f, 0.5f)  |
16 |TOP_CENTER          |  (0.5f, 0.0f, 0.5f)  |
17 |TOP_RIGHT          |  (1.0f, 0.0f, 0.5f)  |
18 |CENTER_LEFT         |  (0.0f, 0.5f, 0.5f)  |
19 |CENTER              |  (0.5f, 0.5f, 0.5f)  |
20 |CENTER_RIGHT        |  (1.0f, 0.5f, 0.5f)  |
21 |BOTTOM_LEFT         |  (0.0f, 1.0f, 0.5f)  |
22 |BOTTOM_CENTER       |  (0.5f, 1.0f, 0.5f)  |
23 |BOTTOM_RIGHT        |  (1.0f, 1.0f, 0.5f)  |
24
25
26 |** Vector3 ** | |
27 |VECTOR3_ONE                  |  (1.0f, 1.0f, 1.0f)         |
28 |VECTOR3_XAXIS                |  (1.0f, 0.0f, 0.0f)         |
29 |VECTOR3_YAXIS                |  (0.0f, 1.0f, 0.0f)         |
30 |VECTOR3_ZAXIS                |  (0.0f, 0.0f, 1.0f)         |
31 |VECTOR3_NEGATIVE_XAXIS       |  (-1.0f, 0.0f, 0.0f)        |
32 |VECTOR3_NEGATIVE_YAXIS       |   (0.0f, -1.0f, 0.0f)       |
33 |VECTOR3_NEGATIVE_ZAXIS       |   (0.0f, 0.0f, -1.0f)       |
34 |VECTOR3_ZERO                 |   (0.0f, 0.0f, 0.0f)        |
35
36 |**  Colors **| -|
37 |COLOR_BLACK              |    ( 0.0f, 0.0f, 0.0f, 1.0f )     |
38 |COLOR_WHITE              |    ( 1.0f, 1.0f, 1.0f, 1.0f )     |
39 |COLOR_RED                |    (   1.0f, 0.0f, 0.0f, 1.0f )   |
40 |COLOR_GREEN              |    ( 0.0f, 1.0f, 0.0f, 1.0f )     |
41 |COLOR_BLUE               |    (  0.0f, 0.0f, 1.0f, 1.0f )    |
42 |COLOR_YELLOW             |    (  1.0f, 1.0f, 0.0f, 1.0f )    |
43 |COLOR_MAGENTA            |     ( 1.0f, 0.0f, 1.0f, 1.0f )    |
44 |COLOR_CYAN               |    (    0.0f, 1.0f, 1.0f, 1.0f )  |
45 |COLOR_TRANSPARENT        |  ( 0.0f, 0.0f, 0.0f, 0.0f )       |
46
47 | ** actor.colorMode constants  **  | -|
48 | COLOR_MODE_USE_OWN_COLOR,                  | integer value  |
49 | COLOR_MODE_USE_PARENT_COLOR,               | integer value  |
50 | COLOR_MODE_USE_OWN_MULTIPLY_PARENT_COLOR,  | integer value  |
51 | COLOR_MODE_USE_OWN_MULTIPLY_PARENT_ALPHA,  | integer value  |
52
53 |**actor.positionInheritance  **| |
54 |POSITION_INHERITANCE_INHERIT_PARENT_POSITION,       | integer value |
55 |POSITION_INHERITANCE_USE_PARENT_POSITION,           | integer value |
56 |POSITION_INHERITANCE_USE_PARENT_POSITION_PLUS_LOCAL_POSITION, | integer value |
57 |POSITION_INHERITANCE_DONT_INHERIT_POSITION,         | integer value |
58
59 |**actor.drawMode  **| |
60 |DRAW_MODE_NORMAL                         | integer value |
61 |DRAW_MODE_OVERLAY_2D                     | integer value |
62 |DRAW_MODE_STENCIL                        | integer value |
63
64 |**Image load policy  **| |
65 |**actor.SetBlendFunc() ** | |
66 |BLEND_FACTOR_ZERO                        | integer value |
67 |BLEND_FACTOR_ONE                         | integer value |
68 |BLEND_FACTOR_SRC_COLOR                   | integer value |
69 |BLEND_FACTOR_ONE_MINUS_SRC_COLOR         | integer value |
70 |BLEND_FACTOR_SRC_ALPHA                   | integer value |
71 |BLEND_FACTOR_ONE_MINUS_SRC_ALPHA         | integer value |
72 |BLEND_FACTOR_DST_ALPHA                   | integer value |
73 |BLEND_FACTOR_ONE_MINUS_DST_ALPHA         | integer value |
74 |BLEND_FACTOR_DST_COLOR                   | integer value |
75 |BLEND_FACTOR_ONE_MINUS_DST_COLOR         | integer value |
76 |BLEND_FACTOR_SRC_ALPHA_SATURATE          | integer value |
77 |BLEND_FACTOR_CONSTANT_COLOR              | integer value |
78 |BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR    | integer value |
79 |BLEND_FACTOR_CONSTANT_ALPHA              | integer value |
80 |BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA    | integer value |
81
82 |**actor.SetBlendMode()  **| |
83 |BLENDING_OFF                              | integer value |
84 |BLENDING_AUTO                             | integer value |
85 |BLENDING_ON                               | integer value |
86
87 |**actor.SetCullFace()** | |
88 |CULL_FACE_DISABLE          | integer value  |
89 |CULL_FRONT_FACE           | integer value  |
90 |CULL_BACK_FACE            | integer value  |
91 |CULL_FRONT_AND_BACK_FACE  | integer value  |
92
93 |**actor.sizeMode** | |
94 |USE_OWN_SIZE                   | integer value  |
95 |SIZE_EQUAL_TO_PARENT           | integer value  |
96 |SIZE_RELATIVE_TO_PARENT        | integer value  |
97 |SIZE_FIXED_OFFSET_FROM_PARENT  | integer value  |
98
99
100 |**animation.SetEndAction( mode ) ** | |
101 |ANIMATION_BAKE             | integer value  |
102 |ANIMATION_DISCARD          | integer value  |
103 |ANIMATION_BAKE_FINAL       | integer value  |
104
105 |**camera.type ** | |
106 |CAMERA_FREE_LOOK             | integer value  |
107 |CAMERA_LOOK_AT_TARGET        | integer value  |
108
109 |**camera.projectionMode ** | |
110 |CAMERA_PERSPECTIVE_PROJECTION  | integer value  |
111 |CAMERA_ORTHOGRAPHIC_PROJECTION | integer value  |
112
113
114 |** Pixel formats     **          |  |
115 | PIXEL_FORMAT_A8                            | integer value  |
116 | PIXEL_FORMAT_L8                            | integer value  |
117 | PIXEL_FORMAT_LA88                          | integer value  |
118 | PIXEL_FORMAT_RGB565                        | integer value  |
119 | PIXEL_FORMAT_BGR565                        | integer value  |
120 | PIXEL_FORMAT_RGBA4444                      | integer value  |
121 | PIXEL_FORMAT_BGRA4444                      | integer value  |
122 | PIXEL_FORMAT_RGBA5551                      | integer value  |
123 | PIXEL_FORMAT_BGRA5551                      | integer value  |
124 | PIXEL_FORMAT_RGB888                        | integer value  |
125 | PIXEL_FORMAT_RGB8888                       | integer value  |
126 | PIXEL_FORMAT_BGR8888                       | integer value  |
127 | PIXEL_FORMAT_RGBA8888                      | integer value  |
128 | PIXEL_FORMAT_BGRA8888                      | integer value  |
129
130 | **Pixel Compressed formats                 ** |  |
131 | PIXEL_FORMAT_COMPRESSED_R11_EAC                 | integer value           |
132 | PIXEL_FORMAT_COMPRESSED_SIGNED_R11_EAC          | integer value           |
133 | PIXEL_FORMAT_COMPRESSED_RG11_EAC                | integer value           |
134 | PIXEL_FORMAT_COMPRESSED_SIGNED_RG11_EAC         | integer value           |
135 | PIXEL_FORMAT_COMPRESSED_RGB8_ETC2               | integer value           |
136 | PIXEL_FORMAT_COMPRESSED_SRGB8_ETC2              | integer value           |
137 | PIXEL_FORMAT_COMPRESSED_RGB8_PUNCHTHROUGH_ALPHA1_ETC2    | integer value  |
138 | PIXEL_FORMAT_COMPRESSED_SRGB8_PUNCHTHROUGH_ALPHA1_ETC2   | integer value  |
139 | PIXEL_FORMAT_COMPRESSED_RGBA8_ETC2_EAC                   | integer value  |
140 | PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ETC2_EAC            | integer value  |
141 | PIXEL_FORMAT_COMPRESSED_RGB8_ETC1                        | integer value  |
142 | PIXEL_FORMAT_COMPRESSED_RGB_PVRTC_4BPPV1                 | integer value  |
143
144 |**Texture filtering mode ** | |
145 |FILTER_MODE_NONE                     | integer value  |
146 |FILTER_MODE_DEFAULT                  | integer value  |
147 |FILTER_MODE_NEAREST                  | integer value  |
148 |FILTER_MODE_LINEAR                   | integer value  |
149
150 |**Sampler wrap mode ** | |
151 |WRAP_MODE_DEFAULT                    | integer value  |
152 |WRAP_MODE_CLAMP_TO_EDGE              | integer value  |
153 |WRAP_MODE_REPEAT                     | integer value  |
154 |WRAP_MODE_MIRRORED_REPEAT            | integer value  |
155
156 |**Material face culling mode ** | |
157 |MATERIAL_NONE                        | integer value  |
158 |MATERIAL_CULL_BACK                   | integer value  |
159 |MATERIAL_CULL_FRONT                  | integer value  |
160 |MATERIAL_CULL_BACK_AND_FRONT         | integer value  |
161
162 |**Geometry primitives type ** | |
163 |GEOMETRY_POINTS                      | integer value  |
164 |GEOMETRY_LINES                       | integer value  |
165 |GEOMETRY_LINE_LOOP                   | integer value  |
166 |GEOMETRY_LINE_STRIP                  | integer value  |
167 |GEOMETRY_TRIANGLES                   | integer value  |
168 |GEOMETRY_TRIANGLE_FAN                | integer value  |
169 |GEOMETRY_TRIANGLE_STRIP              | integer value  |
170
171 |**Property type ** | |
172 |PROPERTY_NONE                        | none  |
173 |PROPERTY_BOOLEAN                     | integer value  |
174 |PROPERTY_FLOAT                       | float value  |
175 |PROPERTY_INTEGER                     | integer value  |
176 |PROPERTY_VECTOR2                     | Array[ float, float ] |
177 |PROPERTY_VECTOR3                     | Array[ float, float, float ]  |
178 |PROPERTY_VECTOR4                     | Array[ float, float, float, float ]  |
179 |PROPERTY_MATRIX3                     | Object         |
180 |PROPERTY_MATRIX                      | Object         |
181 |PROPERTY_RECTANGLE                   | Object |
182 |PROPERTY_ORIENTATION                 | Object  |
183 |PROPERTY_STRING                      | String  |
184 |PROPERTY_ARRAY                       | Object   |
185 |PROPERTY_MAP                         | Object  |
186
187 |**Item layout type ** | |
188 |ITEM_LAYOUT_LIST                     | integer value  |
189 |ITEM_LAYOUT_GRID                     | integer value  |
190
191  * @class Constants
192  */