Commit 2ce4075e authored by Michael Natterer's avatar Michael Natterer

libgimpmath: move docs from template files to inline comments

parent a5e28dec
......@@ -12,6 +12,7 @@
/libgimpmath-undeclared.txt
/libgimpmath-undocumented.txt
/html
/tmpl
/xml
/version
/.libs
......
<!-- ##### SECTION Title ##### -->
GimpMath
<!-- ##### SECTION Short_Description ##### -->
Mathematical definitions and macros.
<!-- ##### SECTION Long_Description ##### -->
<para>
Mathematical definitions and macros. These macros should be used
rather than the ones from math.h for enhanced portability.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### MACRO RINT ##### -->
<para>
This macro rounds its argument @x to an integer value in floating point
format.
</para>
@x: the value to be rounded.
<!-- ##### MACRO ROUND ##### -->
<para>
This macro rounds its argument @x to the nearest integer.
</para>
@x: the value to be rounded.
<!-- ##### MACRO SQR ##### -->
<para>
This macro squares its argument @x.
</para>
@x: the value to be squared.
<!-- ##### MACRO MAX255 ##### -->
<para>
This macro limits it argument @a, an (0-511) int, to 255.
</para>
@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: the value to be clamped.
<!-- ##### MACRO gimp_deg_to_rad ##### -->
<para>
This macro converts its argument @angle from degree to radian.
</para>
@angle: the angle to be converted.
<!-- ##### MACRO gimp_rad_to_deg ##### -->
<para>
This macro converts its argument @angle from radian to degree.
</para>
@angle: the angle to be converted.
<!-- ##### SECTION Title ##### -->
GimpMatrix
<!-- ##### SECTION Short_Description ##### -->
Utilities to set up and manipulate 3x3 transformation matrices.
<!-- ##### SECTION Long_Description ##### -->
<para>
When doing image manipulation you will often need 3x3 transformation
matrices that define translation, rotation, scaling, shearing and
arbitrary perspective transformations using a 3x3 matrix. Here you'll
find a set of utility functions to set up those matrices and to perform
basic matrix manipulations and tests.
</para>
<para>
Each matrix class has a 2 dimensional gdouble coeff member. The
element for row r and column c of the matrix is coeff[r][c].
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GimpVector2
</para>
<para>
#GimpVector3
</para>
<para>
#GimpVector4
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### 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:
<!-- ##### FUNCTION gimp_matrix2_identity ##### -->
<para>
</para>
@matrix:
<!-- ##### FUNCTION gimp_matrix2_mult ##### -->
<para>
</para>
@matrix1:
@matrix2:
<!-- ##### FUNCTION gimp_matrix3_identity ##### -->
<para>
</para>
@matrix:
<!-- ##### FUNCTION gimp_matrix3_mult ##### -->
<para>
</para>
@matrix1:
@matrix2:
<!-- ##### FUNCTION gimp_matrix3_translate ##### -->
<para>
</para>
@matrix:
@x:
@y:
<!-- ##### FUNCTION gimp_matrix3_scale ##### -->
<para>
</para>
@matrix:
@x:
@y:
<!-- ##### FUNCTION gimp_matrix3_rotate ##### -->
<para>
</para>
@matrix:
@theta:
<!-- ##### FUNCTION gimp_matrix3_xshear ##### -->
<para>
</para>
@matrix:
@amount:
<!-- ##### FUNCTION gimp_matrix3_yshear ##### -->
<para>
</para>
@matrix:
@amount:
<!-- ##### FUNCTION gimp_matrix3_affine ##### -->
<para>
</para>
@matrix:
@a:
@b:
@c:
@d:
@e:
@f:
<!-- ##### FUNCTION gimp_matrix3_transform_point ##### -->
<para>
</para>
@matrix:
@x:
@y:
@newx:
@newy:
<!-- ##### FUNCTION gimp_matrix3_determinant ##### -->
<para>
</para>
@matrix:
@Returns:
<!-- ##### FUNCTION gimp_matrix3_invert ##### -->
<para>
</para>
@matrix:
<!-- ##### FUNCTION gimp_matrix3_is_identity ##### -->
<para>
</para>
@matrix:
@Returns:
<!-- ##### FUNCTION gimp_matrix3_is_diagonal ##### -->
<para>
</para>
@matrix:
@Returns:
<!-- ##### FUNCTION gimp_matrix3_is_affine ##### -->
<para>
</para>
@matrix:
@Returns:
<!-- ##### FUNCTION gimp_matrix3_is_simple ##### -->
<para>
</para>
@matrix:
@Returns:
<!-- ##### FUNCTION gimp_matrix4_to_deg ##### -->
<para>
</para>
@matrix:
@a:
@b:
@c:
<!-- ##### MACRO GIMP_TYPE_MATRIX2 ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_TYPE_PARAM_MATRIX2 ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_IS_PARAM_SPEC_MATRIX2 ##### -->
<para>
</para>
@pspec:
<!-- ##### FUNCTION gimp_param_spec_matrix2 ##### -->
<para>
</para>
@name:
@nick:
@blurb:
@default_value:
@flags:
@Returns:
<!-- ##### MACRO GIMP_VALUE_HOLDS_MATRIX2 ##### -->
<para>
</para>
@value:
<!-- ##### SECTION Title ##### -->
GimpMD5
<!-- ##### SECTION Short_Description ##### -->
the MD5 message-digest algorithm
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### FUNCTION gimp_md5_get_digest ##### -->
<para>
</para>
@buffer:
@buffer_size:
@digest:
<
<!-- ##### SECTION Title ##### -->
GimpVector
<!-- ##### SECTION Short_Description ##### -->
Utilities to set up and manipulate vectors.
<!-- ##### SECTION Long_Description ##### -->
<para>
Utilities to set up and manipulate vectors.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GimpMatrix3
</para>
<para>
#GimpMatrix4
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpVector2 ##### -->
<para>
A two dimensional vector.
</para>
@x:
@y:
<!-- ##### STRUCT GimpVector3 ##### -->
<para>
A three dimensional vector.
</para>
@x:
@y:
@z:
<!-- ##### STRUCT GimpVector4 ##### -->
<para>
A four dimensional vector.
</para>
@x:
@y:
@z:
@w:
<!-- ##### FUNCTION gimp_vector2_new ##### -->
<para>
</para>
@x:
@y:
@Returns:
<!-- ##### FUNCTION gimp_vector2_set ##### -->
<para>
</para>
@vector:
@x:
@y:
<!-- ##### FUNCTION gimp_vector2_length ##### -->
<para>
</para>
@vector:
@Returns:
<!-- ##### FUNCTION gimp_vector2_length_val ##### -->
<para>
</para>
@vector:
@Returns:
<!-- ##### FUNCTION gimp_vector2_mul ##### -->
<para>
</para>
@vector:
@factor:
<!-- ##### FUNCTION gimp_vector2_mul_val ##### -->
<para>
</para>
@vector:
@factor:
@Returns:
<!-- ##### FUNCTION gimp_vector2_normalize ##### -->
<para>
</para>
@vector:
<!-- ##### FUNCTION gimp_vector2_normalize_val ##### -->
<para>
</para>
@vector:
@Returns:
<!-- ##### FUNCTION gimp_vector2_neg ##### -->
<para>
</para>
@vector:
<!-- ##### FUNCTION gimp_vector2_neg_val ##### -->
<para>
</para>
@vector:
@Returns:
<!-- ##### FUNCTION gimp_vector2_add ##### -->
<para>
</para>
@result:
@vector1:
@vector2:
<!-- ##### FUNCTION gimp_vector2_add_val ##### -->
<para>
</para>
@vector1:
@vector2:
@Returns:
<!-- ##### FUNCTION gimp_vector2_sub ##### -->
<para>
</para>
@result:
@vector1:
@vector2:
<!-- ##### FUNCTION gimp_vector2_sub_val ##### -->
<para>
</para>
@vector1:
@vector2:
@Returns:
<!-- ##### FUNCTION gimp_vector2_inner_product ##### -->
<para>
</para>
@vector1:
@vector2:
@Returns:
<!-- ##### FUNCTION gimp_vector2_inner_product_val ##### -->
<para>
</para>
@vector1:
@vector2:
@Returns:
<!-- ##### FUNCTION gimp_vector2_cross_product ##### -->
<para>
</para>
@vector1:
@vector2:
@Returns:
<!-- ##### FUNCTION gimp_vector2_cross_product_val ##### -->
<para>
</para>
@vector1:
@vector2:
@Returns:
<!-- ##### FUNCTION gimp_vector2_rotate ##### -->
<para>
</para>
@vector:
@alpha:
<!-- ##### FUNCTION gimp_vector2_rotate_val ##### -->
<para>
</para>
@vector:
@alpha:
@Returns:
<!-- ##### FUNCTION gimp_vector3_new ##### -->
<para>
</para>
@x:
@y:
@z:
@Returns:
<!-- ##### FUNCTION gimp_vector3_set ##### -->
<para>
</para>
@vector:
@x:
@y:
@z:
<!-- ##### FUNCTION gimp_vector3_length ##### -->
<para>
</para>
@vector:
@Returns:
<!-- ##### FUNCTION gimp_vector3_length_val ##### -->
<para>
</para>
@vector:
@Returns:
<!-- ##### FUNCTION gimp_vector3_mul ##### -->
<para>
</para>
@vector:
@factor:
<!-- ##### FUNCTION gimp_vector3_mul_val ##### -->
<para>
</para>
@vector:
@factor:
@Returns:
<!-- ##### FUNCTION gimp_vector3_normalize ##### -->
<para>
</para>
@vector:
<!-- ##### FUNCTION gimp_vector3_normalize_val ##### -->
<para>
</para>
@vector:
@Returns:
<!-- ##### FUNCTION gimp_vector3_neg ##### -->
<para>
</para>
@vector:
<!-- ##### FUNCTION gimp_vector3_neg_val ##### -->
<para>
</para>
@vector:
@Returns:
<!-- ##### FUNCTION gimp_vector3_add ##### -->
<para>
</para>
@result:
@vector1:
@vector2:
<!-- ##### FUNCTION gimp_vector3_add_val ##### -->
<para>
</para>
@vector1:
@vector2:
@Returns:
<!-- ##### FUNCTION gimp_vector3_sub ##### -->
<para>
</para>
@result:
@vector1:
@vector2:
<!-- ##### FUNCTION gimp_vector3_sub_val ##### -->
<para>
</para>
@vector1:
@vector2:
@Returns:
<!-- ##### FUNCTION gimp_vector3_inner_product ##### -->
<para>
</para>
@vector1:
@vector2:
@Returns: