ClutterBehaviourDepth

ClutterBehaviourDepth — A behaviour controlling the Z position

Synopsis

                    ClutterBehaviourDepth;
                    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

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

ClutterBehaviourDepth

typedef struct _ClutterBehaviourDepth ClutterBehaviourDepth;

ClutterBehaviourDepthClass

typedef struct {
  ClutterBehaviourClass parent_class;
} ClutterBehaviourDepthClass;

clutter_behaviour_depth_new ()

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

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

alpha :

 a ClutterAlpha or NULL

depth_start :

 initial value of the depth

depth_end :

 final value of the depth

Returns :

 the newly created behaviour

Since 0.4

clutter_behaviour_depth_set_bounds ()

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

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);

Gets the boundaries of the behaviour

behaviour :

 a ClutterBehaviourDepth

depth_start :

 return location for the initial depth value, or NULL

depth_end :

 return location for the final depth value, or NULL

Since 0.6

Property Details

The "depth-end" property

  "depth-end"                gint                  : Read / Write

End depth level to apply to the actors.

Default value: 0

Since 0.4

The "depth-start" property

  "depth-start"              gint                  : Read / Write

Start depth level to apply to the actors.

Default value: 0

Since 0.4

Generated by GTK-Doc V1.10