Namespace
Clutter – 10
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 | |
| Actor |
Base class for actors. |
| ActorMeta | |
| ActorNode |
The |
| AlignConstraint |
since: 1.4 |
| Backend |
since: 0.4 |
| BindConstraint |
since: 1.4 |
| BindingPool |
Container of key bindings. The since: 1.0 |
| BinLayout |
The since: 1.2 |
| BlitNode | |
| BlurEffect |
since: 1.4 |
| BlurNode |
The |
| BoxLayout |
The since: 1.2 |
| BrightnessContrastEffect |
since: 1.10 |
| Canvas |
The since: 1.10 |
| ChildMeta |
Base interface for container specific state for child actors. A child data is meant to be used when you need to keep track of information about each individual child added to a container. since: 0.8 |
| ClickAction | |
| ClipNode |
The since: 1.10 |
| Clone |
The since: 1.0 |
| ColorizeEffect |
since: 1.4 |
| ColorNode |
The since: 1.10 |
| Constraint |
The since: 1.4 |
| DeformEffect |
The since: 1.4 |
| DesaturateEffect |
since: 1.4 |
| Effect |
The since: 1.4 |
| FixedLayout |
The since: 1.2 |
| FlowLayout |
The since: 1.2 |
| FrameClock | |
| GestureAction | |
| GridLayout |
The since: 1.12 |
| Image |
The since: 1.10 |
| InputDevice |
Generic representation of an input device. The actual contents of this structure depend on the backend used. |
| InputDeviceTool | |
| InputFocus | |
| InputMethod | |
| Interval |
The since: 1.0 |
| KeyframeTransition |
The since: 1.12 |
| Keymap | |
| LayerNode | |
| LayoutManager |
The since: 1.2 |
| LayoutMeta |
Sub-class of since: 1.2 |
| OffscreenEffect |
The since: 1.4 |
| PageTurnEffect |
since: 1.4 |
| PaintNode |
The since: 1.10 |
| PanAction |
The since: 1.12 |
| ParamSpecColor |
A since: 1.0 |
| ParamSpecUnit | |
| Path |
The since: 1.0 |
| PathConstraint |
since: 1.6 |
| PipelineNode |
The since: 1.10 |
| PropertyTransition |
The since: 1.10 |
| RootNode |
The |
| RotateAction |
The since: 1.12 |
| Script |
The since: 0.6 |
| ScrollActor |
The since: 1.12 |
| Seat | |
| Settings |
since: 1.4 |
| ShaderEffect |
The since: 1.4 |
| ShaderFloat | |
| ShaderInt | |
| ShaderMatrix | |
| SnapConstraint |
since: 1.6 |
| Stage |
The since: 0.2 |
| StageManager |
The since: 1.0 |
| StageView | |
| SwipeAction |
The since: 1.8 |
| TapAction |
The since: 1.14 |
| Text |
The since: 1.0 |
| TextBuffer |
The since: 1.10 |
| TextNode |
The since: 1.10 |
| TextureContent | |
| TextureNode |
The since: 1.10 |
| Timeline |
The since: 0.2 |
| TransformNode | |
| Transition |
The since: 1.10 |
| TransitionGroup |
The since: 1.12 |
| VirtualInputDevice | |
| ZoomAction |
The since: 1.12 |
Interfaces
| Animatable | |
| Container |
since: 0.4 |
| Content | |
| Scriptable |
since: 0.6 |
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. |
| ActorIter |
An iterator structure that allows to efficiently iterate over a section of the scene graph. since: 1.10 |
| AnyEvent |
Common members for a since: 0.2 |
| ButtonEvent |
Button event. since: 0.2 |
| Capture | |
| Color |
Color representation. |
| Context | |
| CrossingEvent |
Event for the movement of the pointer across different actors. since: 0.2 |
| DeviceEvent | |
| EventSequence |
The since: 1.12 |
| Frame | |
| FrameInfo | |
| FrameListenerIface | |
| Grab | |
| IMEvent | |
| KeyEvent |
Key event. since: 0.2 |
| Knot |
Point in a path behaviour. since: 0.2 |
| Margin |
A representation of the components of a margin. since: 1.10 |
| MotionEvent |
Event for the pointer motion. since: 0.2 |
| PadButtonEvent | |
| PadRingEvent | |
| PadStripEvent | |
| PaintContext | |
| PaintVolume |
since: 1.4 |
| ParamSpecUnits |
since: 1.0 |
| PathNode |
Represents a single node of a since: 1.0 |
| Perspective |
Stage perspective definition. since: 0.4 |
| PickContext | |
| PointerA11ySettings |
The |
| ProximityEvent |
Event for tool proximity in tablet devices. since: 1.28 |
| ScrollEvent |
Scroll wheel (or similar device) event. since: 0.2 |
| Shader | |
| TouchEvent |
Used for touch events. since: 1.10 |
| TouchpadHoldEvent |
Used for touchpad hold gesture events. The current state of the
gesture will be determined by the |
| TouchpadPinchEvent |
Used for touchpad pinch gesture events. The current state of the
gesture will be determined by the since: 1.24 |
| TouchpadSwipeEvent |
Used for touchpad swipe gesture events. The current state of the
gesture will be determined by the since: 1.24 |
| Units |
An opaque structure, to be used to store sizing and positioning values along with their unit. since: 1.0 |
Unions
| Event |
Generic event wrapper. since: 0.2 |
Enumerations
| ActorAlign |
Controls how a since: 1.10 |
| AlignAxis |
Specifies the axis on which since: 1.4 |
| AnimationMode |
The animation modes used by since: 1.0 |
| BinAlignment |
The alignment policies available on each axis for deprecated: 1.12 since: 1.2 |
| BindCoordinate |
Specifies which property should be used in a binding. since: 1.4 |
| BoxAlignment |
The alignment policies available on each axis of the since: 1.2 |
| ButtonState | |
| ContentGravity |
Controls the alignment of the since: 1.10 |
| DragAxis |
The axis of the constraint that should be applied on the dragging action. since: 1.4 |
| EventPhase | |
| EventType |
Types of events. since: 0.4 |
| FlowOrientation |
The direction of the arrangement of the children inside
a since: 1.2 |
| FrameResult | |
| GestureTriggerEdge |
Enum passed to the since: 1.18 |
| Gravity |
Gravity of the scaling operations. When a gravity different than
deprecated: 1.22 since: 0.2 |
| GridPosition |
Grid position modes. since: 1.12 |
| InputAxis |
The type of axes Clutter recognizes on a since: 1.6 |
| InputContentPurpose | |
| InputDevicePadFeature | |
| InputDevicePadSource | |
| InputDeviceToolType |
Defines the type of tool that a since: 1.28 |
| InputDeviceType |
The types of input devices available. since: 1.0 |
| InputMode |
The mode for input devices available. since: 1.6 |
| InputPanelState | |
| Interpolation |
The mode of interpolation between key frames. deprecated: 1.22 since: 1.2 |
| KeyState | |
| LongPressState |
The states for the since: 1.8 |
| Orientation |
Represents the orientation of actors or layout managers. since: 1.12 |
| PanAxis |
The axis of the constraint that should be applied on the panning action. since: 1.12 |
| PathNodeType |
Types of nodes in a since: 1.0 |
| PickMode |
Controls the paint cycle of the scene graph when in pick mode. since: 1.0 |
| 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 since: 0.8 |
| RotateAxis |
Axis of a rotation. since: 0.4 |
| RotateDirection |
Direction of a rotation. deprecated: 1.22 since: 0.4 |
| ScalingFilter |
The scaling filters to be used with the since: 1.10 |
| ScrollDirection |
Direction of a pointer scroll event. since: 0.4 |
| ScrollSource |
The scroll source determines the source of the scroll event. Keep in mind
that the source device since: 1.26 |
| ShaderType |
The type of GLSL shader program. since: 1.4 |
| SnapEdge |
The edge to snap. since: 1.6 |
| StaticColor |
Named colors, for accessing global colors defined by Clutter. since: 1.6 |
| StepMode |
Change the value transition of a step function. since: 1.12 |
| TextDirection |
The text direction to be used by since: 1.2 |
| TextureQuality |
Enumaration controlling the texture quality. deprecated: 1.22 since: 0.8 |
| TimelineDirection |
The direction of a since: 0.6 |
| TouchpadGesturePhase |
The phase of a touchpad gesture event. All gestures are guaranteed to
begin with an event of type since: 1.24 |
| UnitType |
The type of unit in which a value is expressed. since: 1.0 |
Bitfields
| ActorFlags |
Flags used to signal the state of an actor. |
| ContentRepeat |
Content repeat modes. since: 1.12 |
| DebugFlag | |
| DrawDebugFlag | |
| EffectPaintFlags |
Flags passed to the ‘paint’ or ‘pick’ method of |
| EventFlags |
Flags for the since: 0.6 |
| FeatureFlags |
Runtime flags indicating specific features available via Clutter window system and graphics backend. since: 0.4 |
| FrameInfoFlag | |
| GrabState | |
| InputAxisFlags | |
| InputCapabilities | |
| InputContentHintFlags | |
| ModifierType |
Masks applied to a since: 0.4 |
| OffscreenRedirect |
Possible flags to pass to clutter_actor_set_offscreen_redirect(). since: 1.8 |
| PaintFlag | |
| PickDebugFlag | |
| PointerA11yFlags |
Pointer accessibility features applied to a ClutterInputDevice pointer. |
| RepaintFlags |
Flags to pass to clutter_threads_add_repaint_func_full(). since: 1.10 |
| ScrollFinishFlags |
Flags used to notify the axes that were stopped in a since: 1.26 |
| ScrollMode |
Scroll modes. since: 1.12 |
| SwipeDirection |
The main direction of the swipe gesture. since: 1.8 |
| TextureFlags |
Flags for clutter_texture_set_from_rgb_data(). deprecated: 1.22 since: 0.4 |
| VirtualDeviceType |
Error Domains
| ImageError |
Error enumeration for since: 1.10 |
| ScriptError |
since: 0.6 |
Callbacks
| ActorCreateChildFunc |
Creates a since: 1.24 |
| BackendConstructor | |
| BindingActionFunc |
The prototype for the callback function registered with
since: 1.0 |
| Callback |
Generic callback. |
| EventFilterFunc |
A function pointer type used by event filters that are added with clutter_event_add_filter(). since: 1.18 |
| PathCallback |
This function is passed to since: 1.0 |
| ProgressFunc |
Prototype of the progress function used to compute the value
between the two ends since: 1.0 |
| ScriptConnectFunc |
This is the signature of a function used to connect signals. It is used
by the since: 0.6 |
| TimelineProgressFunc |
A function for defining a custom progress. since: 1.10 |
Functions
| add_debug_flags |
Adds the debug flags passed to the list of debug flags. |
| cairo_clear |
Utility function to clear a Cairo context. since: 1.12 |
| cairo_set_source_color |
Utility function for setting the source color of since: 1.0 |
| 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(). since: 1.14 |
| do_event |
Processes an event. since: 0.4 |
| events_pending |
Checks if events are pending in the event queue. since: 0.4 |
| feature_available |
Checks whether since: 0.2 |
| feature_get_all |
Returns all the supported features. since: 0.2 |
| 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: 1.4 |
| 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: 1.2 |
| get_current_event_time |
Retrieves the timestamp of the last event, if there is an event or if the event has a timestamp. since: 1.0 |
| get_debug_flags | |
| get_default_backend |
Retrieves the default since: 0.4 |
| get_default_text_direction |
Retrieves the default direction for the text. The text direction is
determined by the locale and/or by the since: 1.2 |
| get_font_map |
Retrieves the since: 1.0 |
| get_script_id |
Retrieves the Clutter script id, if any. since: 0.6 |
| keysym_to_unicode |
Converts |
| param_spec_color |
Creates a since: 0.8 |
| param_spec_units |
Creates a since: 1.0 |
| remove_debug_flags |
Removes the debug flags passed from the list of debug flags. |
| threads_add_idle |
Simple wrapper around since: 0.4 |
| threads_add_idle_full |
Adds a function to be called whenever there are no higher priority
events pending. If the function returns since: 0.4 |
| threads_add_repaint_func |
Adds a function to be called whenever Clutter is processing a new frame. since: 1.0 |
| threads_add_repaint_func_full |
Adds a function to be called whenever Clutter is processing a new frame. since: 1.10 |
| threads_add_timeout |
Simple wrapper around clutter_threads_add_timeout_full(). since: 0.4 |
| 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: 0.4 |
| threads_remove_repaint_func |
Removes the repaint function with since: 1.0 |
| unicode_to_keysym |
Convert from a ISO10646 character to a key symbol. since: 1.10 |
| value_dup_paint_node |
Retrieves a pointer to the since: 1.10 |
| value_get_color |
Gets the since: 0.8 |
| value_get_paint_node |
Retrieves a pointer to the since: 1.10 |
| value_get_shader_float |
Retrieves the list of floating point values stored inside
the passed since: 0.8 |
| value_get_shader_int |
Retrieves the list of integer values stored inside the passed
since: 0.8 |
| value_get_shader_matrix |
Retrieves a matrix of floating point values stored inside
the passed since: 0.8 |
| value_get_units |
Gets the since: 0.8 |
| value_set_color |
Sets since: 0.8 |
| value_set_paint_node |
Sets the contents of a since: 1.10 |
| value_set_shader_float |
Sets since: 0.8 |
| value_set_shader_int |
Sets since: 0.8 |
| value_set_shader_matrix |
Sets since: 0.8 |
| value_set_units |
Sets since: 0.8 |
| value_take_paint_node |
Sets the contents of a since: 1.10 |
Function Macros
| ACTOR_BOX_INIT |
A simple macro for initializing a since: 1.10 |
| 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 since: 1.12 |
| DEPRECATED_FOR | |
| DEPRECATED_MACRO_FOR | |
| MACRO_DEPRECATED_FOR | |
| PRIVATE_FIELD | |
| VALUE_HOLDS_COLOR |
Evaluates to since: 1.0 |
| VALUE_HOLDS_PAINT_NODE |
Evaluates to since: 1.10 |
| VALUE_HOLDS_SHADER_FLOAT |
Evaluates to since: 1.0 |
| VALUE_HOLDS_SHADER_INT |
Evaluates to since: 1.0 |
| VALUE_HOLDS_SHADER_MATRIX |
Evaluates to since: 1.0 |
| VALUE_HOLDS_UNITS |
Evaluates to since: 0.8 |