cluttermm: Clutter Namespace Reference

Namespaces

 Cairo
 

Classes

class  Actor
 
class  ActorBox
 
class  ActorMeta
 Clutter::ActorMeta is an abstract class providing a common API for modifiers of Clutter::Actor activity, appearance or layout. More...

 
class  Action
 This is the base class for all actions. More...

 
class  AlignConstraint
 AlignConstraint is a Constraint that aligns the position of the Actor to which it is applied to the size of another Actor using an alignment factor. More...

 
class  Alpha
 
class  Animatable
 
class  Animation
 
class  Animator
 
class  Backend
 
class  Behaviour
 
class  BehaviourDepth
 
class  BehaviourEllipse
 
class  BehaviourOpacity
 
class  BehaviourPath
 
class  BehaviourRotate
 
class  BehaviourScale
 
class  BinLayout
 
class  BindConstraint
 BindConstraint is a Constraint that binds the position or the size of the Actor to which it is applied to the the position or the size of another Actor, or "source". More...

 
class  Box
 
class  BoxLayout
 
class  BlurEffect
 
class  BrightnessContrastEffect
 
class  Canvas
 
class  ChildMeta
 
class  Clone
 
class  Color
 
class  ColorizeEffect
 
class  Constraint
 Constraint is a base abstract class for modifiers of an Actor position or size. More...

 
class  Container
 
class  Content
 
class  DeformEffect
 
class  DeviceManager
 
class  DesaturateEffect
 
class  Effect
 
class  FixedLayout
 
class  FlowLayout
 
class  GridLayout
 
class  Group
 
class  Image
 
class  InputDevice
 
class  Interval
 
class  KeyFrameTransition
 
class  LayoutMeta
 
class  LayoutManager
 
class  Media
 
class  Model
 
class  ModelIter
 
class  OffscreenEffect
 
class  PageTurnEffect
 
class  PathNode
 
class  Path
 
class  PathConstraint
 PathConstraint is a simple constraint that modifies the allocation of the Actor to which it has been applied using a ClutterPath. More...

 
class  PropertyTransition
 
class  Rectangle
 
class  ScrollActor
 
class  Score
 
class  Script
 
class  Scriptable
 
class  Shader
 
class  ShaderEffect
 
class  Size
 A size in 2D space. More...

 
class  SnapConstraint
 SnapConstraint is a constraint the snaps the edges of two actors together, expanding the actor's allocation if necessary. More...

 
class  Perspective
 
class  Stage
 This is a top level 'window' on which child actors are placed and manipulated. More...

 
class  Text
 
class  TextBuffer
 
class  TextureError
 Exception class for Clutter::Texture errors. More...

 
class  Texture
 
class  Timeline
 
class  Transition
 Transition is an abstract subclass of Timeline that computes the interpolation between two values, stored by an Interval. More...

 
class  InitError
 
class  Vertex
 
class  Geometry
 
class  Point
 A Clutter::Point is a 2D point in space. More...

 
class  Rect
 
class  Knot
 

Typedefs

typedef ClutterMatrix Matrix
 
typedef ClutterPaintVolume PaintVolume
 
typedef ClutterFog Fog
 
typedef ClutterEvent Event
 
typedef ClutterButtonEvent ButtonEvent
 
typedef ClutterKeyEvent KeyEvent
 
typedef ClutterMotionEvent MotionEvent
 
typedef ClutterScrollEvent ScrollEvent
 
typedef ClutterCrossingEvent CrossingEvent
 

Enumerations

enum  ActorAlign {

  ACTOR_ALIGN_FILL,

  ACTOR_ALIGN_START,

  ACTOR_ALIGN_CENTER,

  ACTOR_ALIGN_END

}
 Controls how a Clutter::Actor should align itself inside the extra space assigned to it during the allocation. More...

 
enum  ActorFlags {

  ACTOR_MAPPED = 1 << 1,

  ACTOR_REALIZED = 1 << 2,

  ACTOR_REACTIVE = 1 << 3,

  ACTOR_VISIBLE = 1 << 4,

  ACTOR_NO_LAYOUT = 1 << 5

}
 Flags used to signal the state of an actor. More...

 
enum  AllocationFlags {

  ALLOCATION_NONE = 0x0,

  ABSOLUTE_ORIGIN_CHANGED = 1 << 1,

  DELEGATE_LAYOUT = 1 << 2

}
 Flags passed to the Clutter::ActorClass.allocate() virtual function and to the Clutter::Actor::allocate() function. More...

 
enum  ContentRepeat {

  REPEAT_NONE = 0x0,

  REPEAT_X_AXIS = 1 << 0,

  REPEAT_Y_AXIS = 1 << 1,

  REPEAT_BOTH = 0x3

}
 Content repeat modes. More...

 
enum  ContentGravity {

  CONTENT_GRAVITY_TOP_LEFT,

  CONTENT_GRAVITY_TOP,

  CONTENT_GRAVITY_TOP_RIGHT,

  CONTENT_GRAVITY_LEFT,

  CONTENT_GRAVITY_CENTER,

  CONTENT_GRAVITY_RIGHT,

  CONTENT_GRAVITY_BOTTOM_LEFT,

  CONTENT_GRAVITY_BOTTOM,

  CONTENT_GRAVITY_BOTTOM_RIGHT,

  CONTENT_GRAVITY_RESIZE_FILL,

  CONTENT_GRAVITY_RESIZE_ASPECT

}
 Controls the alignment of the Clutter::Content inside a Clutter::Actor. More...

 
enum  OffscreenRedirect {

  OFFSCREEN_REDIRECT_AUTOMATIC_FOR_OPACITY = 1<<0,

  OFFSCREEN_REDIRECT_ALWAYS = 1<<1

}
 Possible flags to pass to Clutter::Actor::set_offscreen_redirect(). More...

 
enum  Orientation {

  ORIENTATION_HORIZONTAL,

  ORIENTATION_VERTICAL

}
 Represents the orientation of actors or layout managers. More...

 
enum  AlignAxis {

  ALIGN_X_AXIS,

  ALIGN_Y_AXIS,

  ALIGN_BOTH

}
 Specifies the axis on which Clutter::AlignConstraint should maintain the alignment. More...

 
enum  Interpolation {

  INTERPOLATION_LINEAR,

  INTERPOLATION_CUBIC

}
 The mode of interpolation between key frames. More...

 
enum  BinAlignment {

  BIN_ALIGNMENT_FIXED,

  BIN_ALIGNMENT_FILL,

  BIN_ALIGNMENT_START,

  BIN_ALIGNMENT_END,

  BIN_ALIGNMENT_CENTER

}
 The alignment policies available on each axis for Clutter::BinLayout. More...

 
enum  BindCoordinate {

  BIND_X,

  BIND_Y,

  BIND_WIDTH,

  BIND_HEIGHT,

  BIND_POSITION,

  BIND_SIZE,

  BIND_ALL

}
 Specifies which property should be used in a binding. More...

 
enum  BoxAlignment {

  BOX_ALIGNMENT_START,

  BOX_ALIGNMENT_END,

  BOX_ALIGNMENT_CENTER

}
 The alignment policies available on each axis of the Clutter::BoxLayout. More...

 
enum  StaticColor {

  COLOR_WHITE,

  COLOR_BLACK,

  COLOR_RED,

  COLOR_DARK_RED,

  COLOR_GREEN,

  COLOR_DARK_GREEN,

  COLOR_BLUE,

  COLOR_DARK_BLUE,

  COLOR_CYAN,

  COLOR_DARK_CYAN,

  COLOR_MAGENTA,

  COLOR_DARK_MAGENTA,

  COLOR_YELLOW,

  COLOR_DARK_YELLOW,

  COLOR_GRAY,

  COLOR_DARK_GRAY,

  COLOR_LIGHT_GRAY,

  COLOR_BUTTER,

  COLOR_BUTTER_LIGHT,

  COLOR_BUTTER_DARK,

  COLOR_ORANGE,

  COLOR_ORANGE_LIGHT,

  COLOR_ORANGE_DARK,

  COLOR_CHOCOLATE,

  COLOR_CHOCOLATE_LIGHT,

  COLOR_CHOCOLATE_DARK,

  COLOR_CHAMELEON,

  COLOR_CHAMELEON_LIGHT,

  COLOR_CHAMELEON_DARK,

  COLOR_SKY_BLUE,

  COLOR_SKY_BLUE_LIGHT,

  COLOR_SKY_BLUE_DARK,

  COLOR_PLUM,

  COLOR_PLUM_LIGHT,

  COLOR_PLUM_DARK,

  COLOR_SCARLET_RED,

  COLOR_SCARLET_RED_LIGHT,

  COLOR_SCARLET_RED_DARK,

  COLOR_ALUMINIUM_1,

  COLOR_ALUMINIUM_2,

  COLOR_ALUMINIUM_3,

  COLOR_ALUMINIUM_4,

  COLOR_ALUMINIUM_5,

  COLOR_ALUMINIUM_6,

  COLOR_TRANSPARENT

}
 Named colors, for accessing global colors defined by Clutter. More...

 
enum  FlowOrientation {

  FLOW_HORIZONTAL,

  FLOW_VERTICAL

}
 The direction of the arrangement of the children inside a Clutter::FlowLayout. More...

 
enum  GridPosition {

  GRID_POSITION_LEFT,

  GRID_POSITION_RIGHT,

  GRID_POSITION_TOP,

  GRID_POSITION_BOTTOM

}
 Grid position modes. More...

 
enum  ImageError { IMAGE_ERROR_INVALID_DATA }
 Error enumeration for Clutter::Image. More...

 
enum  InputAxis {

  INPUT_AXIS_IGNORE,

  INPUT_AXIS_X,

  INPUT_AXIS_Y,

  INPUT_AXIS_PRESSURE,

  INPUT_AXIS_XTILT,

  INPUT_AXIS_YTILT,

  INPUT_AXIS_WHEEL,

  INPUT_AXIS_DISTANCE,

  INPUT_AXIS_LAST

}
 The type of axes Clutter recognizes on a Clutter::InputDevice. More...

 
enum  InputMode {

  INPUT_MODE_MASTER,

  INPUT_MODE_SLAVE,

  INPUT_MODE_FLOATING

}
 The mode for input devices available. More...

 
enum  InputDeviceType {

  POINTER_DEVICE,

  KEYBOARD_DEVICE,

  EXTENSION_DEVICE,

  JOYSTICK_DEVICE,

  TABLET_DEVICE,

  TOUCHPAD_DEVICE,

  TOUCHSCREEN_DEVICE,

  PEN_DEVICE,

  ERASER_DEVICE,

  CURSOR_DEVICE,

  N_DEVICE_TYPES

}
 The types of input devices available. More...

 
enum  ModifierType {

  SHIFT_MASK = 1 << 0,

  LOCK_MASK = 1 << 1,

  CONTROL_MASK = 1 << 2,

  MOD1_MASK = 1 << 3,

  MOD2_MASK = 1 << 4,

  MOD3_MASK = 1 << 5,

  MOD4_MASK = 1 << 6,

  MOD5_MASK = 1 << 7,

  BUTTON1_MASK = 1 << 8,

  BUTTON2_MASK = 1 << 9,

  BUTTON3_MASK = 1 << 10,

  BUTTON4_MASK = 1 << 11,

  BUTTON5_MASK = 1 << 12,

  MODIFIER_RESERVED_13_MASK = 1 << 13,

  MODIFIER_RESERVED_14_MASK = 1 << 14,

  MODIFIER_RESERVED_15_MASK = 1 << 15,

  MODIFIER_RESERVED_16_MASK = 1 << 16,

  MODIFIER_RESERVED_17_MASK = 1 << 17,

  MODIFIER_RESERVED_18_MASK = 1 << 18,

  MODIFIER_RESERVED_19_MASK = 1 << 19,

  MODIFIER_RESERVED_20_MASK = 1 << 20,

  MODIFIER_RESERVED_21_MASK = 1 << 21,

  MODIFIER_RESERVED_22_MASK = 1 << 22,

  MODIFIER_RESERVED_23_MASK = 1 << 23,

  MODIFIER_RESERVED_24_MASK = 1 << 24,

  MODIFIER_RESERVED_25_MASK = 1 << 25,

  SUPER_MASK = 1 << 26,

  HYPER_MASK = 1 << 27,

  META_MASK = 1 << 28,

  MODIFIER_RESERVED_29_MASK = 1 << 29,

  RELEASE_MASK = 1 << 30,

  MODIFIER_MASK = 0x5c001fff

}
 Masks applied to a Clutter::Event by modifiers. More...

 
enum  PathNodeType {

  PATH_MOVE_TO,

  PATH_LINE_TO,

  PATH_CURVE_TO,

  PATH_CLOSE,

  PATH_REL_MOVE_TO = PATH_MOVE_TO | CLUTTER_PATH_RELATIVE,

  PATH_REL_LINE_TO = PATH_LINE_TO | CLUTTER_PATH_RELATIVE,

  PATH_REL_CURVE_TO = PATH_CURVE_TO | CLUTTER_PATH_RELATIVE

}
 
enum  ScrollMode {

  SCROLL_NONE = 0x0,

  SCROLL_HORIZONTALLY = 1 << 0,

  SCROLL_VERTICALLY = 1 << 1,

  SCROLL_BOTH = 0x3

}
 Scroll modes. More...

 
enum  ShaderType {

  VERTEX_SHADER,

  FRAGMENT_SHADER

}
 The type of GLSL shader program. More...

 
enum  SnapEdge {

  SNAP_EDGE_TOP,

  SNAP_EDGE_RIGHT,

  SNAP_EDGE_BOTTOM,

  SNAP_EDGE_LEFT

}
 The edge to snap. More...

 
enum  PickMode {

  PICK_NONE,

  PICK_REACTIVE,

  PICK_ALL

}
 Controls the paint cycle of the scene graph when in pick mode. More...

 
enum  TextureFlags {

  TEXTURE_NONE = 0x0,

  TEXTURE_RGB_FLAG_BGR = 1 << 1,

  TEXTURE_RGB_FLAG_PREMULT = 1 << 2,

  TEXTURE_YUV_FLAG_YUV2 = 1 << 3

}
 Flags for Clutter::Texture::set_from_rgb_data() and Clutter::Texture::set_from_yuv_data(). More...

 
enum  TextureQuality {

  TEXTURE_QUALITY_LOW,

  TEXTURE_QUALITY_MEDIUM,

  TEXTURE_QUALITY_HIGH

}
 Enumaration controlling the texture quality. More...

 
enum  TimelineDirection {

  TIMELINE_FORWARD,

  TIMELINE_BACKWARD

}
 The direction of a Clutter::Timeline. More...

 
enum  AnimationMode {

  CUSTOM_MODE,

  LINEAR,

  EASE_IN_QUAD,

  EASE_OUT_QUAD,

  EASE_IN_OUT_QUAD,

  EASE_IN_CUBIC,

  EASE_OUT_CUBIC,

  EASE_IN_OUT_CUBIC,

  EASE_IN_QUART,

  EASE_OUT_QUART,

  EASE_IN_OUT_QUART,

  EASE_IN_QUINT,

  EASE_OUT_QUINT,

  EASE_IN_OUT_QUINT,

  EASE_IN_SINE,

  EASE_OUT_SINE,

  EASE_IN_OUT_SINE,

  EASE_IN_EXPO,

  EASE_OUT_EXPO,

  EASE_IN_OUT_EXPO,

  EASE_IN_CIRC,

  EASE_OUT_CIRC,

  EASE_IN_OUT_CIRC,

  EASE_IN_ELASTIC,

  EASE_OUT_ELASTIC,

  EASE_IN_OUT_ELASTIC,

  EASE_IN_BACK,

  EASE_OUT_BACK,

  EASE_IN_OUT_BACK,

  EASE_IN_BOUNCE,

  EASE_OUT_BOUNCE,

  EASE_IN_OUT_BOUNCE,

  STEPS,

  STEP_START,

  STEP_END,

  CUBIC_BEZIER,

  EASE,

  EASE_IN,

  EASE_OUT,

  EASE_IN_OUT,

  ANIMATION_LAST

}
 The animation modes used by Clutter::Alpha and Clutter::Animation. More...

 
enum  RotateDirection {

  ROTATE_CW,

  ROTATE_CCW

}
 Direction of a rotation. More...

 
enum  RotateAxis {

  X_AXIS,

  Y_AXIS,

  Z_AXIS

}
 Axis of a rotation. More...

 
enum  Gravity {

  GRAVITY_NONE,

  GRAVITY_NORTH,

  GRAVITY_NORTH_EAST,

  GRAVITY_EAST,

  GRAVITY_SOUTH_EAST,

  GRAVITY_SOUTH,

  GRAVITY_SOUTH_WEST,

  GRAVITY_WEST,

  GRAVITY_NORTH_WEST,

  GRAVITY_CENTER

}
 Gravity of the scaling operations. More...

 
enum  RequestMode {

  REQUEST_HEIGHT_FOR_WIDTH,

  REQUEST_WIDTH_FOR_HEIGHT

}
 Specifies the type of requests for a Clutter::Actor. More...

 
enum  FontFlags {

  FONT_MIPMAPPING = (1 << 0),

  FONT_HINTING = (1 << 1)

}
 Runtime flags to change the font quality. More...

 
enum  ScalingFilter {

  SCALING_FILTER_LINEAR,

  SCALING_FILTER_NEAREST,

  SCALING_FILTER_TRILINEAR

}
 The scaling filters to be used with the Clutter::Actor::property_minification_filter() and Clutter::Actor::property_magnification_filter() properties. More...

 
enum  TextDirection {

  TEXT_DIRECTION_DEFAULT,

  TEXT_DIRECTION_LTR,

  TEXT_DIRECTION_RTL

}
 The text direction to be used by Clutter::Actors. More...

 

Functions

ActorFlags operator| (ActorFlags lhs, ActorFlags rhs)
 
ActorFlags operator& (ActorFlags lhs, ActorFlags rhs)
 
ActorFlags operator^ (ActorFlags lhs, ActorFlags rhs)
 
ActorFlags operator~ (ActorFlags flags)
 
ActorFlagsoperator|= (ActorFlags& lhs, ActorFlags rhs)
 
ActorFlagsoperator&= (ActorFlags& lhs, ActorFlags rhs)
 
ActorFlagsoperator^= (ActorFlags& lhs, ActorFlags rhs)
 
AllocationFlags operator| (AllocationFlags lhs, AllocationFlags rhs)
 
AllocationFlags operator& (AllocationFlags lhs, AllocationFlags rhs)
 
AllocationFlags operator^ (AllocationFlags lhs, AllocationFlags rhs)
 
AllocationFlags operator~ (AllocationFlags flags)
 
AllocationFlagsoperator|= (AllocationFlags& lhs, AllocationFlags rhs)
 
AllocationFlagsoperator&= (AllocationFlags& lhs, AllocationFlags rhs)
 
AllocationFlagsoperator^= (AllocationFlags& lhs, AllocationFlags rhs)
 
ContentRepeat operator| (ContentRepeat lhs, ContentRepeat rhs)
 
ContentRepeat operator& (ContentRepeat lhs, ContentRepeat rhs)
 
ContentRepeat operator^ (ContentRepeat lhs, ContentRepeat rhs)
 
ContentRepeat operator~ (ContentRepeat flags)
 
ContentRepeatoperator|= (ContentRepeat& lhs, ContentRepeat rhs)
 
ContentRepeatoperator&= (ContentRepeat& lhs, ContentRepeat rhs)
 
ContentRepeatoperator^= (ContentRepeat& lhs, ContentRepeat rhs)
 
OffscreenRedirect operator| (OffscreenRedirect lhs, OffscreenRedirect rhs)
 
OffscreenRedirect operator& (OffscreenRedirect lhs, OffscreenRedirect rhs)
 
OffscreenRedirect operator^ (OffscreenRedirect lhs, OffscreenRedirect rhs)
 
OffscreenRedirect operator~ (OffscreenRedirect flags)
 
OffscreenRedirectoperator|= (OffscreenRedirect& lhs, OffscreenRedirect rhs)
 
OffscreenRedirectoperator&= (OffscreenRedirect& lhs, OffscreenRedirect rhs)
 
OffscreenRedirectoperator^= (OffscreenRedirect& lhs, OffscreenRedirect rhs)
 
ModifierType operator| (ModifierType lhs, ModifierType rhs)
 
ModifierType operator& (ModifierType lhs, ModifierType rhs)
 
ModifierType operator^ (ModifierType lhs, ModifierType rhs)
 
ModifierType operator~ (ModifierType flags)
 
ModifierTypeoperator|= (ModifierType& lhs, ModifierType rhs)
 
ModifierTypeoperator&= (ModifierType& lhs, ModifierType rhs)
 
ModifierTypeoperator^= (ModifierType& lhs, ModifierType rhs)
 
ScrollMode operator| (ScrollMode lhs, ScrollMode rhs)
 
ScrollMode operator& (ScrollMode lhs, ScrollMode rhs)
 
ScrollMode operator^ (ScrollMode lhs, ScrollMode rhs)
 
ScrollMode operator~ (ScrollMode flags)
 
ScrollModeoperator|= (ScrollMode& lhs, ScrollMode rhs)
 
ScrollModeoperator&= (ScrollMode& lhs, ScrollMode rhs)
 
ScrollModeoperator^= (ScrollMode& lhs, ScrollMode rhs)
 
TextureFlags operator| (TextureFlags lhs, TextureFlags rhs)
 
TextureFlags operator& (TextureFlags lhs, TextureFlags rhs)
 
TextureFlags operator^ (TextureFlags lhs, TextureFlags rhs)
 
TextureFlags operator~ (TextureFlags flags)
 
TextureFlagsoperator|= (TextureFlags& lhs, TextureFlags rhs)
 
TextureFlagsoperator&= (TextureFlags& lhs, TextureFlags rhs)
 
TextureFlagsoperator^= (TextureFlags& lhs, TextureFlags rhs)
 
FontFlags operator| (FontFlags lhs, FontFlags rhs)
 
FontFlags operator& (FontFlags lhs, FontFlags rhs)
 
FontFlags operator^ (FontFlags lhs, FontFlags rhs)
 
FontFlags operator~ (FontFlags flags)
 
FontFlagsoperator|= (FontFlags& lhs, FontFlags rhs)
 
FontFlagsoperator&= (FontFlags& lhs, FontFlags rhs)
 
FontFlagsoperator^= (FontFlags& lhs, FontFlags rhs)
 
bool events_pending ()
 Checks if events are pending in the event queue. More...

 
guint key_event_get_symbol (KeyEvent* keyev)
 Retrieves the value of the key that caused keyev. More...

 
guint16 key_event_get_code (KeyEvent* keyev)
 Retrieves the keycode of the key that caused keyev. More...

 
guint32 key_event_get_unicode (KeyEvent* keyev)
 Retrieves the unicode value for the key that caused keyev. More...

 
guint32 keysym_to_unicode (guint keyval)
 Convert from a Clutter key symbol to the corresponding ISO10646 (Unicode) character. More...

 
sigc::connection frame_source_add (const sigc::slot< bool >& callback, guint interval, int priority=Glib::PRIORITY_DEFAULT)
 Sets a function to be called at regular intervals with the given priority. More...

 
void init (int* argc, gchar** argv[])
 It will initialise everything needed to operate with Clutter and parses some standard command line options. More...

 
void init (int& argc, gchar**& argv)
 It will initialise everything needed to operate with Clutter and parses some standard command line options. More...

 
void add_clutter_option_group (Glib::OptionContext& option_context)
 Adds a Glib::OptionGroup for the command line arguments recognized by Clutter to the given context. More...

 
void main ()
 Starts the Clutter mainloop. More...

 
void main_quit ()
 Terminates the Clutter mainloop. More...

 
int main_level ()
 Retrieves the depth of the Clutter mainloop. More...

 
bool get_debug_enabled ()
 Check if clutter has debugging turned on. More...

 
bool get_show_fps ()
 Returns whether Clutter should print out the frames per second on the console. More...

 
gulong get_timestamp ()
 Returns the approximate number of microseconds passed since clutter was intialised. More...

 
Glib::RefPtr< Actorget_actor_by_gid (guint32 id)
 Retrieves the Actor with id. More...

 
void set_default_frame_rate (guint frames_per_sec)
 Sets the default frame rate to be used when creating Timeline objects. More...

 
guint get_default_frame_rate ()
 Retrieves the default frame rate used when creating ClutterTimelines. More...

 
void set_motion_events_enabled (bool enable)
 Sets whether per-actor motion events should be enabled or not (the default is to enable them). More...

 
bool get_motion_events_enabled ()
 Gets whether the per-actor motion events are enabled. More...

 
void clear_glyph_cache ()
 Clears the internal cache of glyphs used by the Pango renderer. More...

 
void set_font_flags (FontFlags flags)
 
FontFlags get_font_flags ()
 
Glib::RefPtr< Pango::FontMap > get_font_map ()
 
Glib::RefPtr< Actorget_keyboard_grab ()
 Queries the current keyboard grab of clutter. More...

 
Glib::RefPtr< Actorget_pointer_grab ()
 Queries the current pointer grab of clutter. More...

 
void grab_keyboard (const Glib::RefPtr< Actor >& actor)
 Grabs keyboard events, after the grab is done keyboard events ("key-press-event" and "key-release-event") are delivered to this actor directly. More...

 
void grab_pointer (const Glib::RefPtr< 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. More...

 
void ungrab_keyboard ()
 Removes an existing grab of the keyboard. More...

 
void ungrab_pointer ()
 Removes an existing grab of the pointer. More...

 
void grab_pointer_for_device (const Glib::RefPtr< Actor >& actor, int id)
 Grabs all the pointer events coming from the device id for actor. More...

 
void ungrab_pointer_for_device (int id)
 Removes an existing grab of the pointer events for device id. More...

 
void threads_init ()
 Initialises the Clutter threading mechanism, so that Clutter API can be called by multiple threads, using threads_enter() and threads_leave() to mark the critical sections. More...

 
void threads_enter ()
 Locks the Clutter thread lock. More...

 
void threads_leave ()
 Unlocks the Clutter thread lock. More...

 
sigc::connection threads_add_idle (const sigc::slot< bool >& callback, int priority=Glib::PRIORITY_DEFAULT_IDLE)
 Adds a function to be called whenever there are no higher priority events pending. More...

 
sigc::connection threads_add_timeout (const sigc::slot< bool >& callback, guint interval, gint priority=Glib::PRIORITY_DEFAULT)
 Sets a function to be called at regular intervals holding the Clutter lock, with the given priority. More...

 
sigc::connection threads_add_frame_source (const sigc::slot< bool >& callback, guint interval, gint priority=Glib::PRIORITY_DEFAULT)
 Sets a function to be called at regular intervals holding the Clutter lock, with the given priority. More...

 

Typedef Documentation

typedef ClutterButtonEvent Clutter::ButtonEvent
typedef ClutterCrossingEvent Clutter::CrossingEvent
typedef ClutterEvent Clutter::Event
typedef ClutterFog Clutter::Fog
Deprecated:
Fog settings are ignored.
typedef ClutterKeyEvent Clutter::KeyEvent
typedef ClutterMatrix Clutter::Matrix
typedef ClutterMotionEvent Clutter::MotionEvent
typedef ClutterPaintVolume Clutter::PaintVolume
typedef ClutterScrollEvent Clutter::ScrollEvent

Enumeration Type Documentation

Enumerator
PATH_MOVE_TO 
PATH_LINE_TO 
PATH_CURVE_TO 
PATH_CLOSE 
PATH_REL_MOVE_TO 
PATH_REL_LINE_TO 
PATH_REL_CURVE_TO 

Function Documentation

void Clutter::add_clutter_option_group ( Glib::OptionContext option_context)

Adds a Glib::OptionGroup for the command line arguments recognized by Clutter to the given context.

This is useful if you are using Glib::OptionContext::parse() to parse your commandline arguments.

Parameters
option_contexta Glib::OptionContext to add the clutter option group to.
void Clutter::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.

Deprecated:
Use get_font_map() and cogl_pango_font_map_clear_glyph_cache() instead.
bool Clutter::events_pending ( )

Checks if events are pending in the event queue.

Returns
true if there are pending events, false otherwise.
sigc::connection Clutter::frame_source_add ( const sigc::slot< bool > &  callback,
guint  interval,
int  priority = Glib::PRIORITY_DEFAULT 
)

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 first call to the function will be at the end of the first interval.

This function is similar to Glib::SignalTimeout except that it will try to compensate for delays. For example, if func takes half the interval time to execute then the function will be called again half the interval time after it finished. In contrast Glib::SignalTimeout would not fire until a full interval after the function completes so the delay between calls would be interval * 1.5. This function does not however try to invoke the function multiple times to catch up missing frames if callback takes more than interval ms to execute.

Parameters
callbackfunction to call
intervalthe time between calls to the function, in milliseconds
thepriority of the timeout source. Typically this will be in the range between Glib::PRIORITY_DEFAULT and Glib::PRIORITY_HIGH.
Returns
A sigc::connection that can be used to disconnect the callback from the timeout source.
Deprecated:
This method is no longer useful.
Glib::RefPtr<Actor> Clutter::get_actor_by_gid ( guint32  id)

Retrieves the Actor with id.

Parameters
idan Actor ID.
Returns
the actor with the passed id or a NULL RefPtr.
Deprecated:
The id is not used any longer.
bool Clutter::get_debug_enabled ( )

Check if clutter has debugging turned on.

Returns
true if debugging is turned on, false otherwise.
Deprecated:
guint Clutter::get_default_frame_rate ( )

Retrieves the default frame rate used when creating ClutterTimelines.

This value is also used to compute the default frequency of motion events.

Returns
the default frame rate
FontFlags Clutter::get_font_flags ( )
Deprecated:
Use Backend::get_font_options() and the cairo_font_option_t API.
Glib::RefPtr<Pango::FontMap> Clutter::get_font_map ( )
Glib::RefPtr<Actor> Clutter::get_keyboard_grab ( )

Queries the current keyboard grab of clutter.

Returns
the actor currently holding the keyboard grab, or an empty Glib::RefPtr if there is no grab.
bool Clutter::get_motion_events_enabled ( )

Gets whether the per-actor motion events are enabled.

Returns
true if the motion events are enabled.
Deprecated:
Use Stage::get_motion_events_enabled() instead.
Glib::RefPtr<Actor> Clutter::get_pointer_grab ( )

Queries the current pointer grab of clutter.

Returns
the actor currently holding the pointer grab, or am empty Glib::RefPtr if there is no grab.
bool Clutter::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.

Returns
true if Clutter should show the FPS.
Deprecated:
Use the environment variable or the configuration file to determine whether Clutter should print out the FPS counter on the console.
gulong Clutter::get_timestamp ( )

Returns the approximate number of microseconds passed since clutter was intialised.

Returns
Number of microseconds since clutter_init() was called.
Deprecated:
Use Glib::Timer or g_get_monotonic_time() for a proper timing source.
void Clutter::grab_keyboard ( const Glib::RefPtr< Actor > &  actor)

Grabs keyboard events, after the grab is done keyboard events ("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.

Parameters
actorAn Actor
void Clutter::grab_pointer ( const Glib::RefPtr< 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.

The source set in the event will be the actor that would have received the event if the pointer grab was not in effect.

If you wish to grab all the pointer events for a specific input device, you should use grab_pointer_for_device().

Parameters
actorAn Actor
void Clutter::grab_pointer_for_device ( const Glib::RefPtr< Actor > &  actor,
int  id 
)

Grabs all the pointer events coming from the device id for actor.

If id is -1 then this function is equivalent to grab_pointer().

Parameters
actorAn Actor.
ida device id, or -1
Deprecated:
Use InputDevice::grab() instead.
void Clutter::init ( int *  argc,
gchar **  argv[] 
)

It will initialise 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.

Parameters
argca pointer to the number of command line arguments
argva pointer to the array of comman line arguments
Exceptions
InitError,Glib::OptionError
void Clutter::init ( int &  argc,
gchar **&  argv 
)

It will initialise 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.

Parameters
argca reference to the number of command line arguments
argva reference to the array of comman line arguments
Exceptions
InitError,Glib::OptionError
guint16 Clutter::key_event_get_code ( KeyEvent *  keyev)

Retrieves the keycode of the key that caused keyev.

Parameters
keyevA KeyEvent.
Returns
The keycode representing the key
guint Clutter::key_event_get_symbol ( KeyEvent *  keyev)

Retrieves the value of the key that caused keyev.

Parameters
keyevA KeyEvent.
Returns
The keysym representing the key.
guint32 Clutter::key_event_get_unicode ( KeyEvent *  keyev)

Retrieves the unicode value for the key that caused keyev.

Parameters
keyevA KeyEvent
Returns
The unicode value representing the key
guint32 Clutter::keysym_to_unicode ( guint  keyval)

Convert from a Clutter key symbol to the corresponding ISO10646 (Unicode) character.

Parameters
keyvala clutter key symbol
Returns
the corresponding unicode character, or 0 if there is no corresponding character.
void Clutter::main ( )

Starts the Clutter mainloop.

int Clutter::main_level ( )

Retrieves the depth of the Clutter mainloop.

Returns
The level of the mainloop.
void Clutter::main_quit ( )

Terminates the Clutter mainloop.

void Clutter::set_default_frame_rate ( guint  frames_per_sec)

Sets the default frame rate to be used when creating Timeline objects.

Parameters
frames_per_secthe new default frame rate.
Deprecated:
This function does not do anything any more.
void Clutter::set_font_flags ( FontFlags  flags)
Deprecated:
Use Backend::set_font_options() and the cairo_font_option_t API.
void Clutter::set_motion_events_enabled ( bool  enable)

Sets whether per-actor motion events should be enabled or not (the default is to enable them).

If enable is false the following events will not work:

  • ClutterActor::motion-event, unless on the ClutterStage
  • ClutterActor::enter-event
  • ClutterActor::leave-event
Parameters
enabletrue to enable per-actor motion events.
Deprecated:
Use Stage::set_motion_events_enabled() instead.
sigc::connection Clutter::threads_add_frame_source ( const sigc::slot< bool > &  callback,
guint  interval,
gint  priority = Glib::PRIORITY_DEFAULT 
)

Sets a function to be called at regular intervals holding the Clutter lock, 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 first call to the function will be at the end of the first interval.

This function is similar to threads_add_timeout_full() except that it will try to compensate for delays. For example, if func takes half the interval time to execute then the function will be called again half the interval time after it finished. In contrast threads_add_timeout() would not fire until a full interval after the function completes so the delay between calls would be interval* 1.5. This function does not however try to invoke the function multiple times to catch up missing frames if func takes more than interval ms to execute.

This variant of frame_source_add() can be thought of a MT-safe version for Clutter actors.

Parameters
callbackfunction to call
intervalthe time between calls to the function, in milliseconds
thepriority of the timeout source. Typically this will be in the range between Glib::PRIORITY_DEFAULT and Glib::PRIORITY_HIGH.
Returns
A sigc::connection that can be used to disconnect the callback from the timeout source.
Deprecated:
This function is no longer useful.
sigc::connection Clutter::threads_add_idle ( const sigc::slot< bool > &  callback,
int  priority = Glib::PRIORITY_DEFAULT_IDLE 
)

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.

This variant of Glib::signal_idle calls function with the Clutter lock held. It can be thought of a MT-safe version for Clutter actors for the use case where you have to worry about idle_callback() running in thread A and accessing self after it has been finalized in thread B.

Parameters
callbackfunction to call
prioritythe priority of the timeout source. Typically this will be in the range between Glib::PRIORITY_DEFAULT_IDLE and Glib::PRIORITY_HIGH_IDLE
Returns
A sigc::connection that can be used to disconnect the callback from the idle source.
sigc::connection Clutter::threads_add_timeout ( const sigc::slot< bool > &  callback,
guint  interval,
gint  priority = Glib::PRIORITY_DEFAULT 
)

Sets a function to be called at regular intervals holding the Clutter lock, 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 first call to the function will be at the end of the first interval.

Note that timeout functions may be delayed, due to the processing of other event sources. Thus they should not be relied on for precise timing. After each call to the timeout function, the time of the next timeout is recalculated based on the current time and the given interval (it does not try to 'catch up' time lost in delays).

This variant of Glib::SignalTimeout can be thought of a MT-safe version for Clutter actors. See also threads_add_idle().

Parameters
callbackfunction to call
intervalthe time between calls to the function, in milliseconds
prioritythe priority of the timeout source. Typically this will be in the range between Glib::PRIORITY_DEFAULT and Glib::PRIORITY_HIGH.
Returns
A sigc::connection that can be used to disconnect the callback from the timeout source.
void Clutter::threads_enter ( )

Locks the Clutter thread lock.

Deprecated:
This function should not be used by application code. Marking critical sections is not portable on various platforms. Instead of acquiring the Clutter lock, schedule UI updates from the main loop using threads_add_idle() or threads_add_timeout().
void Clutter::threads_init ( )

Initialises the Clutter threading mechanism, so that Clutter API can be called by multiple threads, using threads_enter() and threads_leave() to mark the critical sections.

You must call Glib::thread_init() before this function.

This function must be called before init().

Deprecated:
This function does not do anything. Threading support is initialized when Clutter is initialized.
void Clutter::threads_leave ( )

Unlocks the Clutter thread lock.

Deprecated:
This function should not be used by application code. Marking critical sections is not portable on various platforms. Instead of acquiring the Clutter lock, schedule UI updates from the main loop using threads_add_idle() or threads_add_timeout().
void Clutter::ungrab_keyboard ( )

Removes an existing grab of the keyboard.

void Clutter::ungrab_pointer ( )

Removes an existing grab of the pointer.

void Clutter::ungrab_pointer_for_device ( int  id)

Removes an existing grab of the pointer events for device id.

Parameters
adevice id
Deprecated:
Use InputDevice::ungrab() instead.