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