Merge "JavaScript support for DALi" into tizen
[platform/core/uifw/dali-toolkit.git] / plugins / dali-script-v8 / docs / content / constants.js
1 /**
2  *
3 <h3> Dali Constants </h3>
4
5 Constants accessible under the dali global object.
6   
7     actor.parentOrigin = dali.BACK_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 |BACK_TOP_LEFT      |  (0.0f, 0.0f, 0.0f)  |
16 |BACK_TOP_CENTER    |  (0.5f, 0.0f, 0.0f)  |
17 |BACK_TOP_RIGHT     |  (1.0f, 0.0f, 0.0f)  |
18 |BACK_CENTER_LEFT   |  (0.0f, 0.5f, 0.0f)  |
19 |BACK_CENTER        |  (0.5f, 0.5f, 0.0f)  |
20 |BACK_CENTER_RIGHT  |  (1.0f, 0.5f, 0.0f)  |
21 |BACK_BOTTOM_LEFT   |  (0.0f, 1.0f, 0.0f)  |
22 |BACK_BOTTOM_CENTER  |  (0.5f, 1.0f, 0.0f)  |
23 |BACK_BOTTOM_RIGHT   |  (1.0f, 1.0f, 0.0f)  |
24 |TOP_LEFT            |  (0.0f, 0.0f, 0.5f)  |
25 |TOP_CENTER          |  (0.5f, 0.0f, 0.5f)  |
26 |TOP_RIGHT          |  (1.0f, 0.0f, 0.5f)  |
27 |CENTER_LEFT         |  (0.0f, 0.5f, 0.5f)  |
28 |CENTER              |  (0.5f, 0.5f, 0.5f)  |
29 |CENTER_RIGHT        |  (1.0f, 0.5f, 0.5f)  |
30 |BOTTOM_LEFT         |  (0.0f, 1.0f, 0.5f)  |
31 |BOTTOM_CENTER       |  (0.5f, 1.0f, 0.5f)  |
32 |BOTTOM_RIGHT        |  (1.0f, 1.0f, 0.5f)  |
33
34 |FRONT_TOP_LEFT      |  (0.0f, 0.0f, 1.0f)  |
35 |FRONT_TOP_CENTER    |  (0.5f, 0.0f, 1.0f)  |
36 |FRONT_TOP_RIGHT     |  (1.0f, 0.0f, 1.0f)  |
37 |FRONT_CENTER_LEFT   |  (0.0f, 0.5f, 1.0f)  |
38 |FRONT_CENTER        |  (0.5f, 0.5f, 1.0f)  |
39 |FRONT_CENTER_RIGHT  |  (1.0f, 0.5f, 1.0f)  |
40 |FRONT_BOTTOM_LEFT   |  (0.0f, 1.0f, 1.0f)  |
41 |FRONT_BOTTOM_CENTER |  (0.5f, 1.0f, 1.0f)  |
42 |FRONT_BOTTOM_RIGHT  |  (1.0f, 1.0f, 1.0f)  |
43
44
45 |** Vector3 ** | |
46 |VECTOR3_ONE                  |  (1.0f, 1.0f, 1.0f)         |
47 |VECTOR3_XAXIS                |  (1.0f, 0.0f, 0.0f)         |
48 |VECTOR3_YAXIS                |  (0.0f, 1.0f, 0.0f)         |
49 |VECTOR3_ZAXIS                |  (0.0f, 0.0f, 1.0f)         |
50 |VECTOR3_NEGATIVE_XAXIS       |  (-1.0f, 0.0f, 0.0f)        |
51 |VECTOR3_NEGATIVE_YAXIS       |   (0.0f, -1.0f, 0.0f)       |
52 |VECTOR3_NEGATIVE_ZAXIS       |   (0.0f, 0.0f, -1.0f)       |
53 |VECTOR3_ZERO                 |   (0.0f, 0.0f, 0.0f)        |
54
55 |**  Colors **| -|
56 |COLOR_BLACK              |    ( 0.0f, 0.0f, 0.0f, 1.0f )     |
57 |COLOR_WHITE              |    ( 1.0f, 1.0f, 1.0f, 1.0f )     |
58 |COLOR_RED                |    (   1.0f, 0.0f, 0.0f, 1.0f )   |
59 |COLOR_GREEN              |    ( 0.0f, 1.0f, 0.0f, 1.0f )     |
60 |COLOR_BLUE               |    (  0.0f, 0.0f, 1.0f, 1.0f )    |
61 |COLOR_YELLOW             |    (  1.0f, 1.0f, 0.0f, 1.0f )    |
62 |COLOR_MAGENTA            |     ( 1.0f, 0.0f, 1.0f, 1.0f )    |
63 |COLOR_CYAN               |    (    0.0f, 1.0f, 1.0f, 1.0f )  |
64 |COLOR_TRANSPARENT        |  ( 0.0f, 0.0f, 0.0f, 0.0f )       |
65
66 | ** actor.colorMode constants  **  | -|
67 | COLOR_MODE_USE_OWN_COLOR,                  | integer value  |
68 | COLOR_MODE_USE_PARENT_COLOR,               | integer value  |
69 | COLOR_MODE_USE_OWN_MULTIPLY_PARENT_COLOR,  | integer value  |
70 | COLOR_MODE_USE_OWN_MULTIPLY_PARENT_ALPHA,  | integer value  |
71
72 |**actor.positionInheritance  **| |
73 |POSITION_INHERITANCE_INHERIT_PARENT_POSITION,       | integer value |
74 |POSITION_INHERITANCE_USE_PARENT_POSITION,           | integer value |
75 |POSITION_INHERITANCE_USE_PARENT_POSITION_PLUS_LOCAL_POSITION, | integer value |
76 |POSITION_INHERITANCE_DONT_INHERIT_POSITION,         | integer value |
77
78 |**actor.drawMode  **| |
79 |DRAW_MODE_NORMAL                         | integer value |
80 |DRAW_MODE_OVERLAY                        | integer value |
81 |DRAW_MODE_STENCIL                        | integer value |
82
83 |**Image load policy  **| |
84 |IMAGE_LOAD_POLICY_IMMEDIATE              | integer value |
85 |IMAGE_LOAD_POLICY_ON_DEMAND              | integer value |
86
87 |**actor.SetBlendFunc() ** | |
88 |BLEND_FACTOR_ZERO                        | integer value |
89 |BLEND_FACTOR_ONE                         | integer value |
90 |BLEND_FACTOR_SRC_COLOR                   | integer value |
91 |BLEND_FACTOR_ONE_MINUS_SRC_COLOR         | integer value |
92 |BLEND_FACTOR_SRC_ALPHA                   | integer value |
93 |BLEND_FACTOR_ONE_MINUS_SRC_ALPHA         | integer value |
94 |BLEND_FACTOR_DST_ALPHA                   | integer value |
95 |BLEND_FACTOR_ONE_MINUS_DST_ALPHA         | integer value |
96 |BLEND_FACTOR_DST_COLOR                   | integer value |
97 |BLEND_FACTOR_ONE_MINUS_DST_COLOR         | integer value |
98 |BLEND_FACTOR_SRC_ALPHA_SATURATE          | integer value |
99 |BLEND_FACTOR_CONSTANT_COLOR              | integer value |
100 |BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR    | integer value |
101 |BLEND_FACTOR_CONSTANT_ALPHA              | integer value |
102 |BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA    | integer value |
103
104 |**actor.SetBlendMode()  **| |
105 |BLENDING_OFF                              | integer value |
106 |BLENDING_AUTO                             | integer value |
107 |BLENDING_ON                               | integer value |
108
109 |**actor.SetBlendEquation()  ** | |
110 |BLEND_EQUATION_ADD                         | integer value  |
111 |BLEND_EQUATION_SUBTRACT                    | integer value  |
112 |BLEND_EQUATION_REVERSE_SUBTRACT            | integer value  |
113
114 |**actor.SetCullFace()** | |
115 |CULL_FACE_DISABLE          | integer value  |
116 |CULL_FRONT_FACE           | integer value  |
117 |CULL_BACK_FACE            | integer value  |
118 |CULL_FRONT_AND_BACK_FACE  | integer value  |
119
120 |**actor.sizeMode** | |
121 |USE_OWN_SIZE                   | integer value  |
122 |SIZE_EQUAL_TO_PARENT           | integer value  |
123 |SIZE_RELATIVE_TO_PARENT        | integer value  |
124 |SIZE_FIXED_OFFSET_FROM_PARENT  | integer value  |
125
126
127 |**animation.SetEndAction( mode ) ** | |
128 |ANIMATION_BAKE             | integer value  |
129 |ANIMATION_DISCARD          | integer value  |
130 |ANIMATION_BAKE_FINAL       | integer value  |
131
132 |**camera.type ** | |
133 |CAMERA_FREE_LOOK             | integer value  |
134 |CAMERA_LOOK_AT_TARGET        | integer value  |
135
136 |**camera.projectionMode ** | |
137 |CAMERA_PERSPECTIVE_PROJECTION  | integer value  |
138 |CAMERA_ORTHOGRAPHIC_PROJECTION | integer value  |
139
140
141 |** Pixel formats     **          |  |
142 | PIXEL_FORMAT_A8                            | integer value  |
143 | PIXEL_FORMAT_L8                            | integer value  |
144 | PIXEL_FORMAT_LA88                          | integer value  |
145 | PIXEL_FORMAT_RGB565                        | integer value  |
146 | PIXEL_FORMAT_BGR565                        | integer value  |
147 | PIXEL_FORMAT_RGBA4444                      | integer value  |
148 | PIXEL_FORMAT_BGRA4444                      | integer value  |
149 | PIXEL_FORMAT_RGBA5551                      | integer value  |
150 | PIXEL_FORMAT_BGRA5551                      | integer value  |
151 | PIXEL_FORMAT_RGB888                        | integer value  |
152 | PIXEL_FORMAT_RGB8888                       | integer value  |
153 | PIXEL_FORMAT_BGR8888                       | integer value  |
154 | PIXEL_FORMAT_RGBA8888                      | integer value  |
155 | PIXEL_FORMAT_BGRA8888                      | integer value  |
156
157 | **Pixel Compressed formats                 ** |  |
158 | PIXEL_FORMAT_COMPRESSED_R11_EAC                 | integer value           |
159 | PIXEL_FORMAT_COMPRESSED_SIGNED_R11_EAC          | integer value           |
160 | PIXEL_FORMAT_COMPRESSED_RG11_EAC                | integer value           |
161 | PIXEL_FORMAT_COMPRESSED_SIGNED_RG11_EAC         | integer value           |
162 | PIXEL_FORMAT_COMPRESSED_RGB8_ETC2               | integer value           |
163 | PIXEL_FORMAT_COMPRESSED_SRGB8_ETC2              | integer value           |
164 | PIXEL_FORMAT_COMPRESSED_RGB8_PUNCHTHROUGH_ALPHA1_ETC2    | integer value  |
165 | PIXEL_FORMAT_COMPRESSED_SRGB8_PUNCHTHROUGH_ALPHA1_ETC2   | integer value  |
166 | PIXEL_FORMAT_COMPRESSED_RGBA8_ETC2_EAC                   | integer value  |
167 | PIXEL_FORMAT_COMPRESSED_SRGB8_ALPHA8_ETC2_EAC            | integer value  |
168 | PIXEL_FORMAT_COMPRESSED_RGB8_ETC1                        | integer value  |
169 | PIXEL_FORMAT_COMPRESSED_RGB_PVRTC_4BPPV1                 | integer value  |
170 </table>
171
172  * @class Constants
173  */