Commit 9fe95e9c authored by Henrik Brix Andersen's avatar Henrik Brix Andersen Committed by Henrik Brix Andersen

added an inline gtk-doc stub to be filled in. Someone please fill this

2003-11-15 Henrik Brix Andersen <brix@gimp.org>

* libgimpmath/gimpmatrix.c (gimp_matrix4_to_deg): added an inline
gtk-doc stub to be filled in. Someone please fill this in...

* devel-docs/libgimpmath/tmpl/gimpmatrix.sgml
* devel-docs/libgimpmath/tmpl/gimpvector.sgml
* devel-docs/libgimpmath/tmpl/gimpmath.sgml: added descriptions

* devel-docs/libgimpmath/libgimpmath-sections.txt: reordered functions

* libgimpmath/gimpvector.[ch]: reordered functions here as well to
be consistent, touched up the inline gtk-docs
parent 050a5435
2003-11-15 Henrik Brix Andersen <brix@gimp.org>
* libgimpmath/gimpmatrix.c (gimp_matrix4_to_deg): added an inline
gtk-doc stub to be filled in. Someone please fill this in...
* devel-docs/libgimpmath/tmpl/gimpmatrix.sgml
* devel-docs/libgimpmath/tmpl/gimpvector.sgml
* devel-docs/libgimpmath/tmpl/gimpmath.sgml: added descriptions
* devel-docs/libgimpmath/libgimpmath-sections.txt: reordered functions
* libgimpmath/gimpvector.[ch]: reordered functions here as well to
be consistent, touched up the inline gtk-docs
2003-11-15 Sven Neumann <sven@gimp.org>
* plug-ins/common/gih.c (gih_load_one_brush): add an alpha channel
......@@ -48,43 +48,43 @@ GimpVector2
GimpVector3
GimpVector4
gimp_vector2_new
gimp_vector2_inner_product
gimp_vector2_inner_product_val
gimp_vector2_cross_product
gimp_vector2_cross_product_val
gimp_vector2_set
gimp_vector2_length
gimp_vector2_length_val
gimp_vector2_normalize
gimp_vector2_normalize_val
gimp_vector2_mul
gimp_vector2_mul_val
gimp_vector2_sub
gimp_vector2_sub_val
gimp_vector2_set
gimp_vector2_add
gimp_vector2_add_val
gimp_vector2_normalize
gimp_vector2_normalize_val
gimp_vector2_neg
gimp_vector2_neg_val
gimp_vector2_add
gimp_vector2_add_val
gimp_vector2_sub
gimp_vector2_sub_val
gimp_vector2_inner_product
gimp_vector2_inner_product_val
gimp_vector2_cross_product
gimp_vector2_cross_product_val
gimp_vector2_rotate
gimp_vector2_rotate_val
gimp_vector3_inner_product
gimp_vector3_inner_product_val
gimp_vector3_cross_product
gimp_vector3_cross_product_val
gimp_vector3_new
gimp_vector3_set
gimp_vector3_length
gimp_vector3_length_val
gimp_vector3_normalize
gimp_vector3_normalize_val
gimp_vector3_mul
gimp_vector3_mul_val
gimp_vector3_sub
gimp_vector3_sub_val
gimp_vector3_set
gimp_vector3_new
gimp_vector3_add
gimp_vector3_add_val
gimp_vector3_normalize
gimp_vector3_normalize_val
gimp_vector3_neg
gimp_vector3_neg_val
gimp_vector3_add
gimp_vector3_add_val
gimp_vector3_sub
gimp_vector3_sub_val
gimp_vector3_inner_product
gimp_vector3_inner_product_val
gimp_vector3_cross_product
gimp_vector3_cross_product_val
gimp_vector3_rotate
gimp_vector3_rotate_val
gimp_vector_2d_to_3d
......
......@@ -6,7 +6,8 @@ Mathematical definitions and macros.
<!-- ##### SECTION Long_Description ##### -->
<para>
Mathematical definitions and macros.
Mathematical definitions and macros. These macros should be used
rather than the ones from math.h for enhanced portability.
</para>
<!-- ##### SECTION See_Also ##### -->
......@@ -16,57 +17,59 @@ Mathematical definitions and macros.
<!-- ##### MACRO RINT ##### -->
<para>
This macro rounds its argument @x to an integer value in floating point
format.
</para>
@x:
@x: the value to be rounded.
<!-- ##### MACRO ROUND ##### -->
<para>
This macro rounds its argument @x to the nearest integer.
</para>
@x:
@x: the value to be rounded.
<!-- ##### MACRO SQR ##### -->
<para>
This macro squares its argument @x.
</para>
@x:
@x: the value to be squared.
<!-- ##### MACRO MAX255 ##### -->
<para>
This macro limits it argument @a, an (0-511) int, to 255.
</para>
@a:
@a: the value to be limited.
<!-- ##### MACRO CLAMP0255 ##### -->
<para>
This macro clamps its argument @a, an int32-range int, between 0 and
255 inclusive.
</para>
@a:
@a: the value to be clamped.
<!-- ##### MACRO gimp_deg_to_rad ##### -->
<para>
This macro converts its argument @angle from degree to radian.
</para>
@angle:
@angle: the angle to be converted.
<!-- ##### MACRO gimp_rad_to_deg ##### -->
<para>
This macro converts its argument @angle from radian to degree.
</para>
@angle:
@angle: the angle to be converted.
......@@ -26,21 +26,21 @@ basic matrix manipulations and tests.
<!-- ##### STRUCT GimpMatrix2 ##### -->
<para>
A two by two matrix.
</para>
@coeff:
<!-- ##### STRUCT GimpMatrix3 ##### -->
<para>
A three by three matrix.
</para>
@coeff:
<!-- ##### STRUCT GimpMatrix4 ##### -->
<para>
A four by four matrix.
</para>
@coeff:
......
......@@ -20,7 +20,7 @@ Utilities to set up and manipulate vectors.
<!-- ##### STRUCT GimpVector2 ##### -->
<para>
A two dimensional vector.
</para>
@x:
......@@ -28,7 +28,7 @@ Utilities to set up and manipulate vectors.
<!-- ##### STRUCT GimpVector3 ##### -->
<para>
A three dimensional vector.
</para>
@x:
......@@ -37,7 +37,7 @@ Utilities to set up and manipulate vectors.
<!-- ##### STRUCT GimpVector4 ##### -->
<para>
A four dimensional vector.
</para>
@x:
......@@ -55,61 +55,50 @@ Utilities to set up and manipulate vectors.
@Returns:
<!-- ##### FUNCTION gimp_vector2_inner_product ##### -->
<para>
</para>
@vector1:
@vector2:
@Returns:
<!-- ##### FUNCTION gimp_vector2_inner_product_val ##### -->
<!-- ##### FUNCTION gimp_vector2_set ##### -->
<para>
</para>
@vector1:
@vector2:
@Returns:
@vector:
@x:
@y:
<!-- ##### FUNCTION gimp_vector2_cross_product ##### -->
<!-- ##### FUNCTION gimp_vector2_length ##### -->
<para>
</para>
@vector1:
@vector2:
@vector:
@Returns:
<!-- ##### FUNCTION gimp_vector2_cross_product_val ##### -->
<!-- ##### FUNCTION gimp_vector2_length_val ##### -->
<para>
</para>
@vector1:
@vector2:
@vector:
@Returns:
<!-- ##### FUNCTION gimp_vector2_length ##### -->
<!-- ##### FUNCTION gimp_vector2_mul ##### -->
<para>
</para>
@vector:
@Returns:
@factor:
<!-- ##### FUNCTION gimp_vector2_length_val ##### -->
<!-- ##### FUNCTION gimp_vector2_mul_val ##### -->
<para>
</para>
@vector:
@factor:
@Returns:
......@@ -130,26 +119,24 @@ Utilities to set up and manipulate vectors.
@Returns:
<!-- ##### FUNCTION gimp_vector2_mul ##### -->
<!-- ##### FUNCTION gimp_vector2_neg ##### -->
<para>
</para>
@vector:
@factor:
<!-- ##### FUNCTION gimp_vector2_mul_val ##### -->
<!-- ##### FUNCTION gimp_vector2_neg_val ##### -->
<para>
</para>
@vector:
@factor:
@Returns:
<!-- ##### FUNCTION gimp_vector2_sub ##### -->
<!-- ##### FUNCTION gimp_vector2_add ##### -->
<para>
</para>
......@@ -159,7 +146,7 @@ Utilities to set up and manipulate vectors.
@vector2:
<!-- ##### FUNCTION gimp_vector2_sub_val ##### -->
<!-- ##### FUNCTION gimp_vector2_add_val ##### -->
<para>
</para>
......@@ -169,27 +156,27 @@ Utilities to set up and manipulate vectors.
@Returns:
<!-- ##### FUNCTION gimp_vector2_set ##### -->
<!-- ##### FUNCTION gimp_vector2_sub ##### -->
<para>
</para>
@vector:
@x:
@y:
@result:
@vector1:
@vector2:
<!-- ##### FUNCTION gimp_vector2_add ##### -->
<!-- ##### FUNCTION gimp_vector2_sub_val ##### -->
<para>
</para>
@result:
@vector1:
@vector2:
@Returns:
<!-- ##### FUNCTION gimp_vector2_add_val ##### -->
<!-- ##### FUNCTION gimp_vector2_inner_product ##### -->
<para>
</para>
......@@ -199,20 +186,33 @@ Utilities to set up and manipulate vectors.
@Returns:
<!-- ##### FUNCTION gimp_vector2_neg ##### -->
<!-- ##### FUNCTION gimp_vector2_inner_product_val ##### -->
<para>
</para>
@vector:
@vector1:
@vector2:
@Returns:
<!-- ##### FUNCTION gimp_vector2_neg_val ##### -->
<!-- ##### FUNCTION gimp_vector2_cross_product ##### -->
<para>
</para>
@vector:
@vector1:
@vector2:
@Returns:
<!-- ##### FUNCTION gimp_vector2_cross_product_val ##### -->
<para>
</para>
@vector1:
@vector2:
@Returns:
......@@ -235,61 +235,62 @@ Utilities to set up and manipulate vectors.
@Returns:
<!-- ##### FUNCTION gimp_vector3_inner_product ##### -->
<!-- ##### FUNCTION gimp_vector3_new ##### -->
<para>
</para>
@vector1:
@vector2:
@x:
@y:
@z:
@Returns:
<!-- ##### FUNCTION gimp_vector3_inner_product_val ##### -->
<!-- ##### FUNCTION gimp_vector3_set ##### -->
<para>
</para>
@vector1:
@vector2:
@Returns:
@vector:
@x:
@y:
@z:
<!-- ##### FUNCTION gimp_vector3_cross_product ##### -->
<!-- ##### FUNCTION gimp_vector3_length ##### -->
<para>
</para>
@vector1:
@vector2:
@vector:
@Returns:
<!-- ##### FUNCTION gimp_vector3_cross_product_val ##### -->
<!-- ##### FUNCTION gimp_vector3_length_val ##### -->
<para>
</para>
@vector1:
@vector2:
@vector:
@Returns:
<!-- ##### FUNCTION gimp_vector3_length ##### -->
<!-- ##### FUNCTION gimp_vector3_mul ##### -->
<para>
</para>
@vector:
@Returns:
@factor:
<!-- ##### FUNCTION gimp_vector3_length_val ##### -->
<!-- ##### FUNCTION gimp_vector3_mul_val ##### -->
<para>
</para>
@vector:
@factor:
@Returns:
......@@ -310,26 +311,24 @@ Utilities to set up and manipulate vectors.
@Returns:
<!-- ##### FUNCTION gimp_vector3_mul ##### -->
<!-- ##### FUNCTION gimp_vector3_neg ##### -->
<para>
</para>
@vector:
@factor:
<!-- ##### FUNCTION gimp_vector3_mul_val ##### -->
<!-- ##### FUNCTION gimp_vector3_neg_val ##### -->
<para>
</para>
@vector:
@factor:
@Returns:
<!-- ##### FUNCTION gimp_vector3_sub ##### -->
<!-- ##### FUNCTION gimp_vector3_add ##### -->
<para>
</para>
......@@ -339,7 +338,7 @@ Utilities to set up and manipulate vectors.
@vector2:
<!-- ##### FUNCTION gimp_vector3_sub_val ##### -->
<!-- ##### FUNCTION gimp_vector3_add_val ##### -->
<para>
</para>
......@@ -349,39 +348,37 @@ Utilities to set up and manipulate vectors.
@Returns:
<!-- ##### FUNCTION gimp_vector3_set ##### -->
<!-- ##### FUNCTION gimp_vector3_sub ##### -->
<para>
</para>
@vector:
@x:
@y:
@z:
@result:
@vector1:
@vector2:
<!-- ##### FUNCTION gimp_vector3_new ##### -->
<!-- ##### FUNCTION gimp_vector3_sub_val ##### -->
<para>
</para>
@x:
@y:
@z:
@vector1:
@vector2:
@Returns:
<!-- ##### FUNCTION gimp_vector3_add ##### -->
<!-- ##### FUNCTION gimp_vector3_inner_product ##### -->
<para>
</para>
@result:
@vector1:
@vector2:
@Returns:
<!-- ##### FUNCTION gimp_vector3_add_val ##### -->
<!-- ##### FUNCTION gimp_vector3_inner_product_val ##### -->
<para>
</para>
......@@ -391,20 +388,23 @@ Utilities to set up and manipulate vectors.
@Returns:
<!-- ##### FUNCTION gimp_vector3_neg ##### -->
<!-- ##### FUNCTION gimp_vector3_cross_product ##### -->
<para>
</para>
@vector:
@vector1:
@vector2:
@Returns:
<!-- ##### FUNCTION gimp_vector3_neg_val ##### -->
<!-- ##### FUNCTION gimp_vector3_cross_product_val ##### -->
<para>
</para>
@vector:
@vector1:
@vector2:
@Returns:
......
......@@ -484,6 +484,15 @@ gimp_matrix3_is_simple (const GimpMatrix3 *matrix)
return TRUE;
}
/**
* gimp_matrix4_to_deg:
* @matrix:
* @a:
* @b:
* @c:
*
*
**/
void
gimp_matrix4_to_deg (const GimpMatrix4 *matrix,
gdouble *a,
......
This diff is collapsed.
......@@ -49,39 +49,39 @@ struct _GimpVector4
/* Two dimensional vector functions */
/* ================================ */
gdouble gimp_vector2_inner_product (const GimpVector2 *vector1,
const GimpVector2 *vector2);
gdouble gimp_vector2_inner_product_val (GimpVector2 vector1,
GimpVector2 vector2);
GimpVector2 gimp_vector2_cross_product (const GimpVector2 *vector1,
const GimpVector2 *vector2);
GimpVector2 gimp_vector2_cross_product_val (GimpVector2 vector1,
GimpVector2 vector2);
GimpVector2 gimp_vector2_new (gdouble x,
gdouble y);
void gimp_vector2_set (GimpVector2 *vector,
gdouble x,
gdouble y);
gdouble gimp_vector2_length (const GimpVector2 *vector);
gdouble gimp_vector2_length_val (GimpVector2 vector);
void gimp_vector2_normalize (GimpVector2 *vector);
GimpVector2 gimp_vector2_normalize_val (GimpVector2 vector);
void gimp_vector2_mul (GimpVector2 *vector,
gdouble factor);
GimpVector2 gimp_vector2_mul_val (GimpVector2 vector,
gdouble factor);
void gimp_vector2_normalize (GimpVector2 *vector);
GimpVector2 gimp_vector2_normalize_val (GimpVector2 vector);
void gimp_vector2_neg (GimpVector2 *vector);
GimpVector2 gimp_vector2_neg_val (GimpVector2 vector);
void gimp_vector2_add (GimpVector2 *result,
const GimpVector2 *vector1,
const GimpVector2 *vector2);
GimpVector2 gimp_vector2_add_val (GimpVector2 vector1,
GimpVector2 vector2);
void gimp_vector2_sub (GimpVector2 *result,
const GimpVector2 *vector1,
const GimpVector2 *vector2);
GimpVector2 gimp_vector2_sub_val (GimpVector2 vector1,
GimpVector2 vector2);
void gimp_vector2_set (GimpVector2 *vector,
gdouble x,
gdouble y);
GimpVector2 gimp_vector2_new (gdouble x,
gdouble y);
void gimp_vector2_add (GimpVector2 *result,
const GimpVector2 *vector1,
gdouble gimp_vector2_inner_product (const GimpVector2 *vector1,
const GimpVector2 *vector2);
GimpVector2 gimp_vector2_add_val (GimpVector2 vector1,
gdouble gimp_vector2_inner_product_val (GimpVector2 vector1,
GimpVector2 vector2);
GimpVector2 gimp_vector2_cross_product (const GimpVector2 *vector1,
const GimpVector2 *vector2);
GimpVector2 gimp_vector2_cross_product_val (GimpVector2 vector1,
GimpVector2 vector2);
void gimp_vector2_neg (GimpVector2 *vector);
GimpVector2 gimp_vector2_neg_val (GimpVector2 vector);
void gimp_vector2_rotate (GimpVector2 *vector,
gdouble alpha);
GimpVector2 gimp_vector2_rotate_val (GimpVector2 vector,
......@@ -90,41 +90,41 @@ GimpVector2 gimp_vector2_rotate_val (GimpVector2 vector,
/* Three dimensional vector functions */
/* ================================== */
gdouble gimp_vector3_inner_product (const GimpVector3 *vector1,
const GimpVector3 *vector2);
gdouble gimp_vector3_inner_product_val (GimpVector3 vector1,
GimpVector3 vector2);
GimpVector3 gimp_vector3_cross_product (const GimpVector3 *vector1,
const GimpVector3 *vector2);
GimpVector3 gimp_vector3_cross_product_val (GimpVector3 vector1,
GimpVector3 vector2);
GimpVector3 gimp_vector3_new (gdouble x,
gdouble y,
gdouble z);
void gimp_vector3_set (GimpVector3 *vector,
gdouble x,
gdouble y,
gdouble z);
gdouble gimp_vector3_length (const GimpVector3 *vector);
gdouble gimp_vector3_length_val (GimpVector3 vector);
void gimp_vector3_normalize (GimpVector3 *vector);
GimpVector3 gimp_vector3_normalize_val (GimpVector3 vector);
void gimp_vector3_mul (GimpVector3 *vector,
gdouble factor);
GimpVector3 gimp_vector3_mul_val (GimpVector3 vector,
gdouble factor);
void gimp_vector3_normalize (GimpVector3 *vector);
GimpVector3 gimp_vector3_normalize_val (GimpVector3 vector);
void gimp_vector3_neg (GimpVector3 *vector);
GimpVector3 gimp_vector3_neg_val (GimpVector3 vector);
void gimp_vector3_add (GimpVector3 *result,
const GimpVector3 *vector1,
const GimpVector3 *vector2);
GimpVector3 gimp_vector3_add_val (GimpVector3 vector1,
GimpVector3 vector2);
void gimp_vector3_sub (GimpVector3 *result,
const GimpVector3 *vector1,
const GimpVector3 *vector2);
GimpVector3 gimp_vector3_sub_val (GimpVector3 vector1,
GimpVector3 vector2);
void gimp_vector3_set (GimpVector3 *vector,
gdouble x,
gdouble y,
gdouble z);
GimpVector3 gimp_vector3_new (gdouble x,
gdouble y,
gdouble z);
void gimp_vector3_add (GimpVector3 *result,
const GimpVector3 *vector1,
gdouble gimp_vector3_inner_product (const GimpVector3 *vector1,
const GimpVector3 *vector2);
GimpVector3 gimp_vector3_add_val (GimpVector3 vector1,
gdouble gimp_vector3_inner_product_val (GimpVector3 vector1,
GimpVector3 vector2);
GimpVector3 gimp_vector3_cross_product (const GimpVector3 *vector1,
const GimpVector3 *vector2);
GimpVector3 gimp_vector3_cross_product_val (GimpVector3 vector1,
GimpVector3 vector2);
void gimp_vector3_neg (GimpVector3 *vector);
GimpVector3 gimp_vector3_neg_val (GimpVector3 vector);
void gimp_vector3_rotate (GimpVector3 *vector,
gdouble alpha,
gdouble beta,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment