clutter-1.0

---

Description:

Content:

Namespaces:

• Clutter

Interfaces:

• Animatable - Base interface for Objects that can be animated by a a Animation.
• Container - Base interface for container actors. The add , remove and foreach virtual functions must be provided by any implementation; the other virtual functions are optional.
• Media - Interface vtable for Media implementations
• Scriptable - Interface for implementing "scriptable" objects. An object implementing this interface can override the parsing and properties setting sequence when loading a UI definition data with Script
• StageWindow - The interface implemented by backends for stage windows

Classes:

• Action - The Action structure contains only private data
• Actor - Base class for actors.
• ActorMeta - The ActorMeta structure contains only private data
• AlignConstraint - AlignConstraint is an opaque structure whose members cannot be directly accesses
• Alpha - Base class for Alpha
• Animation - The Animation structure contains only private data and should be accessed using the provided functions.
• Animator - The Animator structure contains only private data
• AnimatorKey - A key frame inside a Animator
• Backend - Backend is an opaque structure whose members cannot be directly accessed.
• Behaviour - Base class for behaviours.
• BehaviourDepth - The BehaviourDepth structure contains only private data
• BehaviourEllipse - The BehaviourEllipse struct contains only private data
• BehaviourOpacity - The BehaviourOpacity structure contains only private data
• BehaviourPath - The BehaviourPath struct contains only private data
• BehaviourRotate - The BehaviourRotate struct contains only private data
• BehaviourScale - The BehaviourScale struct contains only private data
• 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. The BindingPool struct is private.
• BlurEffect - BlurEffect is an opaque structure whose members cannot be accessed directly
• Box - The Box structure contains only private data
• BoxLayout - The BoxLayout structure contains only private data and should be accessed using the provided API
• CairoTexture - The CairoTexture struct contains only private data.
• ChildMeta - The ChildMeta contains only private data
• ClickAction - The ClickAction structure contains only private data
• Clone - The Clone structure contains only private data
• ColorizeEffect - ColorizeEffect is an opaque structure whose members cannot be directly accessed
• Constraint - The Constraint structure contains only private data
• DeformEffect - The DeformEffect structure contains only private data
• 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
• DropAction - The DropAction structure contains only private data.
• Effect - The Effect structure contains only private data
• Event - Generic event wrapper.
• 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 ClutterGestureClass structure contains only private data.
• Group - The Group structure contains only private data
• InputDevice - Generic representation of an input device. The actual contents of this structure depend on the backend used.
• Interval - The Interval contains only private data.
• LayoutManager - The LayoutManager structure contains only private data and should be accessed using the provided API
• LayoutMeta - The LayoutMeta contains only private data and should never be accessed directly
• ListModel - The ListModel struct contains only private data.
• Model - Class for Model instances.
• ModelIter - Class for ModelIter instances.
• OffscreenEffect - The OffscreenEffect structure contains only private data
• PageTurnEffect - PageTurnEffect is an opaque structure whose members can only be accessed using the provided API
• PaintVolume - PaintVolume is an opaque structure whose members cannot be directly accessed.
• ParamSpecUnit -
• Path - The Path struct contains only private data.
• PathConstraint - PathConstraint is an opaque structure whose members cannot be directly accessed
• Rectangle - The Rectangle structure contains only private data
• Score - The Score structure contains only private data
• Script - The Script structure contains only private data
• Settings - Settings is an opaque structure whose members cannot be directly accessed.
• Shader - The Shader structure contains only private data
• ShaderEffect - The ShaderEffect structure contains only private data
• ShaderFloat -
• ShaderInt -
• ShaderMatrix -
• SnapConstraint - SnapConstraint is an opaque structure whose members cannot be directly accesses
• Stage - The Stage structure contains only private data
• StageManager - The StageManager structure contains only private data and should be accessed using the provided API
• State - The State structure contains only private data
• StateKey - StateKey is an opaque structure whose members cannot be accessed directly
• SwipeAction - The SwipeAction structure contains only private data.
• TableLayout - The TableLayout structure contains only private data and should be accessed using the provided API
• Text - The Text struct contains only private data.
• Texture - The Texture structure contains only private data
• Timeline - The Timeline structure contains only private data
• TimeoutPool - TimeoutPool is an opaque structure whose members cannot be directly accessed.

Structs:

• ActorBox - Bounding box of an actor. The coordinates of the top left and right bottom corners of an actor. The coordinates of the two points are expressed in pixels with sub-pixel precision
• AnyEvent - Common members for a Event
• ButtonEvent - Button event.
• Color - Color representation.
• CrossingEvent - Event for the movement of the pointer across different actors
• Fog - Fog settings used to create the depth cueing effect.
• Geometry - The rectangle containing an actor's bounding box, measured in pixels.
• KeyEvent - Key event
• Knot - Point in a path behaviour.
• MotionEvent - Event for the pointer motion
• PathNode - Represents a single node of a Path.
• Perspective - Stage perspective definition. Perspective is only used by the fixed point version of set_perspective.
• ScrollEvent - Scroll wheel (or similar device) event
• StageStateEvent - Event signalling a change in the Stage state.
• Units - An opaque structure, to be used to store sizing and positioning values along with their unit.
• Vertex - Vertex of an actor in 3D space, expressed in pixels

Enums:

• 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 ClutterActor::allocate() virtual function and to the allocate function
• AnimationMode - The animation modes used by Alpha and Animation. This enumeration can be expanded in later versions of Clutter. See the Alpha documentation for a graph of all the animation modes.
• 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
• 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 sysytem and graphics backend.
• FlowOrientation - The direction of the arrangement of the children inside a FlowLayout
• FontFlags - Runtime flags to change the font quality. To be used with set_font_flags.
• Gravity - Gravity of the scaling operations. When a gravity different than NONE is used, an actor is scaled keeping the position of the specified portion at the same coordinates.
• 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 ClutterClikAction::long-press signal.
• ModifierType - Masks applied to a Event by modifiers.
• OffscreenRedirect - Possible flags to pass to set_offscreen_redirect.
• PathNodeType - Types of nodes in a Path.
• PickMode - Controls the paint cycle of the scene graph when in pick mode
• RequestMode - Specifies the type of requests for a Actor.
• RotateAxis - Axis of a rotation.
• RotateDirection - Direction of a rotation.
• ScrollDirection - Direction of a pointer scroll event.
• ShaderType - The type of GLSL shader program
• SnapEdge - The edge to snap
• StageState - Stage state masks
• StaticColor - Named colors, for accessing global colors defined by Clutter
• 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
• UnitType - The type of unit in which a value is expressed
• X11FilterReturn -
• X11XInputEventTypes -

Error domains:

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

Constants:

• public const unowned string COGL
• public const int CURRENT_TIME
• public const unowned string FLAVOUR
• public const int MAJOR_VERSION
• public const int MICRO_VERSION
• public const int MINOR_VERSION
• public const int PATH_RELATIVE
• public const int PRIORITY_REDRAW
• public const double VERSION
• public const int VERSION_HEX
• public const unowned string VERSION_S

Delegates:

• public delegate double AlphaFunc (Alpha alpha)
• public delegate void BehaviourForeachFunc (Behaviour behaviour, Actor actor)
• public delegate bool BindingActionFunc (Object gobject, string action_name, uint key_val, ModifierType modifiers)
• public delegate void Callback (Actor actor)
• public delegate bool ModelFilterFunc (Model model, ModelIter iter)
• public delegate bool ModelForeachFunc (Model model, ModelIter iter)
• public delegate int ModelSortFunc (Model model, Value a, Value b)
• public delegate void PathCallback (PathNode node)
• public delegate bool ProgressFunc (Value a, Value b, double progress, Value retval)
• public delegate void ScriptConnectFunc (Script script, Object object, string signal_name, string handler_name, Object connect_object, ConnectFlags flags)

Methods:

• public void base_init ()
• public void cairo_set_source_color (Context cr, Color color)
  Utility function for setting the source color of cr using a Color. This function is the equivalent of:
• 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 void clear_glyph_cache ()
  Clears the internal cache of glyphs used by the Pango renderer. This will free up some memory and GL texture resources. The cache will be automatically refilled as more text is drawn.
• public void do_event (Event event)
  Processes an event.
• 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. As least, a value of TRUE means that there are a proper AtkUtil implementation available
• public unowned Event get_current_event ()
  If an event is currently being processed, return that event. This function is intended to be used to access event state that might not be exposed by higher-level widgets. For example, to get the key modifier state from a Button 'clicked' 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 turned on.
• public weak Backend get_default_backend ()
  Retrieves the default Backend used by Clutter. The Backend holds backend-specific configuration options.
• public uint get_default_frame_rate ()
  Retrieves the default frame rate. See set_default_frame_rate.
• public TextDirection get_default_text_direction ()
• public FontFlags get_font_flags ()
  Gets the current font flags for rendering text. See set_font_flags.
• public weak FontMap get_font_map ()
  Retrieves the FontMap instance used by Clutter. You can use the global font map object with the COGL Pango API.
• public weak 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. You should add this group to your OptionContext with add_group, if you are using parse to parse your commandline arguments.
• public OptionGroup get_option_group_without_init ()
  Returns a OptionGroup for the command line arguments recognized by Clutter. You should add this group to your OptionContext with add_group, if you are using parse to parse your commandline arguments.
• public weak 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. You can enable this setting either using the CLUTTER_SHOW_FPS environment variable or passing the --clutter-show-fps command line argument. *
• 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. The source set in the event will be the actor that would have received the event if the keyboard grab was not in effect.
• 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. The source set in the event will be the actor that would have received the event if the pointer grab was not in effect.
• public void grab_pointer_for_device (Actor actor, int id_)
  Grabs all the pointer events coming from the device id for actor.
• public InitError init (ref string[]? argv)
  Initialises everything needed to operate with Clutter and parses some standard command line options; argc and argv are adjusted accordingly so your own code will never see those standard arguments.
• public InitError init_with_args (ref string[]? argv, string? parameter_string, OptionEntry?[] entries, string? translation_domain) throws Error
  This function does the same work as init. Additionally, it allows you to add your own command line options, and it automatically generates nicely formatted --help output. Note that your program will be terminated after writing out the help output. Also note that, in case of error, the error message will be placed inside error instead of being printed on the display.
• 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 void set_default_frame_rate (uint frames_per_sec)
  Sets the default frame rate. This frame rate will be used to limit the number of frames drawn if Clutter is not able to synchronize with the vertical refresh rate of the display. When synchronization is possible, this value is ignored.
• 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 uint threads_add_repaint_func (SourceFunc func, void* data, DestroyNotify notify)
• public void threads_remove_repaint_func (uint handle_id)
• 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_.
• FrameSource

Methods:

• public uint add (uint fps, SourceFunc func)
  Simple wrapper around add_full.
• public uint add_full (int priority, uint fps, owned SourceFunc func)
  Sets a function to be called at regular intervals with the given priority. The function is called repeatedly until it returns false, at which point the timeout is automatically destroyed and the function will not be called again. The notify function is called when the timeout is destroyed. The first call to the function will be at the end of the first interval.
• Threads

Methods:

• public uint add_repaint_func (owned SourceFunc func)
  Adds a function to be called whenever Clutter is repainting a Stage. If the function returns false it is automatically removed from the list of repaint functions and will not be called again.
• public void enter ()
  Locks the Clutter thread lock.
• public void init ()
  Initialises the Clutter threading mechanism, so that Clutter API can be called by multiple threads, using enter and leave to mark the critical sections.
• public void leave ()
  Unlocks the Clutter thread lock.
• public void remove_repaint_func (uint handle_id)
  Removes the repaint function with handle_id as its id
• public void set_lock_functions (Callback enter_fn, Callback leave_fn)
  Allows the application to replace the standard method that Clutter uses to protect its data structures. Normally, Clutter creates a single Mutex that is locked by enter, and released by leave; using this function an application provides, instead, a function enter_fn that is called by enter and a function leave_fn that is called by leave.
• FrameSource

Methods:

• public uint add (uint fps, SourceFunc func)
  Simple wrapper around add_full.
• public uint add_full (int priority, uint fps, owned SourceFunc func)
  Sets a function to be called at regular intervals holding the Clutter threads lock, with the given priority. The function is called repeatedly until it returns false, at which point the timeout is automatically removed and the function will not be called again. The notify function is called when the timeout is removed.
• Idle

Methods:

• public uint add (SourceFunc func)
  Simple wrapper around add_full using the default priority.
• public uint add_full (int priority, owned SourceFunc func)
  Adds a function to be called whenever there are no higher priority events pending. If the function returns false it is automatically removed from the list of event sources and will not be called again.
• Timeout

Methods:

• public uint add (uint interval, SourceFunc func)
  Simple wrapper around add_full.
• public uint add_full (int priority, uint interval, owned SourceFunc func)
  Sets a function to be called at regular intervals holding the Clutter threads lock, with the given priority. The function is called repeatedly until it returns false, at which point the timeout is automatically removed and the function will not be called again. The notify function is called when the timeout is removed.
• Util

Methods:

• public int next_power_of_2 (int a)
  Calculates the nearest power of two, greater than or equal to a.
• Value

Methods:

• public unowned Color? get_color (Value value)
  Gets the Color contained in value.
• public unowned Fixed? get_fixed (Value value)
  Gets the fixed point value stored inside value.
• public weak float[] get_shader_float (Value value)
  Retrieves the list of floating point values stored inside the passed Value. value must have been initialized with CLUTTER_TYPE_SHADER_FLOAT.
• public weak int[] get_shader_int (Value value)
  Retrieves the list of integer values stored inside the passed Value. value must have been initialized with CLUTTER_TYPE_SHADER_INT.
• public weak float[] get_shader_matrix (Value value)
  Retrieves a matrix of floating point values stored inside the passed Value. value must have been initialized with CLUTTER_TYPE_SHADER_MATRIX.
• public Units get_units (Value value)
  Gets the Units contained in value.
• public void set_color (Value value, Color color)
  Sets value to color.
• public void set_fixed (Value value, Fixed fixed_)
  Sets value to fixed_.
• public void set_shader_float (Value value, float[] floats)
  Sets floats as the contents of value. The passed Value must have been initialized using CLUTTER_TYPE_SHADER_FLOAT .
• public void set_shader_int (Value value, int[] ints)
  Sets ints as the contents of value. The passed Value must have been initialized using CLUTTER_TYPE_SHADER_INT .
• public void set_shader_matrix (Value value, float[] matrix)
  Sets matrix as the contents of value. The passed Value must have been initialized using CLUTTER_TYPE_SHADER_MATRIX .
• public void set_units (Value value, Units units)
  Sets value to units