Gjsify LogoGjsify Logo

Index

Functions

  • disable_event_retrieval(): void
  • Disables the internal polling of X11 events in the main loop.

    Libraries or applications calling this function will be responsible of polling all X11 events.

    You also must call clutter_x11_handle_event() to let Clutter process events and maintain its internal state.

    This function can only be called before calling clutter_init().

    Even with event handling disabled, Clutter will still select all the events required to maintain its internal state on the stage Window; compositors using Clutter and input regions to pass events through to application windows should not rely on an empty input region, and should instead clear it themselves explicitly using the XFixes extension.

    This function should not be normally used by applications.

    Returns void

  • enable_xinput(): void
  • Enables the use of the XInput extension if present on connected XServer and support built into Clutter. XInput allows for multiple pointing devices to be used.

    This function must be called before clutter_init().

    Since XInput might not be supported by the X server, you might want to use clutter_x11_has_xinput() to see if support was enabled.

    Returns void

  • get_default_screen(): number
  • get_use_argb_visual(): boolean
  • get_use_stereo_stage(): boolean
  • This function processes a single X event; it can be used to hook into external X11 event processing (for example, a GDK filter function).

    If clutter_x11_disable_event_retrieval() has been called, you must let this function process events to update Clutter's internal state.

    Parameters

    Returns ClutterX11.FilterReturn

  • has_composite_extension(): boolean
  • has_event_retrieval(): boolean
  • has_xinput(): boolean
  • 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().

    Parameters

    Returns void

  • set_stage_foreign(stage: Clutter.Stage, xwindow: number): boolean
  • set_use_argb_visual(use_argb: boolean): void
  • Sets whether the Clutter X11 backend should request ARGB visuals by default or not.

    By default, Clutter requests RGB visuals.

    If no ARGB visuals are found, the X11 backend will fall back to requesting a RGB visual instead.

    ARGB visuals are required for the #ClutterStage:use-alpha property to work.

    This function can only be called once, and before clutter_init() is called.

    Parameters

    • use_argb: boolean

      %TRUE if ARGB visuals should be requested by default

    Returns void

  • set_use_stereo_stage(use_stereo: boolean): void
  • 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.

    Parameters

    • use_stereo: boolean

      %TRUE if the stereo stages should be used if possible.

    Returns void

  • trap_x_errors(): void
  • untrap_x_errors(): number

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method