isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2025-01-03 08:12:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

documentation fixed for clutter-fixed

Browse Source
This commit is contained in:
Tomas Frydrych 2007-01-18 10:33:24 +00:00
parent bf376d1aac
commit 614cd7e895
5 changed files with 45 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
ChangeLog
View File

@ -1,3 +1,7 @@
2007-01-18 Tomas Frydrych <tf@openedhand.com>
* clutter/clutter-fixed.h: fixed a typo in comment
2007-01-18 Emmanuele Bassi <ebassi@openedhand.com> 2007-01-18 Emmanuele Bassi <ebassi@openedhand.com>
* clutter/clutter-fixed.h: Remove some inline documentation to * clutter/clutter-fixed.h: Remove some inline documentation to

2
clutter/clutter-fixed.h
View File

@ -40,7 +40,7 @@ typedef gint32 ClutterFixed;
/** /**
* ClutterAngle: * ClutterAngle:
* *
* Integer representation of an agnle such that 1024 corresponds to * Integer representation of an angle such that 1024 corresponds to
* full circle (i.e., 2*Pi). * full circle (i.e., 2*Pi).
*/ */
typedef gint32 ClutterAngle; /* angle such that 1024 == 2*PI */ typedef gint32 ClutterAngle; /* angle such that 1024 == 2*PI */

5
doc/reference/ChangeLog
View File

@ -1,3 +1,8 @@
2007-01-18 Tomas Frydrych <tf@openedhand.com>
* clutter-docs.sgml: added clutter-fixed
* tmpl/clutter-fixed.sgml: added intro to fixed point math
2007-01-18 Emmanuele Bassi <ebassi@openedhand.com> 2007-01-18 Emmanuele Bassi <ebassi@openedhand.com>
* clutter-sections.txt: Remove old cruft. * clutter-sections.txt: Remove old cruft.

1
doc/reference/clutter-docs.sgml
View File

@ -91,6 +91,7 @@
<xi:include href="xml/clutter-event.xml"/> <xi:include href="xml/clutter-event.xml"/>
<xi:include href="xml/clutter-color.xml"/> <xi:include href="xml/clutter-color.xml"/>
<xi:include href="xml/clutter-util.xml"/> <xi:include href="xml/clutter-util.xml"/>
<xi:include href="xml/clutter-fixed.xml"/>
<xi:include href="xml/clutter-version.xml"/> <xi:include href="xml/clutter-version.xml"/>
</chapter> </chapter>

40
doc/reference/tmpl/clutter-fixed.sgml
View File

@ -13,6 +13,34 @@ emulation, relying on integer math for fixed-to-floating and
floating-to-fixed conversion. floating-to-fixed conversion.
</para> </para>
<section>
<title>Basic Rules of Fixed Point Arithmetic</title>
<itemizedlist>
<listitem>
<para>
Two fixed point numbers can be directly added and subtracted.
</para>
</listitem>
<listitem>
<para>
To add other numerical type to a fixed point number it has to be first
converted to fixed point.
</para>
</listitem>
<listitem>
<para>
A fixed point number can be directly multiplied or divided by an integer.
</para>
</listitem>
<listitem>
<para>
Two fixed point numbers can only be multiplied and divided by the provided
#CLUTTER_FIXED_MUL (aka #CFX_MUL) and #CLUTTER_FIXED_DIV (aka #CFX_DIV) macros.
</para>
</listitem>
</itemizedlist>
</section>
<!-- ##### SECTION See_Also ##### --> <!-- ##### SECTION See_Also ##### -->
<para> <para>
@ -27,6 +55,12 @@ floating-to-fixed conversion.
</para> </para>
<!-- ##### TYPEDEF ClutterAngle ##### -->
<para>
</para>
<!-- ##### MACRO CFX_Q ##### --> <!-- ##### MACRO CFX_Q ##### -->
<para> <para>
Number of bits used to store fractional part of #ClutterFixed. Number of bits used to store fractional part of #ClutterFixed.
@ -55,12 +89,6 @@ Minumum number representable by #ClutterFixed.
<!-- ##### TYPEDEF ClutterAngle ##### -->
<para>
</para>
<!-- ##### MACRO CFX_PI ##### --> <!-- ##### MACRO CFX_PI ##### -->
<para> <para>