"Initial commit to Gerrit"
[profile/ivi/cogl.git] / doc / reference / cogl / cogl-sections.txt
1 <SECTION>
2 <FILE>cogl</FILE>
3 <TITLE>General API</TITLE>
4 CoglObject
5 cogl_object_ref
6 cogl_object_unref
7 CoglUserDataKey
8 cogl_object_get_user_data
9 cogl_object_set_user_data
10 COGL_INVALID_HANDLE
11 CoglHandle
12 cogl_handle_ref
13 cogl_handle_unref
14
15 <SUBSECTION>
16 CoglFuncPtr
17 CoglPixelFormat
18 CoglBufferTarget
19 CoglBufferBit
20 CoglAttributeType
21
22 <SUBSECTION>
23 CoglFeatureFlags
24 cogl_get_features
25 cogl_features_available
26 cogl_get_proc_address
27 cogl_get_option_group
28
29 <SUBSECTION>
30 cogl_push_matrix
31 cogl_pop_matrix
32 cogl_scale
33 cogl_translate
34 cogl_rotate
35 cogl_transform
36 cogl_frustum
37 cogl_perspective
38 cogl_ortho
39
40 <SUBSECTION>
41 cogl_get_modelview_matrix
42 cogl_set_modelview_matrix
43 cogl_get_projection_matrix
44 cogl_set_projection_matrix
45 cogl_set_viewport
46 cogl_get_viewport
47
48 <SUBSECTION>
49 cogl_clear
50 cogl_set_backface_culling_enabled
51 cogl_get_backface_culling_enabled
52
53 <SUBSECTION>
54 CoglFogMode
55 cogl_set_fog
56 cogl_disable_fog
57
58 <SUBSECTION>
59 cogl_set_source
60 cogl_set_source_color
61 cogl_set_source_color4ub
62 cogl_set_source_color4f
63 cogl_set_source_texture
64 cogl_get_source
65 cogl_push_source
66 cogl_pop_source
67
68 <SUBSECTION>
69 CoglReadPixelsFlags
70 cogl_read_pixels
71
72 <SUBSECTION>
73 cogl_flush
74 cogl_begin_gl
75 cogl_end_gl
76
77 <SUBSECTION Standard>
78 COGL_TYPE_ATTRIBUTE_TYPE
79 COGL_TYPE_BLEND_STRING_ERROR
80 COGL_TYPE_BUFFER_ACCESS
81 COGL_TYPE_BUFFER_BIT
82 COGL_TYPE_BUFFER_TARGET
83 COGL_TYPE_BUFFER_UPDATE_HINT
84 COGL_TYPE_BUFFER_USAGE_HINT
85 COGL_TYPE_DEBUG_FLAGS
86 COGL_TYPE_DRIVER_ERROR
87 COGL_TYPE_FEATURE_FLAGS
88 COGL_TYPE_FIXED
89 COGL_TYPE_FOG_MODE
90 COGL_TYPE_HANDLE
91 COGL_TYPE_INDICES_TYPE
92 COGL_TYPE_MATERIAL_ALPHA_FUNC
93 COGL_TYPE_MATERIAL_FILTER
94 COGL_TYPE_MATERIAL_LAYER_TYPE
95 COGL_TYPE_PIXEL_FORMAT
96 COGL_TYPE_READ_PIXELS_FLAGS
97 COGL_TYPE_SHADER_TYPE
98 COGL_TYPE_TEXTURE_FLAGS
99 COGL_TYPE_VERTICES_MODE
100
101 <SUBSECTION Private>
102 COGL_DRIVER_ERROR
103 CoglDriverError
104 cogl_attribute_type_get_type
105 cogl_buffer_bit_get_type
106 cogl_buffer_target_get_type
107 cogl_debug_flags_get_type
108 cogl_driver_error_get_type
109 cogl_feature_flags_get_type
110 cogl_fixed_get_type
111 cogl_fog_mode_get_type
112 cogl_handle_get_type
113 cogl_indices_type_get_type
114 cogl_material_alpha_func_get_type
115 cogl_material_filter_get_type
116 cogl_material_layer_type_get_type
117 cogl_pixel_format_get_type
118 cogl_read_pixels_flags_get_type
119 cogl_shader_type_get_type
120 cogl_texture_flags_get_type
121 cogl_vertices_mode_get_type
122 COGL_AFIRST_BIT
123 COGL_A_BIT
124 COGL_BGR_BIT
125 COGL_PREMULT_BIT
126 </SECTION>
127
128 <SECTION>
129 <FILE>cogl-clipping</FILE>
130 <TITLE>Clipping</TITLE>
131 cogl_clip_push_rectangle
132 cogl_clip_push_window_rectangle
133 cogl_clip_push_from_path
134 cogl_clip_push_from_path_preserve
135 cogl_clip_pop
136 </SECTION>
137
138 <SECTION>
139 <FILE>cogl-primitives</FILE>
140 <TITLE>Primitives</TITLE>
141 cogl_rectangle
142 cogl_rectangles
143 cogl_rectangle_with_texture_coords
144 cogl_rectangles_with_texture_coords
145 cogl_rectangle_with_multitexture_coords
146 cogl_polygon
147 </SECTION>
148
149 <SECTION>
150 <FILE>cogl-paths</FILE>
151 <TITLE>Path Primitives</TITLE>
152 cogl_is_path
153 cogl_path_new
154 cogl_get_path
155 cogl_set_path
156 cogl_path_copy
157 cogl_path_move_to
158 cogl_path_close
159 cogl_path_line_to
160 cogl_path_curve_to
161 cogl_path_arc
162 cogl_path_rel_move_to
163 cogl_path_rel_line_to
164 cogl_path_rel_curve_to
165 cogl_path_line
166 cogl_path_polyline
167 cogl_path_polygon
168 cogl_path_rectangle
169 cogl_path_round_rectangle
170 cogl_path_ellipse
171
172 <SUBSECTION>
173 CoglPathFillRule
174 cogl_path_set_fill_rule
175 cogl_path_get_fill_rule
176 cogl_path_fill
177 cogl_path_fill_preserve
178 cogl_path_stroke
179 cogl_path_stroke_preserve
180 </SECTION>
181
182 <SECTION>
183 <FILE>cogl-bitmap</FILE>
184 <TITLE>Bitmaps</TITLE>
185 CoglBitmap
186 cogl_bitmap_new_from_file
187 cogl_bitmap_get_size_from_file
188 cogl_is_bitmap
189 CoglBitmapError
190 COGL_BITMAP_ERROR
191 <SUBSECTION Standard>
192 cogl_bitmap_error_get_type
193 cogl_bitmap_error_quark
194 </SECTION>
195
196 <SECTION>
197 <FILE>cogl-texture</FILE>
198 <TITLE>Textures</TITLE>
199 CoglTextureVertex
200 CoglTextureFlags
201 cogl_texture_new_with_size
202 cogl_texture_new_from_file
203 cogl_texture_new_from_data
204 cogl_texture_new_from_foreign
205 cogl_texture_new_from_bitmap
206 cogl_texture_new_from_sub_texture
207 cogl_is_texture
208
209 <SUBSECTION>
210 cogl_texture_get_width
211 cogl_texture_get_height
212 cogl_texture_get_format
213 cogl_texture_get_rowstride
214 cogl_texture_get_max_waste
215 cogl_texture_is_sliced
216 cogl_texture_get_gl_texture
217 cogl_texture_get_data
218 cogl_texture_set_region
219
220 <SUBSECTION Private>
221 COGL_TEXTURE_MAX_WASTE
222 </SECTION>
223
224 <SECTION>
225 <FILE>cogl-texture-2d</FILE>
226 <TITLE>2D textures</TITLE>
227 CoglTexture2D
228 cogl_is_texture_2d
229 cogl_texture_2d_new_with_size
230 cogl_texture_2d_new_from_data
231 cogl_texture_2d_new_from_foreign
232 </SECTION>
233
234 <SECTION>
235 <FILE>cogl-texture-3d</FILE>
236 <TITLE>3D textures</TITLE>
237 cogl_texture_3d_new_with_size
238 cogl_texture_3d_new_from_data
239 cogl_is_texture_3d
240 </SECTION>
241
242 <SECTION>
243 <FILE>cogl-shaders</FILE>
244 <TITLE>Shaders and Programmable Pipeline</TITLE>
245 CoglShaderType
246 cogl_create_shader
247 cogl_is_shader
248 cogl_shader_source
249 cogl_shader_compile
250 cogl_shader_get_info_log
251 cogl_shader_get_type
252 cogl_shader_is_compiled
253
254 <SUBSECTION>
255 cogl_create_program
256 cogl_is_program
257 cogl_program_attach_shader
258 cogl_program_link
259 cogl_program_get_uniform_location
260 cogl_program_set_uniform_1f
261 cogl_program_set_uniform_1i
262 cogl_program_set_uniform_float
263 cogl_program_set_uniform_int
264 cogl_program_set_uniform_matrix
265 </SECTION>
266
267 <SECTION>
268 <FILE>cogl-offscreen</FILE>
269 <TITLE>Offscreen Buffers</TITLE>
270 cogl_offscreen_new_to_texture
271 cogl_is_offscreen
272 cogl_set_framebuffer
273 cogl_push_framebuffer
274 cogl_pop_framebuffer
275 cogl_set_draw_buffer
276 cogl_pop_draw_buffer
277 cogl_push_draw_buffer
278 </SECTION>
279
280 <SECTION>
281 <FILE>cogl-fixed</FILE>
282 <TITLE>Fixed Point API</TITLE>
283 CoglFixed
284 COGL_FIXED_BITS
285 COGL_FIXED_Q
286 COGL_FIXED_MAX
287 COGL_FIXED_MIN
288
289 <SUBSECTION>
290 COGL_FIXED_FROM_FLOAT
291 COGL_FIXED_TO_FLOAT
292 COGL_FIXED_FROM_INT
293 COGL_FIXED_TO_INT
294 COGL_FIXED_FROM_DOUBLE
295 COGL_FIXED_TO_DOUBLE
296 COGL_FLOAT_TO_INT
297 COGL_FLOAT_TO_UINT
298
299 <SUBSECTION>
300 COGL_FIXED_EPSILON
301 COGL_FIXED_1
302 COGL_FIXED_0_5
303 COGL_FIXED_30
304 COGL_FIXED_45
305 COGL_FIXED_60
306 COGL_FIXED_90
307 COGL_FIXED_120
308 COGL_FIXED_180
309 COGL_FIXED_240
310 COGL_FIXED_255
311 COGL_FIXED_270
312 COGL_FIXED_360
313
314 <SUBSECTION>
315 COGL_FIXED_MUL
316 COGL_FIXED_DIV
317 COGL_FIXED_MUL_DIV
318 COGL_FIXED_FAST_DIV
319 COGL_FIXED_FAST_MUL
320 COGL_FIXED_FRACTION
321 COGL_FIXED_FLOOR
322 COGL_FIXED_CEIL
323
324 <SUBSECTION>
325 COGL_FIXED_2_PI
326 COGL_FIXED_PI
327 COGL_FIXED_PI_2
328 COGL_FIXED_PI_4
329 COGL_RADIANS_TO_DEGREES
330
331 <SUBSECTION>
332 COGL_SQRTI_ARG_10_PERCENT
333 COGL_SQRTI_ARG_5_PERCENT
334 COGL_SQRTI_ARG_MAX
335 cogl_sqrti
336
337 <SUBSECTION>
338 cogl_fixed_atan2
339 cogl_fixed_atan
340 cogl_fixed_cos
341 cogl_fixed_log2
342 cogl_fixed_pow
343 cogl_fixed_pow2
344 cogl_fixed_sin
345 cogl_fixed_sqrt
346 cogl_fixed_tan
347 cogl_fixed_div
348 cogl_fixed_mul
349 cogl_fixed_mul_div
350
351 <SUBSECTION>
352 CoglAngle
353 COGL_ANGLE_FROM_DEG
354 COGL_ANGLE_FROM_DEGX
355 COGL_ANGLE_TO_DEG
356 COGL_ANGLE_TO_DEGX
357 cogl_angle_cos
358 cogl_angle_sin
359 cogl_angle_tan
360
361 <SUBSECTION Private>
362 cogl_double_to_fixed
363 cogl_double_to_int
364 cogl_double_to_uint
365 </SECTION>
366
367 <SECTION>
368 <FILE>cogl-color</FILE>
369 <TITLE>Color Type</TITLE>
370 CoglColor
371 cogl_color_new
372 cogl_color_copy
373 cogl_color_free
374 cogl_color_init_from_4f
375 cogl_color_init_from_4fv
376 cogl_color_init_from_4ub
377 cogl_color_set_from_4ub
378 cogl_color_set_from_4f
379
380 <SUBSECTION>
381 cogl_color_get_red
382 cogl_color_get_green
383 cogl_color_get_blue
384 cogl_color_get_alpha
385
386 <SUBSECTION>
387 cogl_color_get_red_byte
388 cogl_color_get_green_byte
389 cogl_color_get_blue_byte
390 cogl_color_get_alpha_byte
391
392 <SUBSECTION>
393 cogl_color_get_red_float
394 cogl_color_get_green_float
395 cogl_color_get_blue_float
396 cogl_color_get_alpha_float
397
398 <SUBSECTION>
399 cogl_color_set_red
400 cogl_color_set_green
401 cogl_color_set_blue
402 cogl_color_set_alpha
403
404 <SUBSECTION>
405 cogl_color_set_red_byte
406 cogl_color_set_green_byte
407 cogl_color_set_blue_byte
408 cogl_color_set_alpha_byte
409
410 <SUBSECTION>
411 cogl_color_set_red_float
412 cogl_color_set_green_float
413 cogl_color_set_blue_float
414 cogl_color_set_alpha_float
415
416 <SUBSECTION>
417 cogl_color_premultiply
418 cogl_color_unpremultiply
419 cogl_color_equal
420 </SECTION>
421
422 <SECTION>
423 <FILE>cogl-vertex-buffer</FILE>
424 <TITLE>Vertex Buffers</TITLE>
425 cogl_vertex_buffer_new
426 cogl_vertex_buffer_get_n_vertices
427 cogl_vertex_buffer_add
428 cogl_vertex_buffer_delete
429 cogl_vertex_buffer_submit
430 cogl_vertex_buffer_disable
431 cogl_vertex_buffer_enable
432 CoglVerticesMode
433 cogl_vertex_buffer_draw
434 cogl_is_vertex_buffer
435
436 <SUBSECTION>
437 CoglIndicesType
438 cogl_vertex_buffer_indices_new
439 cogl_vertex_buffer_draw_elements
440 cogl_vertex_buffer_indices_get_for_quads
441 cogl_is_vertex_buffer_indices
442
443 <SUBSECTION Private>
444 cogl_vertex_buffer_indices_get_type
445 </SECTION>
446
447 <SECTION>
448 <FILE>cogl-matrix</FILE>
449 <TITLE>Matrices</TITLE>
450 CoglMatrix
451 cogl_matrix_init_identity
452 cogl_matrix_copy
453 cogl_matrix_equal
454 cogl_matrix_free
455 cogl_matrix_frustum
456 cogl_matrix_ortho
457 cogl_matrix_perspective
458 cogl_matrix_multiply
459 cogl_matrix_rotate
460 cogl_matrix_translate
461 cogl_matrix_scale
462 cogl_matrix_transpose
463 cogl_matrix_init_from_array
464 cogl_matrix_get_array
465 cogl_matrix_get_inverse
466 cogl_matrix_transform_point
467 cogl_matrix_project_points
468 cogl_matrix_transform_points
469 cogl_matrix_is_identity
470 </SECTION>
471
472 <SECTION>
473 <FILE>cogl-material</FILE>
474 <TITLE>Materials</TITLE>
475 CoglMaterial
476 CoglMaterialLayer
477 CoglMaterialLayerCallback
478 cogl_material_new
479 cogl_material_copy
480 cogl_is_material
481 cogl_material_set_color
482 cogl_material_set_color4ub
483 cogl_material_set_color4f
484 cogl_material_get_color
485 cogl_material_set_ambient
486 cogl_material_get_ambient
487 cogl_material_set_diffuse
488 cogl_material_get_diffuse
489 cogl_material_set_ambient_and_diffuse
490 cogl_material_set_emission
491 cogl_material_get_emission
492 cogl_material_set_specular
493 cogl_material_get_specular
494 cogl_material_set_shininess
495 cogl_material_get_shininess
496 CoglMaterialAlphaFunc
497 cogl_material_set_alpha_test_function
498 COGL_BLEND_STRING_ERROR
499 CoglBlendStringError
500 cogl_material_set_blend
501 cogl_material_set_blend_constant
502 cogl_material_set_point_size
503 cogl_material_get_point_size
504 cogl_material_set_layer
505 cogl_material_remove_layer
506 cogl_material_set_layer_combine
507 cogl_material_set_layer_combine_constant
508 cogl_material_set_layer_matrix
509 cogl_material_set_layer_point_sprite_coords_enabled
510 cogl_material_get_layer_point_sprite_coords_enabled
511 cogl_material_get_n_layers
512 CoglMaterialFilter
513 cogl_material_set_layer_filters
514 CoglMaterialLayerType
515 cogl_material_layer_get_type
516 cogl_material_layer_get_texture
517 cogl_material_layer_get_min_filter
518 cogl_material_layer_get_mag_filter
519 CoglMaterialWrapMode
520 cogl_material_set_layer_wrap_mode
521 cogl_material_set_layer_wrap_mode_s
522 cogl_material_set_layer_wrap_mode_t
523 cogl_material_set_layer_wrap_mode_p
524 cogl_material_get_layer_wrap_mode_s
525 cogl_material_get_layer_wrap_mode_t
526 cogl_material_get_layer_wrap_mode_p
527 cogl_material_wrap_mode_get_type
528 cogl_material_set_user_program
529 cogl_material_get_user_program
530 cogl_material_foreach_layer
531
532 <SUBSECTION Private>
533 cogl_blend_string_error_get_type
534 cogl_blend_string_error_quark
535 </SECTION>
536
537 <SECTION>
538 <FILE>cogl-depth-state</FILE>
539 CoglDepthState
540 cogl_depth_state_init
541 cogl_depth_state_set_test_enabled
542 cogl_depth_state_get_test_enabled
543 cogl_depth_state_set_test_function
544 cogl_depth_state_get_test_function
545 cogl_depth_state_set_writing_enabled
546 cogl_depth_state_get_writing_enabled
547 cogl_depth_state_set_range
548 cogl_depth_state_get_range
549 </SECTION>
550
551 <SECTION>
552 <FILE>cogl-buffer</FILE>
553 <TITLE>Buffers</TITLE>
554 cogl_is_buffer
555 cogl_buffer_get_size
556 CoglBufferUsageHint
557 cogl_buffer_set_usage_hint
558 cogl_buffer_get_usage_hint
559 CoglBufferUpdateHint
560 cogl_buffer_set_update_hint
561 cogl_buffer_get_update_hint
562 CoglBufferAccess
563 cogl_buffer_map
564 cogl_buffer_unmap
565 cogl_buffer_set_data
566
567 <SUBSECTION>
568 cogl_pixel_buffer_new
569 cogl_is_pixel_buffer
570
571 <SUBSECTION Private>
572 cogl_buffer_access_get_type
573 cogl_buffer_update_hint_get_type
574 cogl_buffer_usage_hint_get_type
575 </SECTION>
576
577 <SECTION>
578 <FILE>cogl-vector</FILE>
579 <TITLE>Vectors</TITLE>
580 cogl_vector3_init
581 cogl_vector3_init_zero
582 cogl_vector3_equal
583 cogl_vector3_equal_with_epsilon
584 cogl_vector3_copy
585 cogl_vector3_free
586 cogl_vector3_invert
587 cogl_vector3_add
588 cogl_vector3_subtract
589 cogl_vector3_multiply_scalar
590 cogl_vector3_divide_scalar
591 cogl_vector3_normalize
592 cogl_vector3_magnitude
593 cogl_vector3_cross_product
594 cogl_vector3_dot_product
595 cogl_vector3_distance
596 </SECTION>
597
598 <SECTION>
599 <FILE>cogl-gtype</FILE>
600 <TITLE>GType Integration API</TITLE>
601 cogl_gtype_matrix_get_type
602 </SECTION>
603
604 <SECTION>
605 <FILE>cogl-deprecated</FILE>
606 <TITLE>General API (Deprecated)</TITLE>
607 cogl_check_extension
608 cogl_viewport
609
610 cogl_get_bitmasks
611
612 cogl_set_depth_test_enabled
613 cogl_get_depth_test_enabled
614 </SECTION>
615
616 <SECTION>
617 <FILE>cogl-clipping-deprecated</FILE>
618 <TITLE>Clipping (Deprecated)</TITLE>
619 cogl_clip_push
620 cogl_clip_push_window_rect
621 cogl_clip_ensure
622 cogl_clip_stack_save
623 cogl_clip_stack_restore
624 </SECTION>
625
626 <SECTION>
627 <FILE>cogl-texture-deprecated</FILE>
628 <TITLE>Textures (Deprecated)</TITLE>
629 cogl_texture_ref
630 cogl_texture_unref
631 </SECTION>
632
633 <SECTION>
634 <FILE>cogl-material-deprecated</FILE>
635 <TITLE>Materials (Deprecated)</TITLE>
636 cogl_material_ref
637 cogl_material_unref
638 cogl_material_get_layers
639 </SECTION>
640
641 <SECTION>
642 <FILE>cogl-vertex-buffer-deprecated</FILE>
643 <TITLE>Vertex Buffers (Deprecated)</TITLE>
644 cogl_vertex_buffer_ref
645 cogl_vertex_buffer_unref
646 </SECTION>
647
648 <SECTION>
649 <FILE>cogl-shaders-deprecated</FILE>
650 <TITLE>Shaders and Programmable Pipeline (Deprecated)</TITLE>
651 cogl_shader_ref
652 cogl_shader_unref
653
654 <SUBSECTION>
655 cogl_program_ref
656 cogl_program_unref
657 cogl_program_use
658 cogl_program_uniform_1f
659 cogl_program_uniform_1i
660 cogl_program_uniform_float
661 cogl_program_uniform_int
662 cogl_program_uniform_matrix
663 </SECTION>
664
665 <SECTION>
666 <FILE>cogl-offscreen-deprecated</FILE>
667 <TITLE>Offscreen Buffers (Deprecated)</TITLE>
668 cogl_offscreen_ref
669 cogl_offscreen_unref
670 </SECTION>
671
672 <SECTION>
673 <FILE>cogl-euler</FILE>
674 <TITLE>Eulers (Rotations)</TITLE>
675 CoglEuler
676 cogl_euler_init
677 cogl_euler_init_from_matrix
678 cogl_euler_init_from_quaternion
679 cogl_euler_equal
680 cogl_euler_copy
681 cogl_euler_free
682 </SECTION>
683
684 <SECTION>
685 <FILE>cogl-quaternion</FILE>
686 <TITLE>Quaternions (Rotations)</TITLE>
687 CoglQuaternion
688 cogl_quaternion_init_identity
689 cogl_quaternion_init
690 cogl_quaternion_init_from_angle_vector
691 cogl_quaternion_init_from_array
692 cogl_quaternion_init_from_x_rotation
693 cogl_quaternion_init_from_y_rotation
694 cogl_quaternion_init_from_z_rotation
695 cogl_quaternion_equal
696 cogl_quaternion_copy
697 cogl_quaternion_free
698 cogl_quaternion_get_rotation_angle
699 cogl_quaternion_get_rotation_axis
700 cogl_quaternion_normalize
701 cogl_quaternion_dot_product
702 cogl_quaternion_invert
703 cogl_quaternion_multiply
704 cogl_quaternion_pow
705 cogl_quaternion_slerp
706 cogl_quaternion_nlerp
707 cogl_quaternion_squad
708 cogl_get_static_identity_quaternion
709 cogl_get_static_zero_quaternion
710 </SECTION>