summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRobert Bragg <robert@linux.intel.com>2010-02-25 01:40:29 +0000
committerRobert Bragg <robert@linux.intel.com>2011-05-16 14:11:47 +0100
commitd1434d1c335755955c41df0366478986e81ad650 (patch)
treeb5398f8145a351592cee4dcba5160ca2ba083cc2 /doc
parentb316241612c43b24867c0be6c77b70087ead72be (diff)
downloadcogl-d1434d1c335755955c41df0366478986e81ad650.tar.gz
math: Adds an experimental quaternion API
This adds an experimental quaternion utility API. It's not yet fully documented but it's complete enough that people can start to experiment with using it. It adds the following functions: cogl_quaternion_init_identity cogl_quaternion_init cogl_quaternion_init_from_angle_vector cogl_quaternion_init_from_array cogl_quaternion_init_from_x_rotation cogl_quaternion_init_from_y_rotation cogl_quaternion_init_from_z_rotation cogl_quaternion_equal cogl_quaternion_copy cogl_quaternion_free cogl_quaternion_get_rotation_angle cogl_quaternion_get_rotation_axis cogl_quaternion_normalize cogl_quaternion_dot_product cogl_quaternion_invert cogl_quaternion_multiply cogl_quaternion_pow cogl_quaternion_slerp cogl_quaternion_nlerp cogl_quaternion_squad cogl_get_static_identity_quaternion cogl_get_static_zero_quaternion Since it's experimental API you'll need to define COGL_ENABLE_EXPERIMENTAL_API before including cogl.h.
Diffstat (limited to 'doc')
-rw-r--r--doc/reference/cogl-2.0/cogl-docs.xml.in1
-rw-r--r--doc/reference/cogl-2.0/cogl-sections.txt28
-rw-r--r--doc/reference/cogl/cogl-docs.xml.in1
-rw-r--r--doc/reference/cogl/cogl-sections.txt28
4 files changed, 58 insertions, 0 deletions
diff --git a/doc/reference/cogl-2.0/cogl-docs.xml.in b/doc/reference/cogl-2.0/cogl-docs.xml.in
index 6e02ecff..70a476c6 100644
--- a/doc/reference/cogl-2.0/cogl-docs.xml.in
+++ b/doc/reference/cogl-2.0/cogl-docs.xml.in
@@ -112,6 +112,7 @@
<xi:include href="xml/cogl-color.xml"/>
<xi:include href="xml/cogl-matrix.xml"/>
<xi:include href="xml/cogl-vector.xml"/>
+ <xi:include href="xml/cogl-quaternion.xml"/>
<xi:include href="xml/cogl-types.xml"/>
</section>
diff --git a/doc/reference/cogl-2.0/cogl-sections.txt b/doc/reference/cogl-2.0/cogl-sections.txt
index e73a3480..883135e7 100644
--- a/doc/reference/cogl-2.0/cogl-sections.txt
+++ b/doc/reference/cogl-2.0/cogl-sections.txt
@@ -356,6 +356,34 @@ cogl_matrix_get_inverse
</SECTION>
<SECTION>
+<FILE>cogl-quaternion</FILE>
+<TITLE>Quaternions (Rotations)</TITLE>
+CoglQuaternion
+cogl_quaternion_init_identity
+cogl_quaternion_init
+cogl_quaternion_init_from_angle_vector
+cogl_quaternion_init_from_array
+cogl_quaternion_init_from_x_rotation
+cogl_quaternion_init_from_y_rotation
+cogl_quaternion_init_from_z_rotation
+cogl_quaternion_equal
+cogl_quaternion_copy
+cogl_quaternion_free
+cogl_quaternion_get_rotation_angle
+cogl_quaternion_get_rotation_axis
+cogl_quaternion_normalize
+cogl_quaternion_dot_product
+cogl_quaternion_invert
+cogl_quaternion_multiply
+cogl_quaternion_pow
+cogl_quaternion_slerp
+cogl_quaternion_nlerp
+cogl_quaternion_squad
+cogl_get_static_identity_quaternion
+cogl_get_static_zero_quaternion
+</SECTION>
+
+<SECTION>
<FILE>cogl-pipeline</FILE>
<TITLE>Pipeline</TITLE>
cogl_pipeline_new
diff --git a/doc/reference/cogl/cogl-docs.xml.in b/doc/reference/cogl/cogl-docs.xml.in
index a2a31593..4f3c4522 100644
--- a/doc/reference/cogl/cogl-docs.xml.in
+++ b/doc/reference/cogl/cogl-docs.xml.in
@@ -97,6 +97,7 @@
<xi:include href="xml/cogl-buffer.xml"/>
<xi:include href="xml/cogl-vector.xml"/>
<xi:include href="xml/cogl-texture-3d.xml"/>
+ <xi:include href="xml/cogl-quaternion.xml"/>
</chapter>
diff --git a/doc/reference/cogl/cogl-sections.txt b/doc/reference/cogl/cogl-sections.txt
index 359bfac7..10423e08 100644
--- a/doc/reference/cogl/cogl-sections.txt
+++ b/doc/reference/cogl/cogl-sections.txt
@@ -658,3 +658,31 @@ cogl_program_uniform_matrix
cogl_offscreen_ref
cogl_offscreen_unref
</SECTION>
+
+<SECTION>
+<FILE>cogl-quaternion</FILE>
+<TITLE>Quaternions (Rotations)</TITLE>
+CoglQuaternion
+cogl_quaternion_init_identity
+cogl_quaternion_init
+cogl_quaternion_init_from_angle_vector
+cogl_quaternion_init_from_array
+cogl_quaternion_init_from_x_rotation
+cogl_quaternion_init_from_y_rotation
+cogl_quaternion_init_from_z_rotation
+cogl_quaternion_equal
+cogl_quaternion_copy
+cogl_quaternion_free
+cogl_quaternion_get_rotation_angle
+cogl_quaternion_get_rotation_axis
+cogl_quaternion_normalize
+cogl_quaternion_dot_product
+cogl_quaternion_invert
+cogl_quaternion_multiply
+cogl_quaternion_pow
+cogl_quaternion_slerp
+cogl_quaternion_nlerp
+cogl_quaternion_squad
+cogl_get_static_identity_quaternion
+cogl_get_static_zero_quaternion
+</SECTION>