One Hat Cyber Team

Edit File: ClutterX11-8.gir

<?xml version="1.0"?>

<repository version="1.2"
            xmlns="http://www.gtk.org/introspection/core/1.0"
            xmlns:c="http://www.gtk.org/introspection/c/1.0"
            xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
  <include name="Clutter" version="8"/>
  <include name="Cogl" version="8"/>
  <include name="CoglPango" version="8"/>
  <include name="xlib" version="2.0"/>
  <package name="mutter-clutter-x11-8"/>
  <namespace name="ClutterX11"
             version="8"
             shared-library="libmutter-clutter-8.so.0"
             c:identifier-prefixes="ClutterX11"
             c:symbol-prefixes="clutter_x11">
    <callback name="FilterFunc" c:type="ClutterX11FilterFunc" version="0.6">
      <doc xml:space="preserve"
           filename="clutter/clutter/x11/clutter-x11.h"
           line="75">Filter function for X11 native events.</doc>
      <source-position filename="clutter/clutter/x11/clutter-x11.h" line="87"/>
      <return-value transfer-ownership="none">
        <doc xml:space="preserve"
             filename="clutter/clutter/x11/clutter-x11.h"
             line="83">the result of the filtering</doc>
        <type name="FilterReturn" c:type="ClutterX11FilterReturn"/>
      </return-value>
      <parameters>
        <parameter name="xev" transfer-ownership="none">
          <doc xml:space="preserve"
               filename="clutter/clutter/x11/clutter-x11.h"
               line="77">Native X11 event structure</doc>
          <type name="xlib.XEvent" c:type="XEvent*"/>
        </parameter>
        <parameter name="cev" transfer-ownership="none">
          <doc xml:space="preserve"
               filename="clutter/clutter/x11/clutter-x11.h"
               line="78">Clutter event structure</doc>
          <type name="Clutter.Event" c:type="ClutterEvent*"/>
        </parameter>
        <parameter name="data"
                   transfer-ownership="none"
                   nullable="1"
                   allow-none="1"
                   closure="2">
          <doc xml:space="preserve"
               filename="clutter/clutter/x11/clutter-x11.h"
               line="79">user data passed to the filter function</doc>
          <type name="gpointer" c:type="gpointer"/>
        </parameter>
      </parameters>
    </callback>
    <enumeration name="FilterReturn"
                 version="0.6"
                 glib:type-name="ClutterX11FilterReturn"
                 glib:get-type="clutter_x11_filter_return_get_type"
                 c:type="ClutterX11FilterReturn">
      <doc xml:space="preserve"
           filename="clutter/clutter/x11/clutter-x11.h"
           line="48">Return values for the #ClutterX11FilterFunc function.</doc>
      <member name="continue"
              value="0"
              c:identifier="CLUTTER_X11_FILTER_CONTINUE"
              glib:nick="continue">
        <doc xml:space="preserve"
             filename="clutter/clutter/x11/clutter-x11.h"
             line="50">The event was not handled, continues the
  processing</doc>
      </member>
      <member name="translate"
              value="1"
              c:identifier="CLUTTER_X11_FILTER_TRANSLATE"
              glib:nick="translate">
        <doc xml:space="preserve"
             filename="clutter/clutter/x11/clutter-x11.h"
             line="52">Native event translated into a Clutter
  event, stops the processing</doc>
      </member>
      <member name="remove"
              value="2"
              c:identifier="CLUTTER_X11_FILTER_REMOVE"
              glib:nick="remove">
        <doc xml:space="preserve"
             filename="clutter/clutter/x11/clutter-x11.h"
             line="54">Remove the event, stops the processing</doc>
      </member>
    </enumeration>
    <record name="XInputDevice" c:type="ClutterX11XInputDevice" disguised="1">
      <source-position filename="clutter/clutter/x11/clutter-x11.h" line="73"/>
    </record>
    <function name="add_filter"
              c:identifier="clutter_x11_add_filter"
              version="0.6"
              introspectable="0">
      <doc xml:space="preserve"
           filename="clutter/clutter/x11/clutter-backend-x11.c"
           line="802">Adds an event filter function.</doc>
      <source-position filename="clutter/clutter/x11/clutter-x11.h"
                       line="106"/>
      <return-value transfer-ownership="none">
        <type name="none" c:type="void"/>
      </return-value>
      <parameters>
        <parameter name="func" transfer-ownership="none" closure="1">
          <doc xml:space="preserve"
               filename="clutter/clutter/x11/clutter-backend-x11.c"
               line="804">a filter function</doc>
          <type name="FilterFunc" c:type="ClutterX11FilterFunc"/>
        </parameter>
        <parameter name="data"
                   transfer-ownership="none"
                   nullable="1"
                   allow-none="1">
          <doc xml:space="preserve"
               filename="clutter/clutter/x11/clutter-backend-x11.c"
               line="805">user data to be passed to the filter function, or %NULL</doc>
          <type name="gpointer" c:type="gpointer"/>
        </parameter>
      </parameters>
    </function>
    <docsection name="clutter-x11">
      <doc xml:space="preserve"
           filename="clutter/clutter/x11/clutter-x11.h"
           line="26">The X11 backend for Clutter provides some specific API, allowing
integration with the Xlibs API for embedding and manipulating the
stage window, or for trapping X errors.

The ClutterX11 API is available since Clutter 0.6</doc>
    </docsection>
    <function name="get_default_display"
              c:identifier="clutter_x11_get_default_display"
              version="0.6">
      <doc xml:space="preserve"
           filename="clutter/clutter/x11/clutter-backend-x11.c"
           line="687">Retrieves the pointer to the default display.</doc>
      <source-position filename="clutter/clutter/x11/clutter-x11.h" line="97"/>
      <return-value transfer-ownership="none">
        <doc xml:space="preserve"
             filename="clutter/clutter/x11/clutter-backend-x11.c"
             line="692">the default display</doc>
        <type name="xlib.Display" c:type="Display*"/>
      </return-value>
    </function>
    <function name="get_default_screen"
              c:identifier="clutter_x11_get_default_screen"
              version="0.6">
      <doc xml:space="preserve"
           filename="clutter/clutter/x11/clutter-backend-x11.c"
           line="744">Gets the number of the default X Screen object.</doc>
      <source-position filename="clutter/clutter/x11/clutter-x11.h" line="99"/>
      <return-value transfer-ownership="none">
        <doc xml:space="preserve"
             filename="clutter/clutter/x11/clutter-backend-x11.c"
             line="749">the number of the default screen</doc>
        <type name="gint" c:type="int"/>
      </return-value>
    </function>
    <function name="get_root_window"
              c:identifier="clutter_x11_get_root_window"
              version="0.6"
              introspectable="0">
      <doc xml:space="preserve"
           filename="clutter/clutter/x11/clutter-backend-x11.c"
           line="773">Retrieves the root window.</doc>
      <source-position filename="clutter/clutter/x11/clutter-x11.h"
                       line="101"/>
      <return-value transfer-ownership="none">
        <doc xml:space="preserve"
             filename="clutter/clutter/x11/clutter-backend-x11.c"
             line="778">the id of the root window</doc>
        <type name="xlib.Window" c:type="Window"/>
      </return-value>
    </function>
    <function name="get_use_stereo_stage"
              c:identifier="clutter_x11_get_use_stereo_stage"
              version="1.22">
      <doc xml:space="preserve"
           filename="clutter/clutter/x11/clutter-backend-x11.c"
           line="938">Retrieves whether the Clutter X11 backend will create stereo
stages if possible.</doc>
      <source-position filename="clutter/clutter/x11/clutter-x11.h"
                       line="115"/>
      <return-value transfer-ownership="none">
        <doc xml:space="preserve"
             filename="clutter/clutter/x11/clutter-backend-x11.c"
             line="944">%TRUE if stereo stages are used if possible</doc>
        <type name="gboolean" c:type="gboolean"/>
      </return-value>
    </function>
    <function name="remove_filter"
              c:identifier="clutter_x11_remove_filter"
              version="0.6"
              introspectable="0">
      <doc xml:space="preserve"
           filename="clutter/clutter/x11/clutter-backend-x11.c"
           line="845">Removes the given filter function.</doc>
      <source-position filename="clutter/clutter/x11/clutter-x11.h"
                       line="109"/>
      <return-value transfer-ownership="none">
        <type name="none" c:type="void"/>
      </return-value>
      <parameters>
        <parameter name="func" transfer-ownership="none" closure="1">
          <doc xml:space="preserve"
               filename="clutter/clutter/x11/clutter-backend-x11.c"
               line="847">a filter function</doc>
          <type name="FilterFunc" c:type="ClutterX11FilterFunc"/>
        </parameter>
        <parameter name="data"
                   transfer-ownership="none"
                   nullable="1"
                   allow-none="1">
          <doc xml:space="preserve"
               filename="clutter/clutter/x11/clutter-backend-x11.c"
               line="848">user data to be passed to the filter function, or %NULL</doc>
          <type name="gpointer" c:type="gpointer"/>
        </parameter>
      </parameters>
    </function>
    <function name="set_display"
              c:identifier="clutter_x11_set_display"
              version="0.8">
      <doc xml:space="preserve"
           filename="clutter/clutter/x11/clutter-backend-x11.c"
           line="716">Sets the display connection Clutter should use; must be called
before clutter_init(), clutter_init_with_args() or other functions
pertaining Clutter's initialization process.

If you are parsing the command line arguments by retrieving Clutter's
#GOptionGroup with clutter_get_option_group() and calling
g_option_context_parse() yourself, you should also call
clutter_x11_set_display() before g_option_context_parse().</doc>
      <source-position filename="clutter/clutter/x11/clutter-x11.h"
                       line="103"/>
      <return-value transfer-ownership="none">
        <type name="none" c:type="void"/>
      </return-value>
      <parameters>
        <parameter name="xdpy" transfer-ownership="none">
          <doc xml:space="preserve"
               filename="clutter/clutter/x11/clutter-backend-x11.c"
               line="718">pointer to a X display connection.</doc>
          <type name="xlib.Display" c:type="Display*"/>
        </parameter>
      </parameters>
    </function>
    <function name="set_use_stereo_stage"
              c:identifier="clutter_x11_set_use_stereo_stage"
              version="1.22">
      <doc xml:space="preserve"
           filename="clutter/clutter/x11/clutter-backend-x11.c"
           line="900">Sets whether the backend object for Clutter stages, will,
if possible, be created with the ability to support stereo drawing
(drawing separate images for the left and right eyes).

This function must be called before clutter_init() is called.
During paint callbacks, cogl_framebuffer_is_stereo() can be called
on the framebuffer retrieved by cogl_get_draw_framebuffer() to
determine if stereo support was successfully enabled, and
cogl_framebuffer_set_stereo_mode() to determine which buffers
will be drawn to.

Note that this function *does not* cause the stage to be drawn
multiple times with different perspective transformations and thus
appear in 3D, it simply enables individual ClutterActors to paint
different images for the left and and right eye.</doc>
      <source-position filename="clutter/clutter/x11/clutter-x11.h"
                       line="113"/>
      <return-value transfer-ownership="none">
        <type name="none" c:type="void"/>
      </return-value>
      <parameters>
        <parameter name="use_stereo" transfer-ownership="none">
          <doc xml:space="preserve"
               filename="clutter/clutter/x11/clutter-backend-x11.c"
               line="902">%TRUE if the stereo stages should be used if possible.</doc>
          <type name="gboolean" c:type="gboolean"/>
        </parameter>
      </parameters>
    </function>
    <function name="trap_x_errors"
              c:identifier="clutter_x11_trap_x_errors"
              version="0.6">
      <doc xml:space="preserve"
           filename="clutter/clutter/x11/clutter-backend-x11.c"
           line="656">Traps every X error until clutter_x11_untrap_x_errors() is called.</doc>
      <source-position filename="clutter/clutter/x11/clutter-x11.h" line="92"/>
      <return-value transfer-ownership="none">
        <type name="none" c:type="void"/>
      </return-value>
    </function>
    <function name="untrap_x_errors"
              c:identifier="clutter_x11_untrap_x_errors"
              version="0.4">
      <doc xml:space="preserve"
           filename="clutter/clutter/x11/clutter-backend-x11.c"
           line="670">Removes the X error trap and returns the current status.</doc>
      <source-position filename="clutter/clutter/x11/clutter-x11.h" line="94"/>
      <return-value transfer-ownership="none">
        <doc xml:space="preserve"
             filename="clutter/clutter/x11/clutter-backend-x11.c"
             line="675">the trapped error code, or 0 for success</doc>
        <type name="gint" c:type="gint"/>
      </return-value>
    </function>
  </namespace>
</repository>