From 0bc1f36ead2909ac89e163f3592654c6ac78a112 Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Mon, 23 Feb 2009 13:44:03 +0000 Subject: [PATCH] [docs] Document envvars and command line switches Clutter uses checks on various environment variables and installs various command line switches. The API reference should list them and document them both. --- doc/reference/clutter/Makefile.am | 6 +- doc/reference/clutter/clutter-docs.xml | 2 +- doc/reference/clutter/running-clutter.xml | 172 ++++++++++++++++++++++ 3 files changed, 177 insertions(+), 3 deletions(-) create mode 100644 doc/reference/clutter/running-clutter.xml diff --git a/doc/reference/clutter/Makefile.am b/doc/reference/clutter/Makefile.am index 1deacfc27..0cf6aa1e9 100644 --- a/doc/reference/clutter/Makefile.am +++ b/doc/reference/clutter/Makefile.am @@ -103,7 +103,8 @@ content_files= \ clutter-animation-tutorial.xml \ creating-behaviours.xml \ clutter-overview.xml \ - building-clutter.xml + building-clutter.xml \ + running-clutter.xml # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded # These files must be listed here *and* in content_files @@ -113,7 +114,8 @@ expand_content_files= \ clutter-animation-tutorial.xml \ creating-behaviours.xml \ clutter-overview.xml \ - building-clutter.xml + building-clutter.xml \ + running-clutter.xml # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. # Only needed if you are using gtkdoc-scangobj to dynamically query widget diff --git a/doc/reference/clutter/clutter-docs.xml b/doc/reference/clutter/clutter-docs.xml index 64a885010..15abdcc25 100644 --- a/doc/reference/clutter/clutter-docs.xml +++ b/doc/reference/clutter/clutter-docs.xml @@ -43,8 +43,8 @@ - + Clutter Core Reference diff --git a/doc/reference/clutter/running-clutter.xml b/doc/reference/clutter/running-clutter.xml new file mode 100644 index 000000000..8dbc2ce91 --- /dev/null +++ b/doc/reference/clutter/running-clutter.xml @@ -0,0 +1,172 @@ + + + + Emmanuele + Bassi + +
+ ebassi@linux.intel.com +
+ + + + + Running Clutter + + + +
+ Environment Variables + + + Clutter automatically checks environment variables during + its initialization. These environment variables are meant + as debug tools, overrides for default behaviours or to + address known hardware issues: + + + + + CLUTTER_TEXT_DIRECTION + + Forces the text direction of every Pango layout + inside Clutter. Valid values are: ltr or rtl + + + + CLUTTER_SHOW_FPS + + Prints out the frames per second achieved by Clutter. + + + + CLUTTER_DEFAULT_FPS + + Sets the default framerate. + + + + CLUTTER_DISABLE_MIPMAPPED_TEXT + + Disables mipmapping when rendering text. + + + + CLUTTER_FUZZY_PICK + + Enables "fuzzy picking". + + + + CLUTTER_DEBUG + + Enables debugging modes for Clutter. + + + + COGL_DEBUG + + Enables debugging modes for COGL. + + + + + On the GLX backend there is also: + + + + CLUTTER_VBLANK + + Selects the sync-to-vblank mode to be used. + Valid values are: none, dri or glx + + + + +
+ +
+ Command Line Arguments + + Similarly to the environment variables, Clutter also installs + command line switches that are parsed during initialization: + + + + --clutter-show-fps + Equivalent of CLUTTER_SHOW_FPS. Prints the + current rendering speed in frames per second. + + + --clutter-default-fps=FPS + Equivalent of CLUTTER_DEFAULT_FPS. Sets the + default framerate. + + + --clutter-text-direction=DIRECTION + Equivalent of CLUTTER_TEXT_DIRECTION. Sets the + direction for the text. + + + --clutter-disable-mipmapped-text + Equivalent of CLUTTER_DISABLE_MIPMAPPED_TEXT. + Disables mipmapping when rendering text. + + + --clutter-use-fuzzy-picking + Equivalent of CLUTTER_FUZZY_PICK. Enables + "fuzzy" picking. + + + --clutter-debug=FLAGS + Equivalent of CLUTTER_DEBUG. Sets FLAGS as the + Clutter debugging flags. + + + --clutter-no-debug=FLAGS + Unsets FLAGS from the Clutter debugging + flags. + + + --cogl-debug=FLAGS + Equivalent of COGL_DEBUG. Sets FLAGS as the + COGL debugging flags. + + + --cogl-no-debug=FLAGS + Unsets FLAGS from the COGL debugging + flags. + + + + The X11 backends also have the following command line + options: + + + + --display=DISPLAY + Sets the X11 display to use. + + + --screen=SCREEN + Sets the X11 screen number to use. + + + --synch + Make X11 calls synchronous. + + +
+ + The GLX backend also has the following command line option: + + + + --vblank=METHOD + Equivalent of CLUTTER_VBLANK. Sets the sync-to-vblank + method to be used. + + + + +