Namespace
Clutter – 13
An OpenGL based 'interactive canvas' library
Dependencies
| GObject—2.0 | The base type system library |
| Browse documentation | |
| Atk—1.0 | The Accessibility toolkit |
| Browse documentation | |
| cairo—1.0 | A 2D graphics library with support for multiple output devices |
| Browse documentation |
Classes
| Action |
Abstract class for event-related logic. since: 13 |
| Actor |
The basic element of the scene graph. since: 13 |
| ActorMeta |
Base class of actor modifiers. since: 13 |
| ActorNode |
since: 13 |
| AlignConstraint |
A constraint aligning the position of an actor. since: 13 |
| Backend |
Backend abstraction. since: 13 |
| BindConstraint |
A constraint binding the position or size of an actor. since: 13 |
| BindingPool |
Pool for key bindings. since: 13 |
| BinLayout |
A simple layout manager. since: 13 |
| BlitNode |
since: 13 |
| BlurEffect |
A blur effect. since: 13 |
| BlurNode |
since: 13 |
| BoxLayout |
A layout manager arranging children on a single line. since: 13 |
| BrightnessContrastEffect |
Increase/decrease brightness and/or contrast of actor. since: 13 |
| Canvas |
Content for 2D painting. since: 13 |
| ChildMeta |
Base interface for container specific state for child actors. since: 13 |
| ClickAction |
Action for clickable actors. since: 13 |
| ClipNode |
since: 13 |
| Clone |
An actor that displays a clone of a source actor. since: 13 |
| ColorizeEffect |
A colorization effect. since: 13 |
| ColorNode |
since: 13 |
| ColorState |
Color state of each ClutterActor. since: 13 |
| Constraint |
Abstract class for constraints on position or size. since: 13 |
| DeformEffect |
A base class for effects deforming the geometry of an actor. since: 13 |
| DesaturateEffect |
A desaturation effect. since: 13 |
| Effect |
Base class for actor effects. since: 13 |
| FixedLayout |
A fixed layout manager. since: 13 |
| FlowLayout |
A reflowing layout manager. since: 13 |
| FrameClock |
since: 13 |
| GestureAction |
Action for gesture gestures. since: 13 |
| GridLayout |
A layout manager for a grid of actors. since: 13 |
| Image |
Image data content. since: 13 |
| InputDevice |
An input device managed by Clutter. since: 13 |
| InputDeviceTool |
since: 13 |
| InputFocus |
since: 13 |
| InputMethod |
since: 13 |
| Interval |
An object holding an interval of two values. since: 13 |
| KeyframeTransition |
Keyframe property transition. since: 13 |
| Keymap |
since: 13 |
| LayerNode |
since: 13 |
| LayoutManager |
Layout managers base class. since: 13 |
| LayoutMeta |
Wrapper for actors inside a layout manager. since: 13 |
| OffscreenEffect |
Base class for effects using offscreen buffers. since: 13 |
| PageTurnEffect |
A page turning effect. since: 13 |
| PaintNode |
Paint objects. since: 13 |
| PanAction |
Action for pan gestures. since: 13 |
| ParamSpecColor |
A since: 13 |
| ParamSpecUnit |
since: 13 |
| Path |
An object describing a path with straight lines and bezier curves. since: 13 |
| PathConstraint |
A constraint that follows a path. since: 13 |
| PipelineNode |
since: 13 |
| PropertyTransition |
Property transitions. since: 13 |
| RootNode |
since: 13 |
| RotateAction |
Action to rotate an actor. since: 13 |
| Script |
Loads a scene from UI definition data. since: 13 |
| ScrollActor |
An actor for displaying a portion of its children. since: 13 |
| Seat |
since: 13 |
| Settings |
Settings configuration. since: 13 |
| ShaderEffect |
Base class for shader effects. since: 13 |
| ShaderFloat |
since: 13 |
| ShaderInt |
since: 13 |
| ShaderMatrix |
since: 13 |
| SnapConstraint |
A constraint snapping two actors together. since: 13 |
| Stage |
Top level visual element to which actors are placed. since: 13 |
| StageManager |
Maintains the list of stages. since: 13 |
| StageView |
since: 13 |
| SwipeAction |
Action for swipe gestures. since: 13 |
| TapAction |
Action for tap gestures. since: 13 |
| Text |
An actor for displaying and editing text. since: 13 |
| TextBuffer |
Text buffer for since: 13 |
| TextNode |
since: 13 |
| TextureContent |
since: 13 |
| TextureNode |
since: 13 |
| Timeline |
A class for time-based events. since: 13 |
| TransformNode |
since: 13 |
| Transition |
Transition between two values. since: 13 |
| TransitionGroup |
Group transitions together. since: 13 |
| VirtualInputDevice |
since: 13 |
| ZoomAction |
Action enabling zooming on actors. since: 13 |
Interfaces
| Animatable |
Interface for animatable classes. since: 13 |
| Container |
An interface for container actors. since: 13 |
| Content |
Delegate for painting the content of an actor. since: 13 |
| Scriptable |
Override the UI definition parsing. since: 13 |
Structs
| ActorBox |
Bounding box of an actor. since: 13 |
| ActorIter |
An iterator structure that allows to efficiently iterate over a section of the scene graph. since: 13 |
| AnyEvent |
since: 13 |
| ButtonEvent |
since: 13 |
| Capture |
since: 13 |
| Color |
A simple type for representing colors. since: 13 |
| Context |
since: 13 |
| CrossingEvent |
since: 13 |
| DeviceEvent |
since: 13 |
| EventSequence |
The since: 13 |
| Frame |
since: 13 |
| FrameInfo |
since: 13 |
| FrameListenerIface |
since: 13 |
| Grab |
since: 13 |
| IMEvent |
since: 13 |
| KeyEvent |
since: 13 |
| Knot |
Point in a path behaviour. since: 13 |
| Margin |
A representation of the components of a margin. since: 13 |
| MotionEvent |
since: 13 |
| PadButtonEvent |
since: 13 |
| PadRingEvent |
since: 13 |
| PadStripEvent |
since: 13 |
| PaintContext |
since: 13 |
| PaintVolume |
A since: 13 |
| ParamSpecUnits |
since: 13 |
| PathNode |
Represents a single node of a since: 13 |
| Perspective |
Stage perspective definition. since: 13 |
| PickContext |
since: 13 |
| PointerA11ySettings |
The since: 13 |
| ProximityEvent |
since: 13 |
| ScrollEvent |
since: 13 |
| Shader |
since: 13 |
| TouchEvent |
since: 13 |
| TouchpadHoldEvent |
since: 13 |
| TouchpadPinchEvent |
since: 13 |
| TouchpadSwipeEvent |
since: 13 |
| Units |
A logical distance unit. since: 13 |
Unions
| Event |
since: 13 |
Enumerations
| ActorAlign |
Controls how a since: 13 |
| AlignAxis |
Specifies the axis on which since: 13 |
| AnimationMode |
The animation modes used by since: 13 |
| BinAlignment |
The alignment policies available on each axis for deprecated: 1.12 since: 13 |
| BindCoordinate |
Specifies which property should be used in a binding. since: 13 |
| BoxAlignment |
The alignment policies available on each axis of the since: 13 |
| ButtonState |
since: 13 |
| Colorspace |
Colorspace information. since: 13 |
| ContentGravity |
Controls the alignment of the since: 13 |
| DragAxis |
The axis of the constraint that should be applied on the dragging action. since: 13 |
| EventPhase |
since: 13 |
| EventType |
Types of events. since: 13 |
| FlowOrientation |
The direction of the arrangement of the children inside
a since: 13 |
| FrameResult |
since: 13 |
| GestureTriggerEdge |
Enum passed to the since: 13 |
| GridPosition |
Grid position modes. since: 13 |
| InputAxis |
The type of axes Clutter recognizes on a since: 13 |
| InputContentPurpose |
since: 13 |
| InputDevicePadFeature |
since: 13 |
| InputDevicePadSource |
since: 13 |
| InputDeviceToolType |
Defines the type of tool that a since: 13 |
| InputDeviceType |
The types of input devices available. since: 13 |
| InputMode |
The mode for input devices available. since: 13 |
| InputPanelState |
since: 13 |
| KeyState |
since: 13 |
| LongPressState |
The states for the since: 13 |
| Orientation |
Represents the orientation of actors or layout managers. since: 13 |
| PanAxis |
The axis of the constraint that should be applied on the panning action. since: 13 |
| PathNodeType |
Types of nodes in a since: 13 |
| PickMode |
Controls the paint cycle of the scene graph when in pick mode. since: 13 |
| PointerA11yDwellClickType |
Dwell click types. since: 13 |
| PointerA11yDwellDirection |
Dwell gesture directions. since: 13 |
| PointerA11yDwellMode |
Dwell mode. since: 13 |
| PointerA11yTimeoutType |
Pointer accessibility timeout type. since: 13 |
| PreeditResetMode |
since: 13 |
| RequestMode |
Specifies the type of requests for a since: 13 |
| RotateAxis |
Axis of a rotation. since: 13 |
| ScalingFilter |
The scaling filters to be used with the since: 13 |
| ScrollDirection |
Direction of a pointer scroll event. since: 13 |
| ScrollSource |
The scroll source determines the source of the scroll event. since: 13 |
| ShaderType |
The type of GLSL shader program. since: 13 |
| SnapEdge |
The edge to snap. since: 13 |
| StaticColor |
Named colors, for accessing global colors defined by Clutter. since: 13 |
| StepMode |
Change the value transition of a step function. since: 13 |
| TextDirection |
The text direction to be used by since: 13 |
| TimelineDirection |
The direction of a since: 13 |
| TouchpadGesturePhase |
The phase of a touchpad gesture event. since: 13 |
| UnitType |
The type of unit in which a value is expressed. since: 13 |
Bitfields
| ActorFlags |
Flags used to signal the state of an actor. since: 13 |
| ContentRepeat |
Content repeat modes. since: 13 |
| DebugFlag |
since: 13 |
| DrawDebugFlag |
since: 13 |
| EffectPaintFlags |
Flags passed to the ‘paint’ or ‘pick’ method of since: 13 |
| EventFlags |
Flags for the since: 13 |
| FrameInfoFlag |
since: 13 |
| GrabState |
since: 13 |
| InputAxisFlags |
since: 13 |
| InputCapabilities |
since: 13 |
| InputContentHintFlags |
since: 13 |
| ModifierType |
Masks applied to a since: 13 |
| OffscreenRedirect |
Possible flags to pass to clutter_actor_set_offscreen_redirect(). since: 13 |
| PaintFlag |
since: 13 |
| PickDebugFlag |
since: 13 |
| PointerA11yFlags |
Pointer accessibility features applied to a ClutterInputDevice pointer. since: 13 |
| RepaintFlags |
Flags to pass to clutter_threads_add_repaint_func_full(). since: 13 |
| ScrollFinishFlags |
Flags used to notify the axes that were stopped in a since: 13 |
| ScrollMode |
Scroll modes. since: 13 |
| SwipeDirection |
The main direction of the swipe gesture. since: 13 |
| VirtualDeviceType |
since: 13 |
Error Domains
| ScriptError |
since: 13 |
Callbacks
| ActorCreateChildFunc |
Creates a since: 13 |
| BackendConstructor |
since: 13 |
| BindingActionFunc |
The prototype for the callback function registered with
since: 13 |
| Callback |
Generic callback. since: 13 |
| EventFilterFunc |
A function pointer type used by event filters that are added with clutter_event_add_filter(). since: 13 |
| PathCallback |
This function is passed to since: 13 |
| ProgressFunc |
Prototype of the progress function used to compute the value
between the two ends since: 13 |
| ScriptConnectFunc |
This is the signature of a function used to connect signals. It is used
by the since: 13 |
| StageInputForeachFunc |
Iterator function for active input. Active input counts as any pointing device currently known to have some form of activity on the stage: Pointers leaning on a widget, tablet styli in proximity, active touchpoints… since: 13 |
| TimelineProgressFunc |
A function for defining a custom progress. since: 13 |
Functions
| add_debug_flags |
Adds the debug flags passed to the list of debug flags. since: 13 |
| cairo_clear |
Utility function to clear a Cairo context. since: 13 |
| cairo_set_source_color |
Utility function for setting the source color of since: 13 |
| debug_set_max_render_time_constant |
since: 13 |
| disable_accessibility |
Disable loading the accessibility support. It has the same effect as setting the environment variable CLUTTER_DISABLE_ACCESSIBILITY. For the same reason, this method should be called before clutter_init(). since: 13 |
| events_pending |
Checks if events are pending in the event queue. since: 13 |
| 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. since: 13 |
| 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. since: 13 |
| get_current_event_time |
Retrieves the timestamp of the last event, if there is an event or if the event has a timestamp. since: 13 |
| get_debug_flags |
since: 13 |
| get_default_backend |
Retrieves the default since: 13 |
| get_default_text_direction |
Retrieves the default direction for the text. The text direction is
determined by the locale and/or by the since: 13 |
| get_font_map |
Retrieves the since: 13 |
| get_script_id |
Retrieves the Clutter script id, if any. since: 13 |
| get_text_direction |
since: 13 |
| keysym_to_unicode |
Converts since: 13 |
| keyval_convert_case |
since: 13 |
| keyval_name |
since: 13 |
| param_spec_color |
Creates a since: 13 |
| param_spec_units |
Creates a since: 13 |
| remove_debug_flags |
Removes the debug flags passed from the list of debug flags. since: 13 |
| threads_add_idle |
Simple wrapper around since: 13 |
| threads_add_idle_full |
Adds a function to be called whenever there are no higher priority
events pending. If the function returns since: 13 |
| threads_add_repaint_func |
Adds a function to be called whenever Clutter is processing a new frame. since: 13 |
| threads_add_repaint_func_full |
Adds a function to be called whenever Clutter is processing a new frame. since: 13 |
| threads_add_timeout |
Simple wrapper around clutter_threads_add_timeout_full(). since: 13 |
| threads_add_timeout_full |
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 since: 13 |
| threads_remove_repaint_func |
Removes the repaint function with since: 13 |
| unicode_to_keysym |
Convert from a ISO10646 character to a key symbol. since: 13 |
| value_dup_paint_node |
Retrieves a pointer to the since: 13 |
| value_get_color |
Gets the since: 13 |
| value_get_paint_node |
Retrieves a pointer to the since: 13 |
| value_get_shader_float |
Retrieves the list of floating point values stored inside
the passed since: 13 |
| value_get_shader_int |
Retrieves the list of integer values stored inside the passed
since: 13 |
| value_get_shader_matrix |
Retrieves a matrix of floating point values stored inside
the passed since: 13 |
| value_get_units |
Gets the since: 13 |
| value_set_color |
Sets since: 13 |
| value_set_paint_node |
Sets the contents of a since: 13 |
| value_set_shader_float |
Sets since: 13 |
| value_set_shader_int |
Sets since: 13 |
| value_set_shader_matrix |
Sets since: 13 |
| value_set_units |
Sets since: 13 |
| value_take_paint_node |
Sets the contents of a since: 13 |
Function Macros
| ACTOR_BOX_INIT |
A simple macro for initializing a since: 13 |
| ACTOR_SET_FLAGS |
Sets the given flags on a deprecated: 1.24 since: 13 |
| ACTOR_UNSET_FLAGS |
Unsets the given flags on a deprecated: 1.24 since: 13 |
| CALLBACK |
Convenience macro to cast a function to since: 13 |
| COLOR_INIT |
A macro that initializes a since: 13 |
| DEPRECATED_FOR |
since: 13 |
| DEPRECATED_MACRO_FOR |
since: 13 |
| MACRO_DEPRECATED_FOR |
since: 13 |
| PRIVATE_FIELD |
since: 13 |
| VALUE_HOLDS_COLOR |
Evaluates to since: 13 |
| VALUE_HOLDS_PAINT_NODE |
Evaluates to since: 13 |
| VALUE_HOLDS_SHADER_FLOAT |
Evaluates to since: 13 |
| VALUE_HOLDS_SHADER_INT |
Evaluates to since: 13 |
| VALUE_HOLDS_SHADER_MATRIX |
Evaluates to since: 13 |
| VALUE_HOLDS_UNITS |
Evaluates to since: 13 |