Clutter.Actor
GObject.Object
GObject.InitiallyUnowned
Clutter.Group
Clutter.Stage
Import line: | Clutter = imports.gi.Clutter; |
GIR File: | Clutter-1.0.gir |
C documentation: | ClutterStage |
Class : | Stage |
Implements: | Clutter.Container, Clutter.Scriptable |
Extends: | Clutter.Group |
Show / Hide Inherited methods, properties and signals |
Properties | Defined By | |
---|---|---|
allocation : Clutter.ActorBox
read only
The allocation for the actor, in pixels This is property is read-only, but you might monitor it to know when an actor moves or resizes
The allocation for the actor, in pixels This is property is read-only, but you might monitor it to know when an actor moves or resizes
|
Clutter.Actor | |
anchor_gravity : Clutter.Gravity
The anchor point expressed as a ClutterGravity
The anchor point expressed as a ClutterGravity
|
Clutter.Actor | |
anchor_x : Number
The X coordinate of an actor's anchor point, relative to the actor coordinate space, in pixels
The X coordinate of an actor's anchor point, relative to the actor coordinate space, in pixels
|
Clutter.Actor | |
anchor_y : Number
The Y coordinate of an actor's anchor point, relative to the actor coordinate space, in pixels
The Y coordinate of an actor's anchor point, relative to the actor coordinate space, in pixels
|
Clutter.Actor | |
clip : Clutter.Geometry
The clip region for the actor, in actor-relative coordinates Every part of the actor outside the clip region will not be painted
The clip region for the actor, in actor-relative coordinates Every part of the actor outside the clip region will not be painted
|
Clutter.Actor | |
clip_to_allocation : Boolean
Whether the clip region should track the allocated area of the actor.
Whether the clip region should track the allocated area of the actor. This property is ignored if a clip area has been explicitly set using clutter_actor_set_clip().
|
Clutter.Actor | |
color : Clutter.Color
The color of the main stage.
The color of the main stage.
|
Clutter.Stage | |
cursor_visible : Boolean
Whether the mouse pointer should be visible
Whether the mouse pointer should be visible
|
Clutter.Stage | |
depth : Number
The position of the actor on the Z axis
The position of the actor on the Z axis
|
Clutter.Actor | |
fixed_position_set : Boolean
This flag controls whether the ClutterActor:fixed-x and ClutterActor:fixed-y properties are used
This flag controls whether the ClutterActor:fixed-x and ClutterActor:fixed-y properties are used
|
Clutter.Actor | |
fixed_x : Number
The fixed X position of the actor in pixels.
The fixed X position of the actor in pixels. Writing this property sets ClutterActor:fixed-position-set property as well, as a side effect
|
Clutter.Actor | |
fixed_y : Number
The fixed Y position of the actor in pixels.
The fixed Y position of the actor in pixels. Writing this property sets the ClutterActor:fixed-position-set property as well, as a side effect
|
Clutter.Actor | |
flags : Number
read only
|
Clutter.Actor | |
fog : Clutter.Fog
The settings for the GL "fog", used only if ClutterStage:use-fog is set to TRUE
The settings for the GL "fog", used only if ClutterStage:use-fog is set to TRUE
|
Clutter.Stage | |
fullscreen_set : Boolean
read only
|
Clutter.Stage | |
g_type_instance : GObject.TypeInstance
|
GObject.InitiallyUnowned | |
has_clip : Boolean
read only
Whether the actor has the ClutterActor:clip property set or not
Whether the actor has the ClutterActor:clip property set or not
|
Clutter.Actor | |
has_pointer : Boolean
read only
Whether the actor contains the pointer of a ClutterInputDevice or not.
Whether the actor contains the pointer of a ClutterInputDevice or not.
|
Clutter.Actor | |
height : Number
Height of the actor (in pixels).
Height of the actor (in pixels). If written, forces the minimum and natural size request of the actor to the given height. If read, returns the allocated height if available, otherwise the height request.
|
Clutter.Actor | |
key_focus : Clutter.Actor
The ClutterActor that will receive key events from the underlying windowing system.
The ClutterActor that will receive key events from the underlying windowing system. If NULL, the ClutterStage will receive the events.
|
Clutter.Stage | |
mapped : Boolean
read only
Whether the actor is mapped (will be painted when the stage to which it belongs is mapped)
Whether the actor is mapped (will be painted when the stage to which it belongs is mapped)
|
Clutter.Actor | |
min_height : Number
A forced minimum height request for the actor, in pixels Writing this property sets the ClutterActor:min-height-set property as well, as a side effect.
A forced minimum height request for the actor, in pixels Writing this property sets the ClutterActor:min-height-set property as well, as a side effect. This property overrides the usual height request of the actor.
|
Clutter.Actor | |
min_height_set : Boolean
This flag controls whether the ClutterActor:min-height property is used
This flag controls whether the ClutterActor:min-height property is used
|
Clutter.Actor | |
min_width : Number
A forced minimum width request for the actor, in pixels Writing this property sets the ClutterActor:min-width-set property as well, as a side effect.
A forced minimum width request for the actor, in pixels Writing this property sets the ClutterActor:min-width-set property as well, as a side effect. his property overrides the usual width request of the actor.
|
Clutter.Actor | |
min_width_set : Boolean
This flag controls whether the ClutterActor:min-width property is used
This flag controls whether the ClutterActor:min-width property is used
|
Clutter.Actor | |
name : String
The name of the actor
The name of the actor
|
Clutter.Actor | |
natural_height : Number
A forced natural height request for the actor, in pixels Writing this property sets the ClutterActor:natural-height-set property as well, as a side effect.
A forced natural height request for the actor, in pixels Writing this property sets the ClutterActor:natural-height-set property as well, as a side effect. This property overrides the usual height request of the actor
|
Clutter.Actor | |
natural_height_set : Boolean
This flag controls whether the ClutterActor:natural-height property is used
This flag controls whether the ClutterActor:natural-height property is used
|
Clutter.Actor | |
natural_width : Number
A forced natural width request for the actor, in pixels Writing this property sets the ClutterActor:natural-width-set property as well, as a side effect.
A forced natural width request for the actor, in pixels Writing this property sets the ClutterActor:natural-width-set property as well, as a side effect. This property overrides the usual width request of the actor
|
Clutter.Actor | |
natural_width_set : Boolean
This flag controls whether the ClutterActor:natural-width property is used
This flag controls whether the ClutterActor:natural-width property is used
|
Clutter.Actor | |
offscreen : Boolean
Whether the stage should be rendered in an offscreen buffer.
Whether the stage should be rendered in an offscreen buffer.
|
Clutter.Stage | |
opacity : Number
Opacity of an actor, between 0 (fully transparent) and 255 (fully opaque)
Opacity of an actor, between 0 (fully transparent) and 255 (fully opaque)
|
Clutter.Actor | |
parent_instance : Clutter.Group
read only
|
Clutter.Stage | |
perspective : Clutter.Perspective
The parameters used for the perspective projection from 3D coordinates to 2D
The parameters used for the perspective projection from 3D coordinates to 2D
|
Clutter.Stage | |
priv : Clutter.StagePrivate
read only
|
Clutter.Stage | |
private_flags : Number
read only
|
Clutter.Actor | |
qdata : GLib.Data
|
GObject.InitiallyUnowned | |
reactive : Boolean
Whether the actor is reactive to events or not Only reactive actors will emit event-related signals
Whether the actor is reactive to events or not Only reactive actors will emit event-related signals
|
Clutter.Actor | |
realized : Boolean
read only
Whether the actor has been realized
Whether the actor has been realized
|
Clutter.Actor | |
ref_count : Number
|
GObject.InitiallyUnowned | |
request_mode : Clutter.RequestMode
Request mode for the ClutterActor.
Request mode for the ClutterActor. The request mode determines the type of geometry management used by the actor, either height for width (the default) or width for height. For actors implementing height for width, the parent container should get the preferred width first, and then the preferred height for that width. For actors implementing width for height, the parent container should get the preferred height first, and then the preferred width for that height. For instance: |[ ClutterRequestMode mode; gfloat natural_width, min_width; gfloat natural_height, min_height; mode = clutter_actor_get_request_mode (child); if (mode == CLUTTER_REQUEST_HEIGHT_FOR_WIDTH) { clutter_actor_get_preferred_width (child, -1, &min_width, &natural_width); clutter_actor_get_preferred_height (child, natural_width, &min_height, &natural_height); } else { clutter_actor_get_preferred_height (child, -1, &min_height, &natural_height); clutter_actor_get_preferred_width (child, natural_height, &min_width, &natural_width); } ]| will retrieve the minimum and natural width and height depending on the preferred request mode of the ClutterActor "child". The clutter_actor_get_preferred_size() function will implement this check for you.
|
Clutter.Actor | |
rotation_angle_x : Number
The rotation angle on the X axis
The rotation angle on the X axis
|
Clutter.Actor | |
rotation_angle_y : Number
The rotation angle on the Y axis
The rotation angle on the Y axis
|
Clutter.Actor | |
rotation_angle_z : Number
The rotation angle on the Z axis
The rotation angle on the Z axis
|
Clutter.Actor | |
rotation_center_x : Clutter.Vertex
The rotation center on the X axis.
The rotation center on the X axis.
|
Clutter.Actor | |
rotation_center_y : Clutter.Vertex
The rotation center on the Y axis.
The rotation center on the Y axis.
|
Clutter.Actor | |
rotation_center_z : Clutter.Vertex
The rotation center on the Z axis.
The rotation center on the Z axis.
|
Clutter.Actor | |
rotation_center_z_gravity : Clutter.Gravity
The rotation center on the Z axis expressed as a ClutterGravity.
The rotation center on the Z axis expressed as a ClutterGravity.
|
Clutter.Actor | |
scale_center_x : Number
The horizontal center point for scaling
The horizontal center point for scaling
|
Clutter.Actor | |
scale_center_y : Number
The vertical center point for scaling
The vertical center point for scaling
|
Clutter.Actor | |
scale_gravity : Clutter.Gravity
The center point for scaling expressed as a ClutterGravity
The center point for scaling expressed as a ClutterGravity
|
Clutter.Actor | |
scale_x : Number
The horizontal scale of the actor
The horizontal scale of the actor
|
Clutter.Actor | |
scale_y : Number
The vertical scale of the actor
The vertical scale of the actor
|
Clutter.Actor | |
show_on_set_parent : Boolean
If TRUE, the actor is automatically shown when parented.
If TRUE, the actor is automatically shown when parented. Calling clutter_actor_hide() on an actor which has not been parented will set this property to FALSE as a side effect.
|
Clutter.Actor | |
text_direction : Clutter.TextDirection
|
Clutter.Actor | |
title : String
The stage's title - usually displayed in stage windows title decorations.
The stage's title - usually displayed in stage windows title decorations.
|
Clutter.Stage | |
use_alpha : Boolean
Whether the ClutterStage should honour the alpha component of the ClutterStage:color property when painting.
Whether the ClutterStage should honour the alpha component of the ClutterStage:color property when painting. If Clutter is run under a compositing manager this will result in the stage being blended with the underlying window(s)
|
Clutter.Stage | |
use_fog : Boolean
Whether the stage should use a linear GL "fog" in creating the depth-cueing effect, to enhance the perception of depth by fading actors farther from the viewpoint.
Whether the stage should use a linear GL "fog" in creating the depth-cueing effect, to enhance the perception of depth by fading actors farther from the viewpoint.
|
Clutter.Stage | |
user_resizable : Boolean
Whether the stage is resizable via user interaction.
Whether the stage is resizable via user interaction.
|
Clutter.Stage | |
visible : Boolean
Whether the actor is set to be visible or not See also ClutterActor:mapped
Whether the actor is set to be visible or not See also ClutterActor:mapped
|
Clutter.Actor | |
width : Number
Width of the actor (in pixels).
Width of the actor (in pixels). If written, forces the minimum and natural size request of the actor to the given width. If read, returns the allocated width if available, otherwise the width request.
|
Clutter.Actor | |
x : Number
X coordinate of the actor in pixels.
X coordinate of the actor in pixels. If written, forces a fixed position for the actor. If read, returns the fixed position if any, otherwise the allocation if available, otherwise 0.
|
Clutter.Actor | |
y : Number
Y coordinate of the actor in pixels.
Y coordinate of the actor in pixels. If written, forces a fixed position for the actor. If read, returns the fixed position if any, otherwise the allocation if available, otherwise 0.
|
Clutter.Actor |
Method / Constructor | Defined By | |
---|---|---|
new Clutter.Stage
(Object properties)
Create a new Clutter.Stage
Create a new Clutter.Stage
|
||
Clutter.Stage.get_default
()
:
Clutter.Actor
Returns the main stage.
Returns the main stage. The default ClutterStage is a singleton, so the stage will be created the first time this function is called (typically, inside clutter_init()); all the subsequent calls to clutter_stage_get_default() will return the same instance. Clutter guarantess the existence of the default stage.
|
Clutter.Stage | |
add_actor
(Actor actor)
:
none
Adds a ClutterActor to container.
Adds a ClutterActor to container. This function will emit the "actor-added" signal. The actor should be parented to ClutterContainer.
|
Clutter.Container | |
allocate
(ActorBox box, AllocationFlags flags)
:
none
Called by the parent of an actor to assign the actor its size.
Called by the parent of an actor to assign the actor its size. Should never be called by applications (except when implementing a container or layout manager). Actors can know from their allocation box whether they have moved with respect to their parent actor. The flags parameter describes additional information about the allocation, for instance whether the parent has moved with respect to the stage, for example because a grandparent's origin has moved.
|
Clutter.Actor | |
allocate_available_size
(Number x, Number y, Number available_width, Number available_height, AllocationFlags flags)
:
none
Allocates self taking into account the ClutterActor's preferred size, but limiting it to the maximum available width and height provided.
Allocates self taking into account the ClutterActor's preferred size, but limiting it to the maximum available width and height provided. This function will do the right thing when dealing with the actor's request mode. The implementation of this function is equivalent to: |[ if (request_mode == CLUTTER_REQUEST_HEIGHT_FOR_WIDTH) { clutter_actor_get_preferred_width (self, available_height, &min_width, &natural_width); width = CLAMP (natural_width, min_width, available_width); clutter_actor_get_preferred_height (self, width, &min_height, &natural_height); height = CLAMP (natural_height, min_height, available_height); } else { clutter_actor_get_preferred_height (self, available_width, &min_height, &natural_height); height = CLAMP (natural_height, min_height, available_height); clutter_actor_get_preferred_width (self, height, &min_width, &natural_width); width = CLAMP (natural_width, min_width, available_width); } box.x1 = x; box.y1 = y; box.x2 = box.x1 + available_width; box.y2 = box.y1 + available_height; clutter_actor_allocate (self, &box, flags); ]| This function can be used by fluid layout managers to allocate an actor's preferred size without making it bigger than the area available for the container.
|
Clutter.Actor | |
allocate_preferred_size
(AllocationFlags flags)
:
none
Allocates the natural size of self.
Allocates the natural size of self. This function is a utility call for ClutterActor implementations that allocates the actor's preferred natural size. It can be used by fixed layout managers (like ClutterGroup or so called 'composite actors') inside the ClutterActor::allocate implementation to give each child exactly how much space it requires. This function is not meant to be used by applications. It is also not meant to be used outside the implementation of the ClutterActor::allocate virtual function.
|
Clutter.Actor | |
animate_with_alphav
(Alpha alpha, Number n_properties, Array properties, Array values)
:
Clutter.Animation
Animates the given list of properties of actor between the current value for each property and a new final value.
Animates the given list of properties of actor between the current value for each property and a new final value. The animation has a definite behaviour given by the passed alpha. See clutter_actor_animate() for further details. This function is useful if you want to use an existing ClutterAlpha to animate actor. This is the vector-based variant of clutter_actor_animate_with_alpha(), useful for language bindings.
|
Clutter.Actor | |
animate_with_timelinev
(Number mode, Timeline timeline, Number n_properties, Array properties, Array values)
:
Clutter.Animation
Animates the given list of properties of actor between the current value for each property and a new final value.
Animates the given list of properties of actor between the current value for each property and a new final value. The animation has a definite duration given by timeline and a speed given by the mode. See clutter_actor_animate() for further details. This function is useful if you want to use an existing timeline to animate actor. This is the vector-based variant of clutter_actor_animate_with_timeline(), useful for language bindings.
|
Clutter.Actor | |
animatev
(Number mode, Number duration, Number n_properties, Array properties, Array values)
:
Clutter.Animation
Animates the given list of properties of actor between the current value for each property and a new final value.
Animates the given list of properties of actor between the current value for each property and a new final value. The animation has a definite duration and a speed given by the mode. This is the vector-based variant of clutter_actor_animate(), useful for language bindings.
|
Clutter.Actor | |
Transforms point in coordinates relative to the actor into ancestor-relative coordinates using the relevant transform stack (i.e.
Transforms point in coordinates relative to the actor into ancestor-relative coordinates using the relevant transform stack (i.e. scale, rotation, etc). If ancestor is NULL the ancestor will be the ClutterStage. In this case, the coordinates returned will be the coordinates on the stage before the projection is applied. This is different from the behaviour of clutter_actor_apply_transform_to_point().
|
Clutter.Actor | |
Transforms point in coordinates relative to the actor into screen-relative coordinates with the current actor transformation (i.e.
Transforms point in coordinates relative to the actor into screen-relative coordinates with the current actor transformation (i.e. scale, rotation, etc)
|
Clutter.Actor | |
Gets a container specific property of a child of container, In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().
Gets a container specific property of a child of container, In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset(). Note that clutter_container_child_set_property() is really intended for language bindings, clutter_container_child_set() is much more convenient for C programming.
|
Clutter.Container | |
Sets a container-specific property on a child of container.
Sets a container-specific property on a child of container.
|
Clutter.Container | |
create_child_meta
(Actor actor)
:
none
Creates the ClutterChildMeta wrapping actor inside the class member is not set to G_TYPE_INVALID.
Creates the ClutterChildMeta wrapping actor inside the class member is not set to G_TYPE_INVALID. This function is only useful when adding a ClutterActor to a ClutterContainer implementation outside of the ClutterContainer::add() virtual function implementation. Applications should not call this function.
|
Clutter.Container | |
create_pango_context
()
:
Pango.Context
Creates a PangoContext for the given actor.
Creates a PangoContext for the given actor. The PangoContext is already configured using the appropriate font map, resolution and font options. See also clutter_actor_get_pango_context().
|
Clutter.Actor | |
create_pango_layout
(String text)
:
Pango.Layout
Creates a new PangoLayout from the same PangoContext used by the ClutterActor.
Creates a new PangoLayout from the same PangoContext used by the ClutterActor. The PangoLayout is already configured with the font map, resolution and font options, and the given text. If you want to keep around a PangoLayout created by this function you will have to connect to the ClutterBackend::font-changed and ClutterBackend::resolution-changed signals, and call pango_layout_context_changed() in response to them.
|
Clutter.Actor | |
destroy
()
:
none
Destroys an actor.
Destroys an actor. When an actor is destroyed, it will break any references it holds to other objects. If the actor is inside a container, the actor will be removed. When you destroy a container, its children will be destroyed as well. clutter_stage_get_default().
|
Clutter.Actor | |
destroy_child_meta
(Actor actor)
:
none
Destroys the ClutterChildMeta wrapping actor inside the This function is only useful when removing a ClutterActor to a ClutterContainer implementation outside of the ClutterContainer::add() virtual function implementation.
Destroys the ClutterChildMeta wrapping actor inside the This function is only useful when removing a ClutterActor to a ClutterContainer implementation outside of the ClutterContainer::add() virtual function implementation. Applications should not call this function.
|
Clutter.Container | |
ensure_current
()
:
none
This function essentially makes sure the right GL context is current for the passed stage.
This function essentially makes sure the right GL context is current for the passed stage. It is not intended to be used by applications.
|
Clutter.Stage | |
ensure_redraw
()
:
none
Ensures that stage is redrawn used when embedding a ClutterStage into a toolkit with another windowing system, like GTK+.
Ensures that stage is redrawn used when embedding a ClutterStage into a toolkit with another windowing system, like GTK+.
|
Clutter.Stage | |
ensure_viewport
()
:
none
Ensures that the GL viewport is updated with the current stage window size.
Ensures that the GL viewport is updated with the current stage window size. This function will queue a redraw of stage. This function should not be called by applications; it is used when embedding a ClutterStage into a toolkit with another windowing system, like GTK+.
|
Clutter.Stage | |
This function is used to emit an event on the main stage.
This function is used to emit an event on the main stage. You should rarely need to use this function, except for synthetised events.
|
Clutter.Stage | |
find_child_by_name
(String child_name)
:
Clutter.Actor
Finds a child actor of a container by its name.
Finds a child actor of a container by its name. Search recurses into any child container.
|
Clutter.Container | |
Calls callback for each child of container that was added by the application (with clutter_container_add_actor()).
Calls callback for each child of container that was added by the application (with clutter_container_add_actor()). Does not iterate over "internal" children that are part of the container's own implementation, if any.
|
Clutter.Container | |
Calls callback for each child of container, including "internal" children built in to the container itself that were never added by the application.
|
Clutter.Container | |
get_abs_allocation_vertices
()
:
Array
Calculates the transformed screen coordinates of the four corners of the actor; the returned vertices relate to the ClutterActorBox coordinates as follows:
Calculates the transformed screen coordinates of the four corners of the actor; the returned vertices relate to the ClutterActorBox coordinates as follows:
|
Clutter.Actor | |
Checks the scene at the coordinates x and y and returns a pointer to the ClutterActor at those coordinates.
Checks the scene at the coordinates x and y and returns a pointer to the ClutterActor at those coordinates. By using pick_mode it is possible to control which actors will be painted and thus available.
|
Clutter.Stage | |
get_allocation_box
()
:
Clutter.ActorBox
Gets the layout box an actor has been assigned.
Gets the layout box an actor has been assigned. The allocation can only be assumed valid inside a paint() method; anywhere else, it may be out-of-date. An allocation does not incorporate the actor's scale or anchor point; those transformations do not affect layout, only rendering.
|
Clutter.Actor | |
get_allocation_geometry
()
:
Clutter.Geometry
Gets the layout box an actor has been assigned.
Gets the layout box an actor has been assigned. The allocation can only be assumed valid inside a paint() method; anywhere else, it may be out-of-date. An allocation does not incorporate the actor's scale or anchor point; those transformations do not affect layout, only rendering. The returned rectangle is in pixels.
|
Clutter.Actor | |
Calculates the transformed coordinates of the four corners of the actor in the plane of ancestor.
Calculates the transformed coordinates of the four corners of the actor in the plane of ancestor. The returned vertices relate to the ClutterActorBox coordinates as follows:
|
Clutter.Actor | |
get_anchor_point
()
:
Object
|
Clutter.Actor | |
get_anchor_point_gravity
()
:
Clutter.Gravity
Retrieves the anchor position expressed as a ClutterGravity.
Retrieves the anchor position expressed as a ClutterGravity. If the anchor point was specified using pixels or units this will return CLUTTER_GRAVITY_NONE.
|
Clutter.Actor | |
get_animation
()
:
Clutter.Animation
Retrieves the ClutterAnimation used by actor, if clutter_actor_animate() has been called on actor.
Retrieves the ClutterAnimation used by actor, if clutter_actor_animate() has been called on actor.
|
Clutter.Actor | |
get_child_meta
(Actor actor)
:
Clutter.ChildMeta
Retrieves the ClutterChildMeta which contains the data about the
Retrieves the ClutterChildMeta which contains the data about the
|
Clutter.Container | |
get_children
()
:
Array
Retrieves all the children of container.
Retrieves all the children of container.
|
Clutter.Container | |
get_clip
()
:
Object
|
Clutter.Actor | |
get_color
(Color color)
:
none
Retrieves the stage color.
Retrieves the stage color.
|
Clutter.Stage | |
get_depth
()
:
Number
Retrieves the depth of self.
Retrieves the depth of self.
|
Clutter.Actor | |
get_fixed_position_set
()
:
Boolean
Checks whether an actor has a fixed position set (and will thus be unaffected by any layout manager).
Checks whether an actor has a fixed position set (and will thus be unaffected by any layout manager).
|
Clutter.Actor | |
get_flags
()
:
Clutter.ActorFlags
Retrieves the flags set on self
Retrieves the flags set on self
|
Clutter.Actor | |
get_fog
(Fog fog)
:
none
Retrieves the current depth cueing settings from the stage.
Retrieves the current depth cueing settings from the stage.
|
Clutter.Stage | |
get_fullscreen
()
:
Boolean
Retrieves whether the stage is full screen or not
Retrieves whether the stage is full screen or not
|
Clutter.Stage | |
get_geometry
()
:
Clutter.Geometry
Gets the size and position of an actor relative to its parent actor.
Gets the size and position of an actor relative to its parent actor. This is the same as calling clutter_actor_get_position() and clutter_actor_get_size(). It tries to "do what you mean" and get the requested size and position if the actor's allocation is invalid.
|
Clutter.Actor | |
get_gid
()
:
Number
Retrieves the unique id for self.
Retrieves the unique id for self.
|
Clutter.Actor | |
get_height
()
:
Number
Retrieves the height of a ClutterActor.
Retrieves the height of a ClutterActor. If the actor has a valid allocation, this function will return the height of the allocated area given to the actor. If the actor does not have a valid allocation, this function will return the actor's natural height, that is the preferred height of the actor. If you care whether you get the preferred height or the height that has been assigned to the actor, you should probably call a different function like clutter_actor_get_allocation_box() to retrieve the allocated size or clutter_actor_get_preferred_height() to retrieve the preferred height. If an actor has a fixed height, for instance a height that has been assigned using clutter_actor_set_height(), the height returned will be the same value.
|
Clutter.Actor | |
get_id
()
:
String
Retrieves the id of scriptable set using clutter_scriptable_set_id().
Retrieves the id of scriptable set using clutter_scriptable_set_id().
|
Clutter.Scriptable | |
get_key_focus
()
:
Clutter.Actor
Retrieves the actor that is currently under key focus.
Retrieves the actor that is currently under key focus.
|
Clutter.Stage | |
get_minimum_size
()
:
Object
Retrieves the minimum size for a stage window as set using clutter_stage_set_minimum_size().
|
Clutter.Stage | |
get_n_children
()
:
Number
Gets the number of actors held in the group.
Gets the number of actors held in the group.
|
Clutter.Group | |
get_name
()
:
String
Retrieves the name of self.
Retrieves the name of self.
|
Clutter.Actor | |
get_nth_child
(Number index_)
:
Clutter.Actor
Gets a groups child held at index_ in stack.
Gets a groups child held at index_ in stack.
|
Clutter.Group | |
get_opacity
()
:
Number
Retrieves the opacity value of an actor, as set by clutter_actor_set_opacity().
Retrieves the opacity value of an actor, as set by clutter_actor_set_opacity(). For retrieving the absolute opacity of the actor inside a paint virtual function, see clutter_actor_get_paint_opacity().
|
Clutter.Actor | |
get_paint_opacity
()
:
Number
Retrieves the absolute opacity of the actor, as it appears on the stage.
Retrieves the absolute opacity of the actor, as it appears on the stage. This function traverses the hierarchy chain and composites the opacity of the actor with that of its parents. This function is intended for subclasses to use in the paint virtual function, to paint themselves with the correct opacity.
|
Clutter.Actor | |
get_paint_visibility
()
:
Boolean
Retrieves the 'paint' visibility of an actor recursively checking for non visible parents.
Retrieves the 'paint' visibility of an actor recursively checking for non visible parents. This is by definition the same as CLUTTER_ACTOR_IS_MAPPED().
|
Clutter.Actor | |
get_pango_context
()
:
Pango.Context
Retrieves the PangoContext for self.
Retrieves the PangoContext for self. The actor's PangoContext is already configured using the appropriate font map, resolution and font options. Unlike clutter_actor_create_pango_context(), this context is owend by the ClutterActor and it will be updated each time the options stored by the ClutterBackend change. You can use the returned PangoContext to create a PangoLayout and render text using cogl_pango_render_layout() to reuse the glyphs cache also used by Clutter.
|
Clutter.Actor | |
get_parent
()
:
Clutter.Actor
Retrieves the parent of self.
Retrieves the parent of self.
|
Clutter.Actor | |
get_perspective
(Perspective perspective)
:
none
Retrieves the stage perspective.
Retrieves the stage perspective.
|
Clutter.Stage | |
get_position
()
:
Object
This function tries to "do what you mean" and tell you where the actor is, prior to any transformations.
This function tries to "do what you mean" and tell you where the actor is, prior to any transformations. Retrieves the fixed position of an actor in pixels, if one has been set; otherwise, if the allocation is valid, returns the actor's allocated position; otherwise, returns 0,0. The returned position is in pixels.
|
Clutter.Actor | |
Computes the requested minimum and natural heights for an actor, or if they are already computed, returns the cached values.
Computes the requested minimum and natural heights for an actor, or if they are already computed, returns the cached values. An actor may not get its request - depending on the layout manager that's in effect. A request should not incorporate the actor's scale or anchor point; those transformations do not affect layout, only rendering.
|
Clutter.Actor | |
get_preferred_size
()
:
Object
Computes the preferred minimum and natural size of an actor, taking into account the actor's geometry management (either height-for-width or width-for-height).
Computes the preferred minimum and natural size of an actor, taking into account the actor's geometry management (either height-for-width or width-for-height). The width and height used to compute the preferred height and preferred width are the actor's natural ones. If you need to control the height for the preferred width, or the width for the preferred height, you should use clutter_actor_get_preferred_width() and clutter_actor_get_preferred_height(), and check the actor's preferred geometry management using the ClutterActor:request-mode property.
|
Clutter.Actor | |
Computes the requested minimum and natural widths for an actor, optionally depending on the specified height, or if they are already computed, returns the cached values.
Computes the requested minimum and natural widths for an actor, optionally depending on the specified height, or if they are already computed, returns the cached values. An actor may not get its request - depending on the layout manager that's in effect. A request should not incorporate the actor's scale or anchor point; those transformations do not affect layout, only rendering.
|
Clutter.Actor | |
get_reactive
()
:
Boolean
Checks whether actor is marked as reactive.
Checks whether actor is marked as reactive.
|
Clutter.Actor | |
get_request_mode
()
:
Clutter.RequestMode
Retrieves the geometry request mode of self
Retrieves the geometry request mode of self
|
Clutter.Actor | |
Retrieves the angle and center of rotation on the given axis, set using clutter_actor_set_rotation().
|
Clutter.Actor | |
get_scale
()
:
Object
|
Clutter.Actor | |
get_scale_center
()
:
Object
Retrieves the scale center coordinate in pixels relative to the top left corner of the actor.
|
Clutter.Actor | |
get_scale_gravity
()
:
Clutter.Gravity
Retrieves the scale center as a compass direction.
Retrieves the scale center as a compass direction. If the scale center was specified in pixels or units this will return CLUTTER_GRAVITY_NONE.
|
Clutter.Actor | |
get_shader
()
:
Clutter.Shader
Queries the currently set ClutterShader on self.
Queries the currently set ClutterShader on self.
|
Clutter.Actor | |
get_size
()
:
Object
This function tries to "do what you mean" and return the size an actor will have.
This function tries to "do what you mean" and return the size an actor will have. If the actor has a valid allocation, the allocation will be returned; otherwise, the actors natural size request will be returned. If you care whether you get the request vs. the allocation, you should probably call a different function like clutter_actor_get_allocation_box() or clutter_actor_get_preferred_width().
|
Clutter.Actor | |
get_stage
()
:
Clutter.Actor
Retrieves the ClutterStage where actor is contained.
Retrieves the ClutterStage where actor is contained.
|
Clutter.Actor | |
get_text_direction
()
:
Clutter.TextDirection
Retrieves the value set using clutter_actor_set_text_direction() If no text direction has been previously set, the default text direction, as returned by clutter_get_default_text_direction(), will be returned instead
Retrieves the value set using clutter_actor_set_text_direction() If no text direction has been previously set, the default text direction, as returned by clutter_get_default_text_direction(), will be returned instead
|
Clutter.Actor | |
get_throttle_motion_events
()
:
Boolean
Retrieves the value set with clutter_stage_set_throttle_motion_events()
Retrieves the value set with clutter_stage_set_throttle_motion_events()
|
Clutter.Stage | |
get_title
()
:
String
|
Clutter.Stage | |
get_transformation_matrix
()
:
Cogl.Matrix
Retrieves the transformations applied to self
Retrieves the transformations applied to self
|
Clutter.Actor | |
get_transformed_position
()
:
Object
|
Clutter.Actor | |
get_transformed_size
()
:
Object
Gets the absolute size of an actor in pixels, taking into account the scaling factors.
Gets the absolute size of an actor in pixels, taking into account the scaling factors. If the actor has a valid allocation, the allocated size will be used. If the actor has not a valid allocation then the preferred size will be transformed and returned. If you want the transformed allocation, see clutter_actor_get_abs_allocation_vertices() instead.
|
Clutter.Actor | |
get_use_alpha
()
:
Boolean
Retrieves the value set using clutter_stage_set_use_alpha()
Retrieves the value set using clutter_stage_set_use_alpha()
|
Clutter.Stage | |
get_use_fog
()
:
Boolean
Gets whether the depth cueing effect is enabled on stage.
Gets whether the depth cueing effect is enabled on stage.
|
Clutter.Stage | |
get_user_resizable
()
:
Boolean
Retrieves the value set with clutter_stage_set_user_resizable().
Retrieves the value set with clutter_stage_set_user_resizable().
|
Clutter.Stage | |
get_width
()
:
Number
Retrieves the width of a ClutterActor.
Retrieves the width of a ClutterActor. If the actor has a valid allocation, this function will return the width of the allocated area given to the actor. If the actor does not have a valid allocation, this function will return the actor's natural width, that is the preferred width of the actor. If you care whether you get the preferred width or the width that has been assigned to the actor, you should probably call a different function like clutter_actor_get_allocation_box() to retrieve the allocated size or clutter_actor_get_preferred_width() to retrieve the preferred width. If an actor has a fixed width, for instance a width that has been assigned using clutter_actor_set_width(), the width returned will be the same value.
|
Clutter.Actor | |
get_x
()
:
Number
|
Clutter.Actor | |
get_y
()
:
Number
|
Clutter.Actor | |
get_z_rotation_gravity
()
:
Clutter.Gravity
Retrieves the center for the rotation around the Z axis as a compass direction.
Retrieves the center for the rotation around the Z axis as a compass direction. If the center was specified in pixels or units this will return CLUTTER_GRAVITY_NONE.
|
Clutter.Actor | |
grab_key_focus
()
:
none
Sets the key focus of the ClutterStage including self to this ClutterActor.
Sets the key focus of the ClutterStage including self to this ClutterActor.
|
Clutter.Actor | |
has_allocation
()
:
Boolean
Checks if the actor has an up-to-date allocation assigned to visible and has a parent.
Checks if the actor has an up-to-date allocation assigned to visible and has a parent. It also means that there is no outstanding relayout request in progress for the actor or its children (There might be other outstanding layout requests in progress that will cause the actor to get a new allocation when the stage is laid out, however). If this function returns FALSE, then the actor will normally be allocated before it is next drawn on the screen.
|
Clutter.Actor | |
has_clip
()
:
Boolean
Determines whether the actor has a clip area set or not.
Determines whether the actor has a clip area set or not.
|
Clutter.Actor | |
has_pointer
()
:
Boolean
Checks whether an actor contains the the pointer of a ClutterInputDevice
Checks whether an actor contains the the pointer of a ClutterInputDevice
|
Clutter.Actor | |
hide
()
:
none
Flags an actor to be hidden.
Flags an actor to be hidden. A hidden actor will not be rendered on the stage. Actors are visible by default. If this function is called on an actor without a parent, the ClutterActor:show-on-set-parent property will be set to FALSE as a side-effect.
|
Clutter.Actor | |
hide_all
()
:
none
Calls clutter_actor_hide() on all child actors (if any).
Calls clutter_actor_hide() on all child actors (if any).
|
Clutter.Actor | |
hide_cursor
()
:
none
Makes the cursor invisible on the stage window
Makes the cursor invisible on the stage window
|
Clutter.Stage | |
is_default
()
:
Boolean
Checks if stage is the default stage, or an instance created using clutter_stage_new() but internally using the same implementation.
Checks if stage is the default stage, or an instance created using clutter_stage_new() but internally using the same implementation.
|
Clutter.Stage | |
is_in_clone_paint
()
:
Boolean
Checks whether self is being currently painted by a ClutterClone This function is useful only inside the ::paint virtual function implementations or within handlers for the ClutterActor::paint signal This function should not be used by applications
Checks whether self is being currently painted by a ClutterClone This function is useful only inside the ::paint virtual function implementations or within handlers for the ClutterActor::paint signal This function should not be used by applications
|
Clutter.Actor | |
is_rotated
()
:
Boolean
Checks whether any rotation is applied to the actor.
Checks whether any rotation is applied to the actor.
|
Clutter.Actor | |
is_scaled
()
:
Boolean
Checks whether the actor is scaled in either dimension.
Checks whether the actor is scaled in either dimension.
|
Clutter.Actor | |
lower
(Actor above)
:
none
Puts self below above.
Puts self below above. Both actors must have the same parent, and the parent must implement the ClutterContainer interface. This function is the equivalent of clutter_container_lower_child().
|
Clutter.Actor | |
lower_bottom
()
:
none
Lowers self to the bottom.
Lowers self to the bottom. This function calls clutter_actor_lower() internally.
|
Clutter.Actor | |
Lowers actor to sibling level, in the depth ordering.
Lowers actor to sibling level, in the depth ordering.
|
Clutter.Container | |
map
()
:
none
Sets the CLUTTER_ACTOR_MAPPED flag on the actor and possibly maps and realizes its children if they are visible.
Sets the CLUTTER_ACTOR_MAPPED flag on the actor and possibly maps and realizes its children if they are visible. Does nothing if the actor is not visible. ClutterActor::map virtual function in an actor and you need to map the children of that actor. It is not necessary to call this if you implement ClutterContainer because the default implementation will automatically map children of containers. When overriding map, it is mandatory to chain up to the parent implementation.
|
Clutter.Actor | |
Sets an anchor point for the actor, and adjusts the actor postion so that the relative position of the actor toward its parent remains the same.
|
Clutter.Actor | |
move_anchor_point_from_gravity
(Gravity gravity)
:
none
Sets an anchor point on the actor based on the given gravity, adjusting the actor postion so that its relative position within its parent remains unchanged.
Sets an anchor point on the actor based on the given gravity, adjusting the actor postion so that its relative position within its parent remains unchanged. Since version 1.0 the anchor point will be stored as a gravity so that if the actor changes size then the anchor point will move. For example, if you set the anchor point to CLUTTER_GRAVITY_SOUTH_EAST and later double the size of the actor, the anchor point will move to the bottom right.
|
Clutter.Actor | |
Moves an actor by the specified distance relative to its current position in pixels.
Moves an actor by the specified distance relative to its current position in pixels. This function modifies the fixed position of an actor and thus removes it from any layout management. Another way to move an actor is with an anchor point, see clutter_actor_set_anchor_point().
|
Clutter.Actor | |
paint
()
:
none
Renders the actor to display.
Renders the actor to display. This function should not be called directly by applications. Call clutter_actor_queue_redraw() to queue paints, instead. This function will emit the ClutterActor::paint signal.
|
Clutter.Actor | |
Parses the passed JSON node.
Parses the passed JSON node. The implementation must set the type of the passed GValue pointer using g_value_init().
|
Clutter.Scriptable | |
pop_internal
()
:
none
Disables the effects of clutter_actor_pop_internal()
Disables the effects of clutter_actor_pop_internal()
|
Clutter.Actor | |
push_internal
()
:
none
Should be used by actors implementing the ClutterContainer and with internal children added through clutter_actor_set_parent(), for instance: |[ static void my_actor_init (MyActor *self) { self->priv = SELF_ACTOR_GET_PRIVATE (self); clutter_actor_push_internal (CLUTTER_ACTOR (self)); /* calling clutter_actor_set_parent() now will result in * the internal flag being set on a child of MyActor */ clutter_actor_pop_internal (CLUTTER_ACTOR (self)); /* calling clutter_actor_set_parent() now will not result in * the internal flag being set on a child of MyActor */ } ]| This function will be used by Clutter to toggle an "internal child" flag whenever clutter_actor_set_parent() is called; internal children are handled differently by Clutter, specifically when destroying their parent.
Should be used by actors implementing the ClutterContainer and with internal children added through clutter_actor_set_parent(), for instance: |[ static void my_actor_init (MyActor *self) { self->priv = SELF_ACTOR_GET_PRIVATE (self); clutter_actor_push_internal (CLUTTER_ACTOR (self)); /* calling clutter_actor_set_parent() now will result in * the internal flag being set on a child of MyActor */ clutter_actor_pop_internal (CLUTTER_ACTOR (self)); /* calling clutter_actor_set_parent() now will not result in * the internal flag being set on a child of MyActor */ } ]| This function will be used by Clutter to toggle an "internal child" flag whenever clutter_actor_set_parent() is called; internal children are handled differently by Clutter, specifically when destroying their parent. Call clutter_actor_pop_internal() when you finished adding internal children. Nested calls to clutter_actor_push_internal() are allowed, but each one must by followed by a clutter_actor_pop_internal() call.
|
Clutter.Actor | |
queue_redraw
()
:
none
Queues a redraw for the passed stage.
Queues a redraw for the passed stage.
|
Clutter.Stage | |
queue_relayout
()
:
none
Indicates that the actor's size request or other layout-affecting properties may have changed.
Indicates that the actor's size request or other layout-affecting properties may have changed. This function is used inside ClutterActor subclass implementations, not by applications directly. Queueing a new layout automatically queues a redraw as well.
|
Clutter.Actor | |
raise
(Actor below)
:
none
Puts self above below.
Puts self above below. Both actors must have the same parent, and the parent must implement the ClutterContainer interface This function is the equivalent of clutter_container_raise_child().
|
Clutter.Actor | |
Raises actor to sibling level, in the depth ordering.
Raises actor to sibling level, in the depth ordering.
|
Clutter.Container | |
raise_top
()
:
none
Raises self to the top.
Raises self to the top. This function calls clutter_actor_raise() internally.
|
Clutter.Actor | |
Makes a screenshot of the stage in RGBA 8bit data, returns a linear buffer with width * 4 as rowstride.
Makes a screenshot of the stage in RGBA 8bit data, returns a linear buffer with width * 4 as rowstride. The alpha data contained in the returned buffer is driver-dependent, and not guaranteed to hold any sensible value.
|
Clutter.Stage | |
realize
()
:
none
Realization informs the actor that it is attached to a stage.
Realization informs the actor that it is attached to a stage. It can use this to allocate resources if it wanted to delay allocation until it would be rendered. However it is perfectly acceptable for an actor to create resources before being realized because Clutter only ever has a single rendering context so that actor is free to be moved from one stage to another. This function does nothing if the actor is already realized. Because a realized actor must have realized parent actors, calling clutter_actor_realize() will also realize all parents of the actor. This function does not realize child actors, except in the special case that realizing the stage, when the stage is visible, will suddenly map (and thus realize) the children of the stage.
|
Clutter.Actor | |
remove_actor
(Actor actor)
:
none
Removes actor from container.
Removes actor from container. The actor should be unparented, so if you want to keep it around you must hold a reference to it yourself, using g_object_ref(). When the actor has been removed, the "actor-removed" signal is emitted by container.
|
Clutter.Container | |
remove_all
()
:
none
Removes all children actors from the ClutterGroup.
Removes all children actors from the ClutterGroup.
|
Clutter.Group | |
remove_clip
()
:
none
|
Clutter.Actor | |
reparent
(Actor new_parent)
:
none
This function resets the parent actor of self.
This function resets the parent actor of self. It is logically equivalent to calling clutter_actor_unparent() and clutter_actor_set_parent(), but more efficiently implemented, ensures the child is not finalized when unparented, and emits the parent-set signal only one time.
|
Clutter.Actor | |
Sets an anchor point for self.
Sets an anchor point for self. The anchor point is a point in the coordinate space of an actor to which the actor position within its parent is relative; the default is (0, 0), i.e. the top-left corner of the actor.
|
Clutter.Actor | |
set_anchor_point_from_gravity
(Gravity gravity)
:
none
Sets an anchor point on the actor, based on the given gravity (this is a convenience function wrapping clutter_actor_set_anchor_point()).
Sets an anchor point on the actor, based on the given gravity (this is a convenience function wrapping clutter_actor_set_anchor_point()). Since version 1.0 the anchor point will be stored as a gravity so that if the actor changes size then the anchor point will move. For example, if you set the anchor point to CLUTTER_GRAVITY_SOUTH_EAST and later double the size of the actor, the anchor point will move to the bottom right.
|
Clutter.Actor | |
Sets clip area for self.
|
Clutter.Actor | |
set_color
(Color color)
:
none
Sets the stage color.
Sets the stage color.
|
Clutter.Stage | |
Overrides the common properties setting.
Overrides the common properties setting. The underlying virtual function should be used when implementing custom properties.
|
Clutter.Scriptable | |
set_depth
(Number depth)
:
none
Sets the Z coordinate of self to depth.
Sets the Z coordinate of self to depth. The unit used by depth is dependant on the perspective setup. See also clutter_stage_set_perspective().
|
Clutter.Actor | |
set_fixed_position_set
(Boolean is_set)
:
none
Sets whether an actor has a fixed position set (and will thus be unaffected by any layout manager).
Sets whether an actor has a fixed position set (and will thus be unaffected by any layout manager).
|
Clutter.Actor | |
set_flags
(ActorFlags flags)
:
none
Sets flags on self This function will emit notifications for the changed properties
Sets flags on self This function will emit notifications for the changed properties
|
Clutter.Actor | |
set_fog
(Fog fog)
:
none
Sets the fog (also known as "depth cueing") settings for the stage.
Sets the fog (also known as "depth cueing") settings for the stage. A ClutterStage will only use a linear fog progression, which depends solely on the distance from the viewer. The cogl_set_fog() function in COGL exposes more of the underlying implementation, and allows changing the for progression function. It can be directly used by disabling the ClutterStage:use-fog property and connecting a signal handler to the ClutterActor::paint signal on the stage, like: |[ clutter_stage_set_use_fog (stage, FALSE); g_signal_connect (stage, "paint", G_CALLBACK (on_stage_paint), NULL); ]| The paint signal handler will call cogl_set_fog() with the desired settings: |[ static void on_stage_paint (ClutterActor *actor) { ClutterColor stage_color = { 0, }; CoglColor fog_color = { 0, }; /* set the fog color to the stage background color */ clutter_stage_get_color (CLUTTER_STAGE (actor), &stage_color); cogl_color_set_from_4ub (&fog_color, stage_color.red, stage_color.green, stage_color.blue, stage_color.alpha); /* enable fog */ cogl_set_fog (&fog_color, COGL_FOG_MODE_EXPONENTIAL, /* mode */ 0.5, /* density */ 5.0, 30.0); /* z_near and z_far */ } ]| We can look to improve this in the future when we can depend on fragment shaders.
|
Clutter.Stage | |
set_fullscreen
(Boolean fullscreen)
:
none
Asks to place the stage window in the fullscreen or unfullscreen states.
Asks to place the stage window in the fullscreen or unfullscreen states. Note that you shouldn't assume the window is definitely full screen afterward, because other entities (e.g. the user or window manager) could unfullscreen it again, and not all window managers honor requests to fullscreen windows. If you want to receive notification of the fullscreen state you should either use the ClutterStage::fullscreen and ClutterStage::unfullscreen signals, or use the notify signal for the ClutterStage:fullscreen-set property
|
Clutter.Stage | |
set_geometry
(Geometry geometry)
:
none
Sets the actor's fixed position and forces its minimum and natural size, in pixels.
Sets the actor's fixed position and forces its minimum and natural size, in pixels. This means the untransformed actor will have the given geometry. This is the same as calling clutter_actor_set_position() and clutter_actor_set_size().
|
Clutter.Actor | |
set_height
(Number height)
:
none
|
Clutter.Actor | |
set_id
(String id)
:
none
Sets id as the unique Clutter script it for this instance of ClutterScriptableIface.
Sets id as the unique Clutter script it for this instance of ClutterScriptableIface. This name can be used by user interface designer applications to define a unique name for an object constructable using the UI definition language parsed by ClutterScript.
|
Clutter.Scriptable | |
set_key_focus
(Actor actor)
:
none
Sets the key focus on actor.
Sets the key focus on actor. An actor with key focus will receive all the key events. If actor is NULL, the stage will receive focus.
|
Clutter.Stage | |
Sets the minimum size for a stage window, if the default backend uses ClutterStage inside a window This is a convenience function, and it is equivalent to setting the ClutterActor:min-width and ClutterActor:min-height on stage If the current size of stage is smaller than the minimum size, the This function has no effect if stage is fullscreen
Sets the minimum size for a stage window, if the default backend uses ClutterStage inside a window This is a convenience function, and it is equivalent to setting the ClutterActor:min-width and ClutterActor:min-height on stage If the current size of stage is smaller than the minimum size, the This function has no effect if stage is fullscreen
|
Clutter.Stage | |
set_name
(String name)
:
none
Sets the given name to self.
Sets the given name to self. The name can be used to identify a ClutterActor.
|
Clutter.Actor | |
set_opacity
(Number opacity)
:
none
Sets the actor's opacity, with zero being completely transparent and 255 (0xff) being fully opaque.
Sets the actor's opacity, with zero being completely transparent and 255 (0xff) being fully opaque.
|
Clutter.Actor | |
set_parent
(Actor parent)
:
none
Sets the parent of self to parent.
Sets the parent of self to parent. The opposite function is clutter_actor_unparent(). This function should not be used by applications, but by custom container actor subclasses.
|
Clutter.Actor | |
set_perspective
(Perspective perspective)
:
none
Sets the stage perspective.
Sets the stage perspective.
|
Clutter.Stage | |
Clutter.Actor | ||
set_reactive
(Boolean reactive)
:
none
Sets actor as reactive.
Sets actor as reactive. Reactive actors will receive events.
|
Clutter.Actor | |
set_request_mode
(RequestMode mode)
:
none
Sets the geometry request mode of self.
Sets the geometry request mode of self. The mode determines the order for invoking clutter_actor_get_preferred_width() and clutter_actor_get_preferred_height()
|
Clutter.Actor | |
Sets the rotation angle of self around the given axis.
Sets the rotation angle of self around the given axis. The rotation center coordinates used depend on the value of axis:
|
Clutter.Actor | |
Scales an actor with the given factors.
|
Clutter.Actor | |
Scales an actor with the given factors around the given center point.
Scales an actor with the given factors around the given center point. The center point is specified in pixels relative to the anchor point (usually the top left corner of the actor).
|
Clutter.Actor | |
direction.
direction. Scales an actor with the given factors around the given center point. The center point is specified as one of the compass directions in ClutterGravity. For example, setting it to north will cause the top of the actor to remain unchanged and the rest of the actor to expand left, right and downwards.
|
Clutter.Actor | |
Sets the ClutterShader to be used when rendering self.
Sets the ClutterShader to be used when rendering self. If shader is NULL it will unset any currently set shader for the actor.
|
Clutter.Actor | |
Sets the value for a named parameter of the shader applied to actor.
Sets the value for a named parameter of the shader applied to actor.
|
Clutter.Actor | |
Clutter.Actor | ||
Clutter.Actor | ||
Clutter.Actor | ||
set_text_direction
(TextDirection text_dir)
:
none
Sets the ClutterTextDirection for an actor The passed text direction must not be CLUTTER_TEXT_DIRECTION_DEFAULT If self implements ClutterContainer then this function will recurse inside all the children of self (including the internal ones).
Sets the ClutterTextDirection for an actor The passed text direction must not be CLUTTER_TEXT_DIRECTION_DEFAULT If self implements ClutterContainer then this function will recurse inside all the children of self (including the internal ones). Composite actors not implementing ClutterContainer, or actors requiring special handling when the text direction changes, should connect to the GObject::notify signal for the ClutterActor:text-direction property
|
Clutter.Actor | |
set_throttle_motion_events
(Boolean throttle)
:
none
Sets whether motion events received between redraws should be throttled or not.
Sets whether motion events received between redraws should be throttled or not. If motion events are throttled, those events received by the windowing system between redraws will be compressed so that only the last event will be propagated to the stage and its actors. This function should only be used if you want to have all the motion events delivered to your application code.
|
Clutter.Stage | |
set_title
(String title)
:
none
|
Clutter.Stage | |
set_use_alpha
(Boolean use_alpha)
:
none
Sets whether the stage should honour the ClutterActor:opacity and the alpha channel of the ClutterStage:color
Sets whether the stage should honour the ClutterActor:opacity and the alpha channel of the ClutterStage:color
|
Clutter.Stage | |
set_use_fog
(Boolean fog)
:
none
Sets whether the depth cueing effect on the stage should be enabled or not.
Sets whether the depth cueing effect on the stage should be enabled or not. Depth cueing is a 3D effect that makes actors farther away from the viewing point less opaque, by fading them with the stage color. The parameters of the GL fog used can be changed using the clutter_stage_set_fog() function.
|
Clutter.Stage | |
set_user_resizable
(Boolean resizable)
:
none
Sets if the stage is resizable by user interaction (e.g.
Sets if the stage is resizable by user interaction (e.g. via window manager controls)
|
Clutter.Stage | |
set_width
(Number width)
:
none
|
Clutter.Actor | |
set_x
(Number x)
:
none
Sets the actor's X coordinate, relative to its parent, in pixels.
Sets the actor's X coordinate, relative to its parent, in pixels. Overrides any layout manager and forces a fixed position for the actor.
|
Clutter.Actor | |
set_y
(Number y)
:
none
Sets the actor's Y coordinate, relative to its parent, in pixels.
Sets the actor's Y coordinate, relative to its parent, in pixels.# Overrides any layout manager and forces a fixed position for the actor.
|
Clutter.Actor | |
Sets the rotation angle of self around the Z axis using the center point specified as a compass point.
Sets the rotation angle of self around the Z axis using the center point specified as a compass point. For example to rotate such that the center of the actor remains static you can use CLUTTER_GRAVITY_CENTER. If the actor changes size the center point will move accordingly.
|
Clutter.Actor | |
should_pick_paint
()
:
Boolean
Should be called inside the implementation of the ClutterActor::pick virtual function in order to check whether the actor should paint itself in pick mode or not.
Should be called inside the implementation of the ClutterActor::pick virtual function in order to check whether the actor should paint itself in pick mode or not. This function should never be called directly by applications.
|
Clutter.Actor | |
show
()
:
none
Flags an actor to be displayed.
Flags an actor to be displayed. An actor that isn't shown will not be rendered on the stage. Actors are visible by default. If this function is called on an actor without a parent, the ClutterActor:show-on-set-parent will be set to TRUE as a side effect.
|
Clutter.Actor | |
show_all
()
:
none
Calls clutter_actor_show() on all children of an actor (if any).
Calls clutter_actor_show() on all children of an actor (if any).
|
Clutter.Actor | |
show_cursor
()
:
none
Shows the cursor on the stage window
Shows the cursor on the stage window
|
Clutter.Stage | |
sort_depth_order
()
:
none
Sorts a container's children using their depth.
Sorts a container's children using their depth. This function should not be normally used by applications.
|
Clutter.Container | |
Clutter.Actor | ||
unmap
()
:
none
Unsets the CLUTTER_ACTOR_MAPPED flag on the actor and possibly unmaps its children if they were mapped.
Unsets the CLUTTER_ACTOR_MAPPED flag on the actor and possibly unmaps its children if they were mapped. ClutterActor::unmap virtual function in an actor and you need to unmap the children of that actor. It is not necessary to call this if you implement ClutterContainer because the default implementation will automatically unmap children of containers. When overriding unmap, it is mandatory to chain up to the parent implementation.
|
Clutter.Actor | |
unparent
()
:
none
Removes the parent of self.
Removes the parent of self. This function should not be used in applications. It should be called by implementations of container actors, to dissociate a child from the container.
|
Clutter.Actor | |
unrealize
()
:
none
Unrealization informs the actor that it may be being destroyed or moved to another stage.
Unrealization informs the actor that it may be being destroyed or moved to another stage. The actor may want to destroy any underlying graphics resources at this point. However it is perfectly acceptable for it to retain the resources until the actor is destroyed because Clutter only ever uses a single rendering context and all of the graphics resources are valid on any stage. Because mapped actors must be realized, actors may not be unrealized if they are mapped. This function hides the actor to be sure it isn't mapped, an application-visible side effect that you may not be expecting. This function should not really be in the public API, because there isn't a good reason to call it. ClutterActor will already unrealize things for you when it's important to do so. If you were using clutter_actor_unrealize() in a dispose implementation, then don't, just chain up to ClutterActor's dispose. If you were using clutter_actor_unrealize() to implement unrealizing children of your container, then don't, ClutterActor will already take care of that. If you were using clutter_actor_unrealize() to re-realize to create your resources in a different way, then use _clutter_actor_rerealize() (inside Clutter) or just call your code that recreates your resources directly (outside Clutter).
|
Clutter.Actor | |
unset_flags
(ActorFlags flags)
:
none
Unsets flags on self This function will emit notifications for the changed properties
Unsets flags on self This function will emit notifications for the changed properties
|
Clutter.Actor |
Event | Defined By | |
---|---|---|
activate (Stage self)
:
none
|
Clutter.Stage | |
The ::actor-added signal is emitted each time an actor has been added to container.
The ::actor-added signal is emitted each time an actor has been added to container.
|
Clutter.Container | |
The ::actor-removed signal is emitted each time an actor is removed from container.
The ::actor-removed signal is emitted each time an actor is removed from container.
|
Clutter.Container | |
The ::allocation-changed signal is emitted when the ClutterActor:allocation property changes.
The ::allocation-changed signal is emitted when the ClutterActor:allocation property changes. Usually, application code should just use the notifications for the :allocation property but if you want to track the allocation flags as well, for instance to know whether the absolute origin of actor changed, then you might want use this signal instead.
|
Clutter.Actor | |
The ::button-press-event signal is emitted each time a mouse button is pressed on actor.
The ::button-press-event signal is emitted each time a mouse button is pressed on actor.
|
Clutter.Actor | |
The ::button-release-event signal is emitted each time a mouse button is released on actor.
The ::button-release-event signal is emitted each time a mouse button is released on actor.
|
Clutter.Actor | |
The ::captured-event signal is emitted when an event is captured by Clutter.
The ::captured-event signal is emitted when an event is captured by Clutter. This signal will be emitted starting from the top-level container (the ClutterStage) to the actor which received the event going down the hierarchy. This signal can be used to intercept every event before the specialized events (like ClutterActor::button-press-event or ::key-released-event) are emitted.
|
Clutter.Actor | |
The ::child-notify signal is emitted each time a property is being set through the clutter_container_child_set() and clutter_container_child_set_property() calls.
The ::child-notify signal is emitted each time a property is being set through the clutter_container_child_set() and clutter_container_child_set_property() calls.
|
Clutter.Container | |
deactivate (Stage self)
:
none
|
Clutter.Stage | |
The ::delete-event signal is emitted when the user closes a ClutterStage window using the window controls.
The ::delete-event signal is emitted when the user closes a ClutterStage window using the window controls. Clutter by default will call clutter_main_quit() if stage is the default stage, and clutter_actor_destroy() for any other stage. It is possible to override the default behaviour by connecting a new handler and returning TRUE there.
|
Clutter.Stage | |
destroy (Actor self)
:
none
The ::destroy signal is emitted when an actor is destroyed, either by direct invocation of clutter_actor_destroy() or when the ClutterGroup that contains the actor is destroyed.
The ::destroy signal is emitted when an actor is destroyed, either by direct invocation of clutter_actor_destroy() or when the ClutterGroup that contains the actor is destroyed.
|
Clutter.Actor | |
The ::enter-event signal is emitted when the pointer enters the actor
The ::enter-event signal is emitted when the pointer enters the actor
|
Clutter.Actor | |
The ::event signal is emitted each time an event is received by the actor.
The ::event signal is emitted each time an event is received by the actor. This signal will be emitted on every actor, following the hierarchy chain, until it reaches the top-level container (the ClutterStage).
|
Clutter.Actor | |
fullscreen (Stage self)
:
none
|
Clutter.Stage | |
hide (Actor self)
:
none
The ::hide signal is emitted when an actor is no longer rendered on the stage.
The ::hide signal is emitted when an actor is no longer rendered on the stage.
|
Clutter.Actor | |
key_focus_in (Actor self)
:
none
The ::focus-in signal is emitted when actor recieves key focus.
The ::focus-in signal is emitted when actor recieves key focus.
|
Clutter.Actor | |
key_focus_out (Actor self)
:
none
The ::key-focus-out signal is emitted when actor loses key focus.
The ::key-focus-out signal is emitted when actor loses key focus.
|
Clutter.Actor | |
The ::key-press-event signal is emitted each time a keyboard button is pressed while actor has key focus (see clutter_stage_set_key_focus()).
The ::key-press-event signal is emitted each time a keyboard button is pressed while actor has key focus (see clutter_stage_set_key_focus()).
|
Clutter.Actor | |
The ::key-release-event signal is emitted each time a keyboard button is released while actor has key focus (see clutter_stage_set_key_focus()).
The ::key-release-event signal is emitted each time a keyboard button is released while actor has key focus (see clutter_stage_set_key_focus()).
|
Clutter.Actor | |
The ::leave-event signal is emitted when the pointer leaves the actor.
The ::leave-event signal is emitted when the pointer leaves the actor.
|
Clutter.Actor | |
The ::motion-event signal is emitted each time the mouse pointer is moved over actor.
The ::motion-event signal is emitted each time the mouse pointer is moved over actor.
|
Clutter.Actor | |
paint (Actor self)
:
none
The ::paint signal is emitted each time an actor is being painted.
The ::paint signal is emitted each time an actor is being painted. Subclasses of ClutterActor should override the class signal handler and paint themselves in that function. It is possible to connect a handler to the ::paint signal in order to set up some custom aspect of a paint.
|
Clutter.Actor | |
This signal is emitted when the parent of the actor changes.
This signal is emitted when the parent of the actor changes.
|
Clutter.Actor | |
The ::pick signal is emitted each time an actor is being painted in "pick mode".
The ::pick signal is emitted each time an actor is being painted in "pick mode". The pick mode is used to identify the actor during the event handling phase, or by clutter_stage_get_actor_at_pos(). The actor should paint its shape using the passed pick_color. Subclasses of ClutterActor should override the class signal handler and paint themselves in that function. It is possible to connect a handler to the ::pick signal in order to set up some custom aspect of a paint in pick mode.
|
Clutter.Actor | |
The ::queue_redraw signal is emitted when clutter_actor_queue_redraw() is called on origin.
The ::queue_redraw signal is emitted when clutter_actor_queue_redraw() is called on origin. The default implementation for ClutterActor chains up to the parent actor and queues a redraw on the parent, thus "bubbling" the redraw queue up through the actor graph. The default implementation for ClutterStage queues a clutter_redraw() in a main loop idle handler. Note that the origin actor may be the stage, or a container; it does not have to be a leaf node in the actor graph. Toolkits embedding a ClutterStage which require a redraw and relayout cycle can stop the emission of this signal using the GSignal API, redraw the UI and then call clutter_redraw() themselves, like: |[ static void on_redraw_complete (void) { /* execute the Clutter drawing pipeline */ clutter_redraw (); } static void on_stage_queue_redraw (ClutterStage *stage) { /* this prevents the default handler to run */ g_signal_stop_emission_by_name (stage, "queue-redraw"); /* queue a redraw with the host toolkit and call * a function when the redraw has been completed */ queue_a_redraw (G_CALLBACK (on_redraw_complete)); } ]|
|
Clutter.Actor | |
queue_relayout (Actor self)
:
none
|
Clutter.Actor | |
realize (Actor self)
:
none
The ::realize signal is emitted each time an actor is being realized.
The ::realize signal is emitted each time an actor is being realized.
|
Clutter.Actor | |
The ::scroll-event signal is emitted each time the mouse is scrolled on actor
The ::scroll-event signal is emitted each time the mouse is scrolled on actor
|
Clutter.Actor | |
show (Actor self)
:
none
The ::show signal is emitted when an actor is visible and rendered on the stage.
The ::show signal is emitted when an actor is visible and rendered on the stage.
|
Clutter.Actor | |
unfullscreen (Stage self)
:
none
|
Clutter.Stage | |
unrealize (Actor self)
:
none
The ::unrealize signal is emitted each time an actor is being unrealized.
The ::unrealize signal is emitted each time an actor is being unrealized.
|
Clutter.Actor |
Class / Namespace | Method / Signal / Properties |
---|---|
Clutter
Method |
Clutter.redraw
(Stage stage)
:
none
Forces a redraw of the entire stage.
|
Clutter.Event
Method |
get_stage
()
:
Clutter.Stage
Retrieves the source ClutterStage the event originated for, or NULL if the event has no stage.
|
Clutter.InputDevice
Method |
get_pointer_stage
()
:
Clutter.Stage
Retrieves the ClutterStage underneath the pointer of device
|
Clutter.StageManager
Property |
default_stage : Clutter.Stage
read only
The default stage used by Clutter.
|
Clutter.StageManager
Signal |
stage_added
(StageManager self, Stage stage)
:
none
The ::stage-added signal is emitted each time a new ClutterStage has been added to the stage manager.
|
Clutter.StageManager
Signal |
stage_removed
(StageManager self, Stage stage)
:
none
The ::stage-removed signal is emitted each time a ClutterStage has been removed from the stage manager.
|
Clutter.StageManager
Method |
get_default_stage
()
:
Clutter.Stage
Returns the default ClutterStage.
|
Clutter.StageManager
Method |
set_default_stage
(Stage stage)
:
none
Sets stage as the default stage.
|