Clutter

---

Description:

Content:

Namespaces:

• FrameSource
• Key
• Threads
• FrameSource
• Idle
• Timeout
• Util
• Value

Interfaces:

• Animatable - Animatable is an opaque structure whose members cannot be directly accessed
• Container - Container is an opaque structure whose members cannot be directly accessed
• Content - The Content structure is an opaque type whose members cannot be acccessed directly.
• Media - Media is an opaque structure whose members cannot be directly accessed
• Scriptable - Scriptable is an opaque structure whose members cannot be directly accessed
• StageWindow

Classes:

• Action - The Action structure contains only private data and should be accessed using the provided API.
• Actor - Base class for actors.
• ActorMeta - The ActorMeta structure contains only private data and should be accessed using the provided API
• AlignConstraint - AlignConstraint is an opaque structure whose members cannot be directly accesses
• Alpha - Alpha combines a Timeline and a function.
• Animation - The Animation structure contains only private data and should be accessed using the provided functions.
• Animator - The Animator structure contains only private data and should be accessed using the provided API
• AnimatorKey - A key frame inside a Animator
• AnyEvent - Common members for a Event
• Backend - Backend is an opaque structure whose members cannot be directly accessed.
• Behaviour - Behaviour-struct contains only private data and should be accessed with the functions below.
• BehaviourDepth - The BehaviourDepth structure contains only private data and should be accessed using the provided API
• BehaviourEllipse - The BehaviourEllipse struct contains only private data and should be accessed using the provided API
• BehaviourOpacity - The BehaviourOpacity structure contains only private data and should be accessed using the provided API
• BehaviourPath - The BehaviourPath structure contains only private data and should be accessed using the provided API
• BehaviourRotate - The BehaviourRotate struct contains only private data and should be accessed using the provided API
• BehaviourScale - The BehaviourScale struct contains only private data and should be accessed using the provided API
• BinLayout - The BinLayout structure contains only private data and should be accessed using the provided API
• BindConstraint - BindConstraint is an opaque structure whose members cannot be directly accessed
• BindingPool - Container of key bindings.
• BlurEffect - BlurEffect is an opaque structure whose members cannot be accessed directly
• Box - The Box structure contains only private data and should be accessed using the provided API
• BoxLayout - The BoxLayout structure contains only private data and should be accessed using the provided API
• BrightnessContrastEffect - BrightnessContrastEffect is an opaque structure whose members cannot be directly accessed
• ButtonEvent - Button event.
• CairoTexture - The CairoTexture struct contains only private data.
• Canvas - The Canvas structure contains private data and should only be accessed using the provided API.
• ChildMeta - Base interface for container specific state for child actors.
• ClickAction - The ClickAction structure contains only private data and should be accessed using the provided API
• ClipNode - The TextNode structure is an opaque type whose members cannot be directly accessed.
• Clone - The Clone structure contains only private data and should be accessed using the provided API
• ColorNode - The TextNode structure is an opaque type whose members cannot be directly accessed.
• ColorizeEffect - ColorizeEffect is an opaque structure whose members cannot be directly accessed
• Constraint - The Constraint structure contains only private data and should be accessed using the provided API
• CrossingEvent - Event for the movement of the pointer across different actors
• DeformEffect - The DeformEffect structure contains only private data and should be accessed using the provided API
• DesaturateEffect - DesaturateEffect is an opaque structure whose members cannot be directly accessed
• DeviceManager - The DeviceManager structure contains only private data
• DragAction - The DragAction structure contains only private data and should be accessed using the provided API
• DropAction - The DropAction structure contains only private data and should be accessed using the provided API.
• Effect - The Effect structure contains only private data and should be accessed using the provided API
• Event - Generic event wrapper.
• EventSequence - The EventSequence structure is an opaque type used to denote the event sequence of a touch event.
• FixedLayout - The FixedLayout structure contains only private data and it should be accessed using the provided API
• FlowLayout - The FlowLayout structure contains only private data and should be accessed using the provided API
• GestureAction - The GestureAction structure contains only private data and should be accessed using the provided API
• GridLayout - The GridLayout structure contains only private data and should be accessed using the provided API
• Group - The Group structure contains only private data and should be accessed using the provided API
• Image - The Image structure contains private data and should only be accessed using the provided API.
• InputDevice - Generic representation of an input device.
• Interval - The Interval structure contains only private data and should be accessed using the provided functions.
• KeyEvent - Key event
• KeyframeTransition - The `ClutterKeyframeTransition` structure contains only private data and should be accessed using the provided API.
• LayoutManager - The LayoutManager structure contains only private data and should be accessed using the provided API
• LayoutMeta - Sub-class of ChildMeta specific for layout managers
• ListModel - The ListModel struct contains only private data.
• Model - Base class for list models.
• ModelIter - Base class for list models iters.
• MotionEvent - Event for the pointer motion
• OffscreenEffect - The OffscreenEffect structure contains only private data and should be accessed using the provided API
• PageTurnEffect - PageTurnEffect is an opaque structure whose members can only be accessed using the provided API
• PaintNode - The `ClutterPaintNode` structure contains only private data and it should be accessed using the provided API.
• PanAction - The PanAction structure contains only private data and should be accessed using the provided API
• ParamSpecUnit
• Path - The Path struct contains only private data and should be accessed with the functions below.
• PathConstraint - PathConstraint is an opaque structure whose members cannot be directly accessed
• PipelineNode - The TextNode structure is an opaque type whose members cannot be directly accessed.
• PropertyTransition - The PropertyTransition structure contains private data and should only be accessed using the provided API.
• Rectangle - The Rectangle structure contains only private data and should be accessed using the provided API
• RotateAction - The RotateAction structure contains only private data and should be accessed using the provided API
• Score - The Score structure contains only private data and should be accessed using the provided API
• Script - The Script structure contains only private data and should be accessed using the provided API
• ScrollActor - The ScrollActor structure contains only private data, and should be accessed using the provided API.
• ScrollEvent - Scroll wheel (or similar device) event
• Settings - `ClutterSettings` is an opaque structure whose members cannot be directly accessed.
• Shader - The Shader structure contains only private data and should be accessed using the provided API
• ShaderEffect - The ShaderEffect structure contains only private data and should be accessed using the provided API
• ShaderFloat
• ShaderInt
• ShaderMatrix
• SnapConstraint - SnapConstraint is an opaque structure whose members cannot be directly accesses
• Stage - The Stage structure contains only private data and should be accessed using the provided API
• StageManager - The StageManager structure is private.
• StageStateEvent - Event signalling a change in the Stage state.
• State - The State structure contains only private data and should be accessed using the provided API
• StateKey - StateKey is an opaque structure whose members cannot be accessed directly
• SwipeAction - The SwipeAction structure contains only private data and should be accessed using the provided API
• TableLayout - The TableLayout structure contains only private data and should be accessed using the provided API
• TapAction - The TapAction structure contains only private data and should be accessed using the provided API
• Text - The Text struct contains only private data.
• TextBuffer - The TextBuffer structure contains private data and it should only be accessed using the provided API.
• TextNode - The TextNode structure is an opaque type whose members cannot be directly accessed.
• Texture - The Texture structure contains only private data and should be accessed using the provided API
• TextureNode - The TextNode structure is an opaque type whose members cannot be directly accessed.
• Timeline - The Timeline structure contains only private data and should be accessed using the provided API
• TimeoutPool - TimeoutPool is an opaque structure whose members cannot be directly accessed.
• TouchEvent - Used for touch events.
• TouchpadPinchEvent - Used for touchpad pinch gesture events.
• TouchpadSwipeEvent - Used for touchpad swipe gesture events.
• Transition - The Transition structure contains private data and should only be accessed using the provided API.
• TransitionGroup - The TransitionGroup structure contains private data and should only be accessed using the provided API.
• ZoomAction - The ZoomAction structure contains only private data and should be accessed using the provided API

Structs:

• ActorBox - Bounding box of an actor.
• ActorIter - An iterator structure that allows to efficiently iterate over a section of the scene graph.
• Color - Color representation.
• Fog - Fog settings used to create the depth cueing effect.
• Geometry - The rectangle containing an actor's bounding box, measured in pixels.
• Knot - Point in a path behaviour.
• Margin - A representation of the components of a margin.
• Matrix - A type representing a 4x4 matrix.
• PaintVolume - PaintVolume is an opaque structure whose members cannot be directly accessed.
• PathNode - Represents a single node of a Path.
• Perspective - Stage perspective definition.
• Point - A point in 2D space.
• Rect - The location and size of a rectangle.
• Size - A size, in 2D space.
• Units - An opaque structure, to be used to store sizing and positioning values along with their unit.
• Vertex - A point in 3D space, expressed in pixels

Enums:

• ActorAlign - Controls how a Actor should align itself inside the extra space assigned to it during the allocation.
• ActorFlags - Flags used to signal the state of an actor.
• AlignAxis - Specifies the axis on which AlignConstraint should maintain the alignment.
• AllocationFlags - Flags passed to the allocate virtual function and to the allocate function.
• AnimationMode - The animation modes used by Alpha and Animation .
• BinAlignment - The alignment policies available on each axis for BinLayout
• BindCoordinate - Specifies which property should be used in a binding
• BoxAlignment - The alignment policies available on each axis of the BoxLayout
• ContentGravity - Controls the alignment of the Content inside a Actor.
• ContentRepeat - Content repeat modes.
• DragAxis - The axis of the constraint that should be applied on the dragging action
• EffectPaintFlags - Flags passed to the ‘paint’ or ‘pick’ method of Effect.
• EventFlags - Flags for the Event
• EventType - Types of events.
• FeatureFlags - Runtime flags indicating specific features available via Clutter window system and graphics backend.
• FlowOrientation - The direction of the arrangement of the children inside a FlowLayout
• FontFlags - Runtime flags to change the font quality.
• GestureTriggerEdge - Enum passed to the set_threshold_trigger_edge function.
• Gravity - Gravity of the scaling operations.
• GridPosition - Grid position modes.
• InitError - Error conditions returned by init and init_with_args.
• InputAxis - The type of axes Clutter recognizes on a InputDevice
• InputDeviceType - The types of input devices available.
• InputMode - The mode for input devices available.
• Interpolation - The mode of interpolation between key frames
• LongPressState - The states for the long_press signal.
• ModifierType - Masks applied to a Event by modifiers.
• OffscreenRedirect - Possible flags to pass to set_offscreen_redirect.
• Orientation - Represents the orientation of actors or layout managers.
• PanAxis - The axis of the constraint that should be applied on the panning action
• PathNodeType - Types of nodes in a Path.
• PickMode - Controls the paint cycle of the scene graph when in pick mode
• RepaintFlags - Flags to pass to add_repaint_func_full.
• RequestMode - Specifies the type of requests for a Actor.
• RotateAxis - Axis of a rotation.
• RotateDirection - Direction of a rotation.
• ScalingFilter - The scaling filters to be used with the minification_filter and magnification_filter properties.
• ScrollDirection - Direction of a pointer scroll event.
• ScrollFinishFlags - Flags used to notify the axes that were stopped in a ScrollEvent.
• ScrollMode - Scroll modes.
• ScrollSource - The scroll source determines the source of the scroll event.
• ShaderType - The type of GLSL shader program
• SnapEdge - The edge to snap
• StageState - Stage state masks, used by the Event of type STAGE_STATE.
• StaticColor - Named colors, for accessing global colors defined by Clutter
• StepMode - Change the value transition of a step function.
• SwipeDirection - The main direction of the swipe gesture
• TableAlignment - The alignment policies available on each axis of the TableLayout
• TextDirection - The text direction to be used by Actors
• TextureFlags - Flags for set_from_rgb_data and set_from_yuv_data.
• TextureQuality - Enumaration controlling the texture quality.
• TimelineDirection - The direction of a Timeline
• TouchpadGesturePhase - The phase of a touchpad gesture event.
• UnitType - The type of unit in which a value is expressed
• ZoomAxis - The axis of the constraint that should be applied by the zooming action.

Error domains:

• ImageError - Error enumeration for Image.
• ScriptError - Script error enumeration.
• ShaderError - Shader error enumeration
• TextureError - Error enumeration for Texture

Constants:

• public const string COGL
  Cogl (internal GL abstraction utility library) backend.
• public const int CURRENT_TIME
  Default value for "now".
• public const string FLAVOUR
  GL Windowing system used
• public const int MAJOR_VERSION
  The major version of the Clutter library (1, if VERSION is 1.2.3)
• public const int MICRO_VERSION
  The micro version of the Clutter library (3, if VERSION is 1.2.3)
• public const int MINOR_VERSION
  The minor version of the Clutter library (2, if VERSION is 1.2.3)
• public const int PATH_RELATIVE
• public const int PRIORITY_REDRAW
  Priority of the redraws.
• public const double VERSION
  The full version of the Clutter library, like 1.2.3
• public const int VERSION_HEX
  Numerically encoded version of the Clutter library, like 0x010203
• public const string VERSION_S
  The full version of the Clutter library, in string form (suited for string concatenation)

Delegates:

• public delegate Actor ActorCreateChildFunc (Object item)
  Creates a Actor using the item in the model.
• public delegate double AlphaFunc (Alpha alpha)
  A function returning a value depending on the position of the Timeline bound to alpha.
• public delegate void BehaviourForeachFunc (Behaviour behaviour, Actor actor)
  This function is passed to actors_foreach and will be called for each actor driven by behaviour.
• public delegate bool BindingActionFunc (Object gobject, string action_name, uint key_val, ModifierType modifiers)
  The prototype for the callback function registered with install_action and invoked by activate.
• public delegate void Callback (Actor actor)
  Generic callback
• public delegate bool EventFilterFunc (Event event)
  A function pointer type used by event filters that are added with event_add_filter.
• public delegate bool ModelFilterFunc (Model model, ModelIter iter)
  Filters the content of a row in the model.
• public delegate bool ModelForeachFunc (Model model, ModelIter iter)
  Iterates on the content of a row in the model
• public delegate int ModelSortFunc (Model model, Value a, Value b)
  Compares the content of two rows in the model.
• public delegate void PathCallback (PathNode node)
  This function is passed to @foreach and will be called for each node contained in the path.
• public delegate bool ProgressFunc (Value a, Value b, double progress, Value retval)
  Prototype of the progress function used to compute the value between the two ends a and b of an interval depending on the value of progress.
• public delegate void ScriptConnectFunc (Script script, Object object, string signal_name, string handler_name, Object connect_object, ConnectFlags flags)
  This is the signature of a function used to connect signals.
• public delegate double TimelineProgressFunc (Timeline timeline, double elapsed, double total)
  A function for defining a custom progress.

Functions:

• public ActorBox? actor_box_alloc ()
• public void base_init ()
• public void cairo_clear (Context cr)
  Utility function to clear a Cairo context.
• public void cairo_set_source_color (Context cr, Color color)
  Utility function for setting the source color of cr using a Color.
• public bool check_version (uint major, uint minor, uint micro)
  Run-time version check, to check the version the Clutter library that an application is currently linked against
• public bool check_windowing_backend (string backend_type)
  Checks the run-time name of the Clutter windowing system backend, using the symbolic macros like CLUTTER_WINDOWING_WIN32 or CLUTTER_WINDOWING_X11.
• public void clear_glyph_cache ()
  Clears the internal cache of glyphs used by the Pango renderer.
• public unowned Color? color_get_static (StaticColor color)
• public void disable_accessibility ()
  Disable loading the accessibility support.
• public void do_event (Event event)
  Processes an event.
• public uint event_add_filter (Stage? stage, owned EventFilterFunc func)
  Adds a function which will be called for all events that Clutter processes.
• public Event event_get ()
  Pops an event off the event queue.
• public unowned Event event_peek ()
  Returns a pointer to the first event from the event queue but does not remove it.
• public void event_remove_filter (uint id)
  Removes an event filter that was previously added with event_add_filter.
• public bool events_pending ()
  Checks if events are pending in the event queue.
• public bool get_accessibility_enabled ()
  Returns whether Clutter has accessibility support enabled.
• public unowned Event get_current_event ()
  If an event is currently being processed, return that event.
• public uint32 get_current_event_time ()
  Retrieves the timestamp of the last event, if there is an event or if the event has a timestamp.
• public bool get_debug_enabled ()
  Check if Clutter has debugging enabled.
• public unowned Backend get_default_backend ()
  Retrieves the default Backend used by Clutter.
• public uint get_default_frame_rate ()
  Retrieves the default frame rate.
• public TextDirection get_default_text_direction ()
  Retrieves the default direction for the text.
• public FontFlags get_font_flags ()
  Gets the current font flags for rendering text.
• public unowned FontMap get_font_map ()
  Retrieves the FontMap instance used by Clutter.
• public unowned Actor get_keyboard_grab ()
  Queries the current keyboard grab of clutter.
• public bool get_motion_events_enabled ()
  Gets whether the per-actor motion events are enabled.
• public OptionGroup get_option_group ()
  Returns a OptionGroup for the command line arguments recognized by Clutter.
• public OptionGroup get_option_group_without_init ()
  Returns a OptionGroup for the command line arguments recognized by Clutter.
• public unowned Actor get_pointer_grab ()
  Queries the current pointer grab of clutter.
• public unowned string get_script_id (Object gobject)
  Retrieves the Clutter script id, if any.
• public bool get_show_fps ()
  Returns whether Clutter should print out the frames per second on the console.
• public ulong get_timestamp ()
  Returns the approximate number of microseconds passed since Clutter was intialised.
• public void grab_keyboard (Actor actor)
  Grabs keyboard events, after the grab is done keyboard events (#ClutterActor::key-press-event and key_release_event) are delivered to this actor directly.
• public void grab_pointer (Actor actor)
  Grabs pointer events, after the grab is done all pointer related events (press, motion, release, enter, leave and scroll) are delivered to this actor directly without passing through both capture and bubble phases of the event delivery chain.
• public void grab_pointer_for_device (Actor actor, int id_)
  Grabs all the pointer events coming from the device id for actor.
• public Quark image_error_quark ()
• public InitError init (ref unowned string[]? argv)
  Initialises everything needed to operate with Clutter and parses some standard command line options; argv.length and argv are adjusted accordingly so your own code will never see those standard arguments.
• public Quark init_error_quark ()
• public InitError init_with_args (ref unowned string[]? argv, string? parameter_string, OptionEntry[]? entries, string? translation_domain) throws Error
  This function does the same work as init.
• public uint32 keysym_to_unicode (uint keyval)
  Converts keyval from a Clutter key symbol to the corresponding ISO10646 (Unicode) character.
• public void main ()
  Starts the Clutter mainloop.
• public int main_level ()
  Retrieves the depth of the Clutter mainloop.
• public void main_quit ()
  Terminates the Clutter mainloop.
• public Matrix? matrix_alloc ()
• public unowned Point? point_zero ()
• public unowned Rect? rect_zero ()
• public Quark script_error_quark ()
• public void set_default_frame_rate (uint frames_per_sec)
  Sets the default frame rate.
• public void set_font_flags (FontFlags flags)
  Sets the font quality options for subsequent text rendering operations.
• public void set_motion_events_enabled (bool enable)
  Sets whether per-actor motion events should be enabled or not on all Stages managed by Clutter.
• public void set_windowing_backend (string backend_type)
  Restricts Clutter to only use the specified backend or list of backends.
• public Quark shader_error_quark ()
• public void test_add_data_full (string test_path, owned TestDataFunc test_func)
  Adds a test unit to the Clutter test environment.
• public bool test_check_actor_at_point (Actor stage, Point point, Actor actor, out Actor? result)
  Checks the given coordinates of the stage and compares the actor found there with the given actor.
• public bool test_check_color_at_point (Actor stage, Point point, Color color, out Color result)
  Checks the color at the given coordinates on stage, and matches it with the red, green, and blue channels of color.
• public unowned Actor test_get_stage ()
  Retrieves the Stage used for testing.
• public void test_init (int argc, string argv)
• public int test_run ()
  Runs the test suite using the units added by calling clutter_test_add .
• public Quark texture_error_quark ()
• public void ungrab_keyboard ()
  Removes an existing grab of the keyboard.
• public void ungrab_pointer ()
  Removes an existing grab of the pointer.
• public void ungrab_pointer_for_device (int id_)
  Removes an existing grab of the pointer events for device id_.
• public uint unicode_to_keysym (uint32 wc)
  Convert from a ISO10646 character to a key symbol.