ClutterBehaviourDepth

ClutterBehaviourDepth — A behaviour controlling the Z position

Synopsis

struct              ClutterBehaviourDepth;
struct              ClutterBehaviourDepthClass;
ClutterBehaviour *  clutter_behaviour_depth_new         (ClutterAlpha *alpha,
                                                         gint depth_start,
                                                         gint depth_end);
void                clutter_behaviour_depth_set_bounds  (ClutterBehaviourDepth *behaviour,
                                                         gint depth_start,
                                                         gint depth_end);
void                clutter_behaviour_depth_get_bounds  (ClutterBehaviourDepth *behaviour,
                                                         gint *depth_start,
                                                         gint *depth_end);

Object Hierarchy

  GObject
   +----ClutterBehaviour
         +----ClutterBehaviourDepth

Implemented Interfaces

ClutterBehaviourDepth implements ClutterScriptable.

Properties

  "depth-end"                gint                  : Read / Write
  "depth-start"              gint                  : Read / Write

Description

ClutterBehaviourDepth is a simple ClutterBehaviour controlling the depth of a set of actors between a start and end depth.

ClutterBehaviourDepth is available since Clutter 0.4.

Details

struct ClutterBehaviourDepth

struct ClutterBehaviourDepth;

Warning

ClutterBehaviourDepth has been deprecated since version 1.6 and should not be used in newly-written code. Use clutter_actor_animate() with "depth" instead.

The ClutterBehaviourDepth structure contains only private data and should be accessed using the provided API

Since 0.2

struct ClutterBehaviourDepthClass

struct ClutterBehaviourDepthClass {
};

Warning

ClutterBehaviourDepthClass is deprecated and should not be used in newly-written code. 1.6

The ClutterBehaviourDepthClass structure contains only private data

Since 0.2

clutter_behaviour_depth_new ()

ClutterBehaviour *  clutter_behaviour_depth_new         (ClutterAlpha *alpha,
                                                         gint depth_start,
                                                         gint depth_end);

Warning

clutter_behaviour_depth_new is deprecated and should not be used in newly-written code. 1.6

Creates a new ClutterBehaviourDepth which can be used to control the ClutterActor:depth property of a set of ClutterActors.

If alpha is not NULL, the ClutterBehaviour will take ownership of the ClutterAlpha instance. In the case when alpha is NULL, it can be set later with clutter_behaviour_set_alpha().

alpha :

 a ClutterAlpha instance, or NULL. [allow-none]

depth_start :

 initial value of the depth

depth_end :

 final value of the depth

Returns :

 the newly created behaviour. [transfer full]

Since 0.4

clutter_behaviour_depth_set_bounds ()

void                clutter_behaviour_depth_set_bounds  (ClutterBehaviourDepth *behaviour,
                                                         gint depth_start,
                                                         gint depth_end);

Warning

clutter_behaviour_depth_set_bounds is deprecated and should not be used in newly-written code. 1.6

Sets the boundaries of the behaviour.

behaviour :

 a ClutterBehaviourDepth

depth_start :

 initial value of the depth

depth_end :

 final value of the depth

Since 0.6

clutter_behaviour_depth_get_bounds ()

void                clutter_behaviour_depth_get_bounds  (ClutterBehaviourDepth *behaviour,
                                                         gint *depth_start,
                                                         gint *depth_end);

Warning

clutter_behaviour_depth_get_bounds is deprecated and should not be used in newly-written code. 1.6

Gets the boundaries of the behaviour

behaviour :

 a ClutterBehaviourDepth

depth_start :

 return location for the initial depth value, or NULL. [out]

depth_end :

 return location for the final depth value, or NULL. [out]

Since 0.6

Property Details

The "depth-end" property

  "depth-end"                gint                  : Read / Write

Warning

ClutterBehaviourDepth:depth-end is deprecated and should not be used in newly-written code. 1.6

End depth level to apply to the actors.

Default value: 0

Since 0.4

The "depth-start" property

  "depth-start"              gint                  : Read / Write

Warning

ClutterBehaviourDepth:depth-start is deprecated and should not be used in newly-written code. 1.6

Start depth level to apply to the actors.

Default value: 0

Since 0.4

Generated by GTK-Doc V1.18.1