docs: Add a reference section for geometric types

This commit is contained in:
Emmanuele Bassi 2012-04-19 14:55:08 +01:00
parent 764068a723
commit a9cc06257f
3 changed files with 135 additions and 74 deletions

View File

@ -22,12 +22,12 @@
*/ */
/** /**
* SECTION:clutter-base-types * SECTION:clutter-geometric-types
* @Title: Base data types * @Title: Base geometric types
* @Short_Description: Common data types used by Clutter * @Short_Description: Common geometric data types used by Clutter
* *
* Clutter defines a set of data structures that are commonly used across the * Clutter defines a set of geometric data structures that are commonly used
* whole API. * across the whole API.
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H

View File

@ -179,6 +179,7 @@
<xi:include href="xml/clutter-device-manager.xml"/> <xi:include href="xml/clutter-device-manager.xml"/>
<xi:include href="xml/clutter-event.xml"/> <xi:include href="xml/clutter-event.xml"/>
<xi:include href="xml/clutter-feature.xml"/> <xi:include href="xml/clutter-feature.xml"/>
<xi:include href="xml/clutter-geometric-types.xml"/>
<xi:include href="xml/clutter-input-device.xml"/> <xi:include href="xml/clutter-input-device.xml"/>
<xi:include href="xml/clutter-main.xml"/> <xi:include href="xml/clutter-main.xml"/>
<xi:include href="xml/clutter-path.xml"/> <xi:include href="xml/clutter-path.xml"/>

View File

@ -520,65 +520,7 @@ clutter_actor_set_shader_param
clutter_actor_set_shader_param_float clutter_actor_set_shader_param_float
clutter_actor_set_shader_param_int clutter_actor_set_shader_param_int
<SUBSECTION>
ClutterActorBox
CLUTTER_ACTOR_BOX_INIT
clutter_actor_box_new
clutter_actor_box_init
clutter_actor_box_init_rect
clutter_actor_box_copy
clutter_actor_box_free
clutter_actor_box_equal
clutter_actor_box_get_x
clutter_actor_box_get_y
clutter_actor_box_get_width
clutter_actor_box_get_height
clutter_actor_box_set_origin
clutter_actor_box_get_origin
clutter_actor_box_set_size
clutter_actor_box_get_size
clutter_actor_box_get_area
clutter_actor_box_contains
clutter_actor_box_from_vertices
clutter_actor_box_clamp_to_pixel
clutter_actor_box_interpolate
clutter_actor_box_union
<SUBSECTION>
ClutterVertex
CLUTTER_VERTEX_INIT
clutter_vertex_new
clutter_vertex_init
clutter_vertex_copy
clutter_vertex_free
clutter_vertex_equal
<SUBSECTION>
ClutterGeometry
clutter_geometry_union
clutter_geometry_intersects
<SUBSECTION>
ClutterPaintVolume
clutter_paint_volume_copy
clutter_paint_volume_free
clutter_paint_volume_set_origin
clutter_paint_volume_get_origin
clutter_paint_volume_set_width
clutter_paint_volume_get_width
clutter_paint_volume_set_height
clutter_paint_volume_get_height
clutter_paint_volume_set_depth
clutter_paint_volume_get_depth
clutter_paint_volume_set_from_allocation
clutter_paint_volume_union
clutter_paint_volume_union_box
<SUBSECTION Standard> <SUBSECTION Standard>
CLUTTER_TYPE_GEOMETRY
CLUTTER_TYPE_ACTOR_BOX
CLUTTER_TYPE_VERTEX
CLUTTER_TYPE_PAINT_VOLUME
CLUTTER_TYPE_MARGIN CLUTTER_TYPE_MARGIN
CLUTTER_ACTOR CLUTTER_ACTOR
CLUTTER_IS_ACTOR CLUTTER_IS_ACTOR
@ -591,11 +533,7 @@ CLUTTER_ACTOR_GET_CLASS
ClutterRedrawFlags ClutterRedrawFlags
ClutterActorPrivate ClutterActorPrivate
clutter_actor_get_type clutter_actor_get_type
clutter_actor_box_get_type
clutter_geometry_get_type
clutter_margin_get_type clutter_margin_get_type
clutter_paint_volume_get_type
clutter_vertex_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -806,14 +744,8 @@ clutter_behaviour_path_new_with_description
clutter_behaviour_path_new_with_knots clutter_behaviour_path_new_with_knots
clutter_behaviour_path_set_path clutter_behaviour_path_set_path
clutter_behaviour_path_get_path clutter_behaviour_path_get_path
<SUBSECTION>
ClutterKnot
clutter_knot_copy
clutter_knot_free
clutter_knot_equal
<SUBSECTION Standard> <SUBSECTION Standard>
CLUTTER_TYPE_KNOT
CLUTTER_BEHAVIOUR_PATH CLUTTER_BEHAVIOUR_PATH
CLUTTER_IS_BEHAVIOUR_PATH CLUTTER_IS_BEHAVIOUR_PATH
CLUTTER_TYPE_BEHAVIOUR_PATH CLUTTER_TYPE_BEHAVIOUR_PATH
@ -822,7 +754,6 @@ CLUTTER_IS_BEHAVIOUR_PATH_CLASS
CLUTTER_BEHAVIOUR_PATH_GET_CLASS CLUTTER_BEHAVIOUR_PATH_GET_CLASS
<SUBSECTION Private> <SUBSECTION Private>
ClutterBehaviourPathPrivate ClutterBehaviourPathPrivate
clutter_knot_get_type
clutter_behaviour_path_get_type clutter_behaviour_path_get_type
</SECTION> </SECTION>
@ -3161,3 +3092,132 @@ ClutterImagePrivate
clutter_image_get_type clutter_image_get_type
clutter_image_error_quark clutter_image_error_quark
</SECTION> </SECTION>
<SECTION>
<FILE>clutter-geometric-types</FILE>
ClutterPoint
ClutterSize
ClutterRect
ClutterVertex
ClutterActorBox
ClutterGeometry
ClutterKnot
ClutterPaintVolume
<SUBSECTION>
CLUTTER_POINT_INIT
CLUTTER_POINT_INIT_ZERO
clutter_point_alloc
clutter_point_init
clutter_point_copy
clutter_point_free
clutter_point_equals
clutter_point_distance
<SUBSECTION>
CLUTTER_SIZE_INIT
CLUTTER_SIZE_INIT_ZERO
clutter_size_alloc
clutter_size_init
clutter_size_copy
clutter_size_free
clutter_size_equals
<SUBSECTION>
CLUTTER_RECT_INIT
CLUTTER_RECT_INIT_ZERO
clutter_rect_alloc
clutter_rect_init
clutter_rect_copy
clutter_rect_free
clutter_rect_equals
clutter_rect_normalize
clutter_rect_get_center
clutter_rect_contains_point
clutter_rect_contains_rect
clutter_rect_union
clutter_rect_intersection
clutter_rect_offset
clutter_rect_inset
clutter_rect_clamp_to_pixel
clutter_rect_get_x
clutter_rect_get_y
clutter_rect_get_width
clutter_rect_get_height
<SUBSECTION>
CLUTTER_VERTEX_INIT
clutter_vertex_new
clutter_vertex_alloc
clutter_vertex_init
clutter_vertex_copy
clutter_vertex_free
clutter_vertex_equal
<SUBSECTION>
CLUTTER_ACTOR_BOX_INIT
clutter_actor_box_new
clutter_actor_box_alloc
clutter_actor_box_init
clutter_actor_box_init_rect
clutter_actor_box_copy
clutter_actor_box_free
clutter_actor_box_equal
clutter_actor_box_get_x
clutter_actor_box_get_y
clutter_actor_box_get_width
clutter_actor_box_get_height
clutter_actor_box_set_origin
clutter_actor_box_get_origin
clutter_actor_box_set_size
clutter_actor_box_get_size
clutter_actor_box_get_area
clutter_actor_box_contains
clutter_actor_box_from_vertices
clutter_actor_box_clamp_to_pixel
clutter_actor_box_interpolate
clutter_actor_box_union
<SUBSECTION>
clutter_knot_copy
clutter_knot_free
clutter_knot_equal
<SUBSECTION>
clutter_geometry_union
clutter_geometry_intersects
<SUBSECTION>
clutter_paint_volume_copy
clutter_paint_volume_free
clutter_paint_volume_set_origin
clutter_paint_volume_get_origin
clutter_paint_volume_set_width
clutter_paint_volume_get_width
clutter_paint_volume_set_height
clutter_paint_volume_get_height
clutter_paint_volume_set_depth
clutter_paint_volume_get_depth
clutter_paint_volume_set_from_allocation
clutter_paint_volume_union
clutter_paint_volume_union_box
<SUBSECTION Standard>
CLUTTER_TYPE_ACTOR_BOX
CLUTTER_TYPE_GEOMETRY
CLUTTER_TYPE_KNOT
CLUTTER_TYPE_PAINT_VOLUME
CLUTTER_TYPE_POINT
CLUTTER_TYPE_RECT
CLUTTER_TYPE_SIZE
CLUTTER_TYPE_VERTEX
<SUBSECTION Private>
clutter_actor_box_get_type
clutter_geometry_get_type
clutter_knot_get_type
clutter_paint_volume_get_type
clutter_point_get_type
clutter_rect_get_type
clutter_size_get_type
clutter_vertex_get_type
</SECTION>