2006-05-29 08:59:36 +00:00
|
|
|
/*
|
|
|
|
|
* Clutter.
|
|
|
|
|
*
|
|
|
|
|
* An OpenGL based 'interactive canvas' library.
|
|
|
|
|
*
|
|
|
|
|
* Authored By Matthew Allum <mallum@openedhand.com>
|
|
|
|
|
*
|
|
|
|
|
* Copyright (C) 2006 OpenedHand
|
|
|
|
|
*
|
|
|
|
|
* This library is free software; you can redistribute it and/or
|
|
|
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
|
|
|
* License as published by the Free Software Foundation; either
|
|
|
|
|
* version 2 of the License, or (at your option) any later version.
|
|
|
|
|
*
|
|
|
|
|
* This library is distributed in the hope that it will be useful,
|
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
|
* Lesser General Public License for more details.
|
|
|
|
|
*
|
|
|
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
|
|
|
* License along with this library; if not, write to the
|
|
|
|
|
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
|
|
* Boston, MA 02111-1307, USA.
|
|
|
|
|
*/
|
|
|
|
|
|
2007-03-22 18:21:59 +00:00
|
|
|
#ifndef __CLUTTER_STAGE_H__
|
|
|
|
|
#define __CLUTTER_STAGE_H__
|
2006-05-29 08:59:36 +00:00
|
|
|
|
|
|
|
|
#include <clutter/clutter-group.h>
|
|
|
|
|
#include <clutter/clutter-color.h>
|
|
|
|
|
#include <clutter/clutter-event.h>
|
|
|
|
|
#include <gdk-pixbuf/gdk-pixbuf.h>
|
|
|
|
|
|
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
|
|
2007-11-21 11:55:26 +00:00
|
|
|
#define CLUTTER_TYPE_PERSPECTIVE (clutter_perspective_get_type ())
|
|
|
|
|
#define CLUTTER_TYPE_FOG (clutter_fog_get_type ())
|
|
|
|
|
#define CLUTTER_TYPE_STAGE (clutter_stage_get_type())
|
2006-05-29 08:59:36 +00:00
|
|
|
|
|
|
|
|
#define CLUTTER_STAGE(obj) \
|
|
|
|
|
(G_TYPE_CHECK_INSTANCE_CAST ((obj), \
|
|
|
|
|
CLUTTER_TYPE_STAGE, ClutterStage))
|
|
|
|
|
|
|
|
|
|
#define CLUTTER_STAGE_CLASS(klass) \
|
|
|
|
|
(G_TYPE_CHECK_CLASS_CAST ((klass), \
|
|
|
|
|
CLUTTER_TYPE_STAGE, ClutterStageClass))
|
|
|
|
|
|
|
|
|
|
#define CLUTTER_IS_STAGE(obj) \
|
|
|
|
|
(G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
|
|
|
|
|
CLUTTER_TYPE_STAGE))
|
|
|
|
|
|
|
|
|
|
#define CLUTTER_IS_STAGE_CLASS(klass) \
|
|
|
|
|
(G_TYPE_CHECK_CLASS_TYPE ((klass), \
|
|
|
|
|
CLUTTER_TYPE_STAGE))
|
|
|
|
|
|
|
|
|
|
#define CLUTTER_STAGE_GET_CLASS(obj) \
|
|
|
|
|
(G_TYPE_INSTANCE_GET_CLASS ((obj), \
|
|
|
|
|
CLUTTER_TYPE_STAGE, ClutterStageClass))
|
|
|
|
|
|
2007-03-22 18:21:59 +00:00
|
|
|
#define CLUTTER_STAGE_WIDTH() \
|
|
|
|
|
clutter_actor_get_width (clutter_stage_get_default ())
|
|
|
|
|
|
|
|
|
|
#define CLUTTER_STAGE_HEIGHT() \
|
|
|
|
|
clutter_actor_get_height (clutter_stage_get_default ())
|
|
|
|
|
|
2007-08-07 14:03:58 +00:00
|
|
|
typedef struct _ClutterPerspective ClutterPerspective;
|
2007-11-21 11:55:26 +00:00
|
|
|
typedef struct _ClutterFog ClutterFog;
|
|
|
|
|
|
2006-06-05 Emmanuele Bassi <ebassi@openedhand.com>
* clutter-color.h:
* clutter-color.c: Reimplement ClutterColor as a boxed type;
add convenience API for color handling, like: add, subtract,
shade, HSL color-space conversion, packing and unpacking.
* clutter-private.h: Update ClutterMainContext, and export the
main context pointer here.
* clutter-rectangle.h:
* clutter-rectangle.c: Update the color-related code; make
clutter_rectangle_new() and empty constructor and provide
clutter_rectangle_new_with_color(); provide color setter
and getter API.
* clutter-label.h:
* clutter-label.c: Rename the "font" property to "font-name";
update the color-related code to the new ClutterColor object;
rename clutter_label_new() to clutter_label_new_with_text(),
and add setters and getters for the properties.
* clutter-marshal.list: Add VOID:OBJECT and VOID:BOXED marshallers
generators.
* clutter-stage.h:
* clutter-stage.c: Rework the API: provide a default constructor
for a singleton object, named clutter_stage_get_default(), which
supercedes the clutter_stage() function in clutter-main; provide
new events: button-press-event, button-release-event,
key-press-event and key-release-event; update the color-related
code;
(clutter_stage_snapshot): Allow negative width and height when
taking a snapshot (meaning: use full width/height).
(clutter_stage_get_element_at_pos): Rename clutter_stage_pick().
* clutter-element.c (clutter_element_paint): Clean up the
stage and color related code.
* clutter-event.h:
* clutter-event.c: Add generic ClutterAnyEvent type; add
clutter_event_new(), clutter_event_copy() and clutter_event_free();
make ClutterEvent a boxed type.
* clutter-main.h:
* clutter-main.c: Remove clutter_stage(); add clutter_main_quit(),
for cleanly quitting from clutter_main(); add multiple mainloops
support; allocate the ClutterCntx instead of adding it to the
stack; re-work the ClutterEvent dispatching.
* clutter-group.c (clutter_group_add), (clutter_group_remove): Keep
a reference on the element when added to a ClutterGroup.
* examples/rects.py
* examples/test.c:
* examples/test-text.c:
* examples/video-cube.c:
* examples/super-oh.c:
* examples/test-video.c: Update.
2006-06-05 13:38:31 +00:00
|
|
|
typedef struct _ClutterStage ClutterStage;
|
|
|
|
|
typedef struct _ClutterStageClass ClutterStageClass;
|
2007-03-22 18:21:59 +00:00
|
|
|
typedef struct _ClutterStagePrivate ClutterStagePrivate;
|
2006-05-29 08:59:36 +00:00
|
|
|
|
|
|
|
|
struct _ClutterStage
|
|
|
|
|
{
|
2007-08-07 14:03:58 +00:00
|
|
|
/*< private >*/
|
2007-03-22 18:21:59 +00:00
|
|
|
ClutterGroup parent_instance;
|
2007-11-28 15:31:41 +00:00
|
|
|
|
2006-05-29 08:59:36 +00:00
|
|
|
ClutterStagePrivate *priv;
|
2007-11-28 15:31:41 +00:00
|
|
|
};
|
2006-05-29 08:59:36 +00:00
|
|
|
|
2007-11-28 15:31:41 +00:00
|
|
|
struct _ClutterStageClass
|
2006-05-29 08:59:36 +00:00
|
|
|
{
|
2007-08-07 14:03:58 +00:00
|
|
|
/*< private >*/
|
2006-05-29 08:59:36 +00:00
|
|
|
ClutterGroupClass parent_class;
|
|
|
|
|
|
2007-08-07 14:03:58 +00:00
|
|
|
/*< public >*/
|
2007-03-22 18:21:59 +00:00
|
|
|
/* vfuncs, not signals */
|
|
|
|
|
void (* set_fullscreen) (ClutterStage *stage,
|
|
|
|
|
gboolean fullscreen);
|
|
|
|
|
void (* set_cursor_visible) (ClutterStage *stage,
|
|
|
|
|
gboolean visible);
|
|
|
|
|
void (* set_offscreen) (ClutterStage *stage,
|
|
|
|
|
gboolean offscreen);
|
2007-06-19 14:10:25 +00:00
|
|
|
GdkPixbuf* (* draw_to_pixbuf) (ClutterStage *stage,
|
2007-03-22 18:21:59 +00:00
|
|
|
gint x,
|
|
|
|
|
gint y,
|
|
|
|
|
gint width,
|
|
|
|
|
gint height);
|
2007-06-19 09:10:37 +00:00
|
|
|
void (* set_title) (ClutterStage *stage,
|
|
|
|
|
const gchar *title);
|
2007-07-26 20:08:09 +00:00
|
|
|
void (* set_user_resize) (ClutterStage *stage,
|
|
|
|
|
gboolean value);
|
2007-03-22 18:21:59 +00:00
|
|
|
|
2007-08-13 20:48:01 +00:00
|
|
|
/* events */
|
2007-08-24 15:12:52 +00:00
|
|
|
void (* fullscreen) (ClutterStage *stage);
|
|
|
|
|
void (* unfullscreen) (ClutterStage *stage);
|
|
|
|
|
void (* activate) (ClutterStage *stage);
|
|
|
|
|
void (* deactivate) (ClutterStage *stage);
|
2006-06-05 Emmanuele Bassi <ebassi@openedhand.com>
* clutter-color.h:
* clutter-color.c: Reimplement ClutterColor as a boxed type;
add convenience API for color handling, like: add, subtract,
shade, HSL color-space conversion, packing and unpacking.
* clutter-private.h: Update ClutterMainContext, and export the
main context pointer here.
* clutter-rectangle.h:
* clutter-rectangle.c: Update the color-related code; make
clutter_rectangle_new() and empty constructor and provide
clutter_rectangle_new_with_color(); provide color setter
and getter API.
* clutter-label.h:
* clutter-label.c: Rename the "font" property to "font-name";
update the color-related code to the new ClutterColor object;
rename clutter_label_new() to clutter_label_new_with_text(),
and add setters and getters for the properties.
* clutter-marshal.list: Add VOID:OBJECT and VOID:BOXED marshallers
generators.
* clutter-stage.h:
* clutter-stage.c: Rework the API: provide a default constructor
for a singleton object, named clutter_stage_get_default(), which
supercedes the clutter_stage() function in clutter-main; provide
new events: button-press-event, button-release-event,
key-press-event and key-release-event; update the color-related
code;
(clutter_stage_snapshot): Allow negative width and height when
taking a snapshot (meaning: use full width/height).
(clutter_stage_get_element_at_pos): Rename clutter_stage_pick().
* clutter-element.c (clutter_element_paint): Clean up the
stage and color related code.
* clutter-event.h:
* clutter-event.c: Add generic ClutterAnyEvent type; add
clutter_event_new(), clutter_event_copy() and clutter_event_free();
make ClutterEvent a boxed type.
* clutter-main.h:
* clutter-main.c: Remove clutter_stage(); add clutter_main_quit(),
for cleanly quitting from clutter_main(); add multiple mainloops
support; allocate the ClutterCntx instead of adding it to the
stack; re-work the ClutterEvent dispatching.
* clutter-group.c (clutter_group_add), (clutter_group_remove): Keep
a reference on the element when added to a ClutterGroup.
* examples/rects.py
* examples/test.c:
* examples/test-text.c:
* examples/video-cube.c:
* examples/super-oh.c:
* examples/test-video.c: Update.
2006-06-05 13:38:31 +00:00
|
|
|
|
2007-06-16 21:15:31 +00:00
|
|
|
/*< private >*/
|
2006-06-05 Emmanuele Bassi <ebassi@openedhand.com>
* clutter-color.h:
* clutter-color.c: Reimplement ClutterColor as a boxed type;
add convenience API for color handling, like: add, subtract,
shade, HSL color-space conversion, packing and unpacking.
* clutter-private.h: Update ClutterMainContext, and export the
main context pointer here.
* clutter-rectangle.h:
* clutter-rectangle.c: Update the color-related code; make
clutter_rectangle_new() and empty constructor and provide
clutter_rectangle_new_with_color(); provide color setter
and getter API.
* clutter-label.h:
* clutter-label.c: Rename the "font" property to "font-name";
update the color-related code to the new ClutterColor object;
rename clutter_label_new() to clutter_label_new_with_text(),
and add setters and getters for the properties.
* clutter-marshal.list: Add VOID:OBJECT and VOID:BOXED marshallers
generators.
* clutter-stage.h:
* clutter-stage.c: Rework the API: provide a default constructor
for a singleton object, named clutter_stage_get_default(), which
supercedes the clutter_stage() function in clutter-main; provide
new events: button-press-event, button-release-event,
key-press-event and key-release-event; update the color-related
code;
(clutter_stage_snapshot): Allow negative width and height when
taking a snapshot (meaning: use full width/height).
(clutter_stage_get_element_at_pos): Rename clutter_stage_pick().
* clutter-element.c (clutter_element_paint): Clean up the
stage and color related code.
* clutter-event.h:
* clutter-event.c: Add generic ClutterAnyEvent type; add
clutter_event_new(), clutter_event_copy() and clutter_event_free();
make ClutterEvent a boxed type.
* clutter-main.h:
* clutter-main.c: Remove clutter_stage(); add clutter_main_quit(),
for cleanly quitting from clutter_main(); add multiple mainloops
support; allocate the ClutterCntx instead of adding it to the
stack; re-work the ClutterEvent dispatching.
* clutter-group.c (clutter_group_add), (clutter_group_remove): Keep
a reference on the element when added to a ClutterGroup.
* examples/rects.py
* examples/test.c:
* examples/test-text.c:
* examples/video-cube.c:
* examples/super-oh.c:
* examples/test-video.c: Update.
2006-06-05 13:38:31 +00:00
|
|
|
/* padding for future expansion */
|
2007-06-16 21:15:31 +00:00
|
|
|
gpointer _padding_dummy[32];
|
2007-01-23 20:29:11 +00:00
|
|
|
};
|
|
|
|
|
|
2007-03-26 23:18:39 +00:00
|
|
|
|
|
|
|
|
|
2007-08-07 14:03:58 +00:00
|
|
|
/**
|
|
|
|
|
* ClutterPerspective:
|
2007-12-24 16:24:26 +00:00
|
|
|
* @fovy: the field of view angle, in degrees, in the y direction
|
|
|
|
|
* @aspect: the aspect ratio that determines the field of view in the x
|
|
|
|
|
* direction. The aspect ratio is the ratio of x (width) to y (height)
|
|
|
|
|
* @z_near: the distance from the viewer to the near clipping
|
|
|
|
|
* plane (always positive)
|
|
|
|
|
* @z_far: the distance from the viewer to the far clipping
|
|
|
|
|
* plane (always positive)
|
2007-08-07 14:03:58 +00:00
|
|
|
*
|
2007-12-24 16:24:26 +00:00
|
|
|
* Stage perspective definition. #ClutterPerspective is only used by
|
|
|
|
|
* the fixed point version of clutter_stage_set_perspective().
|
2007-08-07 14:03:58 +00:00
|
|
|
*
|
|
|
|
|
* Since: 0.4
|
|
|
|
|
*/
|
2007-03-26 23:18:39 +00:00
|
|
|
struct _ClutterPerspective
|
|
|
|
|
{
|
|
|
|
|
ClutterFixed fovy;
|
|
|
|
|
ClutterFixed aspect;
|
2007-05-25 10:56:09 +00:00
|
|
|
ClutterFixed z_near;
|
|
|
|
|
ClutterFixed z_far;
|
|
|
|
|
};
|
|
|
|
|
|
2007-11-21 11:55:26 +00:00
|
|
|
/**
|
|
|
|
|
* ClutterFog:
|
|
|
|
|
* @density: density of the fog
|
2007-12-24 16:24:26 +00:00
|
|
|
* @z_near: starting distance from the viewer to the near clipping
|
|
|
|
|
* plane (always positive)
|
|
|
|
|
* @z_far: final distance from the viewer to the far clipping
|
|
|
|
|
* plane (always positive)
|
2007-11-21 11:55:26 +00:00
|
|
|
*
|
2007-12-24 16:24:26 +00:00
|
|
|
* Fog settings used to create the depth cueing effect. #ClutterFox is
|
|
|
|
|
* useful only when using the fixed point API.
|
2007-11-21 11:55:26 +00:00
|
|
|
*
|
|
|
|
|
* Since: 0.6
|
|
|
|
|
*/
|
|
|
|
|
struct _ClutterFog
|
|
|
|
|
{
|
|
|
|
|
ClutterFixed density;
|
|
|
|
|
ClutterFixed z_near;
|
|
|
|
|
ClutterFixed z_far;
|
|
|
|
|
};
|
2007-08-07 14:03:58 +00:00
|
|
|
|
2007-11-21 11:55:26 +00:00
|
|
|
GType clutter_perspective_get_type (void) G_GNUC_CONST;
|
|
|
|
|
GType clutter_fog_get_type (void) G_GNUC_CONST;
|
2007-07-04 14:00:41 +00:00
|
|
|
GType clutter_stage_get_type (void) G_GNUC_CONST;
|
2007-03-22 18:21:59 +00:00
|
|
|
|
2007-07-04 14:00:41 +00:00
|
|
|
ClutterActor *clutter_stage_get_default (void);
|
|
|
|
|
void clutter_stage_set_color (ClutterStage *stage,
|
|
|
|
|
const ClutterColor *color);
|
|
|
|
|
void clutter_stage_get_color (ClutterStage *stage,
|
|
|
|
|
ClutterColor *color);
|
2007-05-25 10:56:09 +00:00
|
|
|
void clutter_stage_set_perspectivex (ClutterStage *stage,
|
2007-07-04 14:00:41 +00:00
|
|
|
ClutterPerspective *perspective);
|
2007-05-25 10:56:09 +00:00
|
|
|
void clutter_stage_get_perspectivex (ClutterStage *stage,
|
2007-07-04 14:00:41 +00:00
|
|
|
ClutterPerspective *perspective);
|
2007-05-25 10:56:09 +00:00
|
|
|
void clutter_stage_set_perspective (ClutterStage *stage,
|
2007-07-04 14:00:41 +00:00
|
|
|
gfloat fovy,
|
|
|
|
|
gfloat aspect,
|
|
|
|
|
gfloat z_near,
|
|
|
|
|
gfloat z_far);
|
2007-05-25 10:56:09 +00:00
|
|
|
void clutter_stage_get_perspective (ClutterStage *stage,
|
|
|
|
|
gfloat *fovy,
|
|
|
|
|
gfloat *aspect,
|
|
|
|
|
gfloat *z_near,
|
|
|
|
|
gfloat *z_far);
|
2007-07-04 14:00:41 +00:00
|
|
|
void clutter_stage_fullscreen (ClutterStage *stage);
|
|
|
|
|
void clutter_stage_unfullscreen (ClutterStage *stage);
|
|
|
|
|
void clutter_stage_show_cursor (ClutterStage *stage);
|
|
|
|
|
void clutter_stage_hide_cursor (ClutterStage *stage);
|
|
|
|
|
|
|
|
|
|
ClutterActor *clutter_stage_get_actor_at_pos (ClutterStage *stage,
|
|
|
|
|
gint x,
|
|
|
|
|
gint y);
|
|
|
|
|
GdkPixbuf * clutter_stage_snapshot (ClutterStage *stage,
|
|
|
|
|
gint x,
|
|
|
|
|
gint y,
|
|
|
|
|
gint width,
|
|
|
|
|
gint height);
|
|
|
|
|
gboolean clutter_stage_event (ClutterStage *stage,
|
|
|
|
|
ClutterEvent *event);
|
|
|
|
|
|
2007-07-31 17:01:52 +00:00
|
|
|
void clutter_stage_set_title (ClutterStage *stage,
|
|
|
|
|
const gchar *title);
|
|
|
|
|
G_CONST_RETURN gchar *clutter_stage_get_title (ClutterStage *stage);
|
2007-11-28 15:31:41 +00:00
|
|
|
void clutter_stage_set_user_resizable (ClutterStage *stage,
|
2007-07-31 17:01:52 +00:00
|
|
|
gboolean resizable);
|
|
|
|
|
gboolean clutter_stage_get_user_resizable (ClutterStage *stage);
|
2007-11-21 11:55:26 +00:00
|
|
|
void clutter_stage_set_use_fog (ClutterStage *stage,
|
|
|
|
|
gboolean fog);
|
|
|
|
|
gboolean clutter_stage_get_use_fog (ClutterStage *stage);
|
|
|
|
|
void clutter_stage_set_fog (ClutterStage *stage,
|
|
|
|
|
gdouble density,
|
|
|
|
|
gdouble z_near,
|
|
|
|
|
gdouble z_far);
|
|
|
|
|
void clutter_stage_get_fog (ClutterStage *stage,
|
|
|
|
|
gdouble *density,
|
|
|
|
|
gdouble *z_near,
|
|
|
|
|
gdouble *z_far);
|
|
|
|
|
void clutter_stage_set_fogx (ClutterStage *stage,
|
|
|
|
|
ClutterFog *fog);
|
|
|
|
|
void clutter_stage_get_fogx (ClutterStage *stage,
|
|
|
|
|
ClutterFog *fog);
|
2007-11-28 15:31:41 +00:00
|
|
|
gdouble clutter_stage_get_resolution (ClutterStage *stage);
|
|
|
|
|
ClutterFixed clutter_stage_get_resolutionx (ClutterStage *stage);
|
2007-07-26 20:08:09 +00:00
|
|
|
|
2007-08-13 20:48:01 +00:00
|
|
|
/* New experiental calls */
|
2007-11-21 11:55:26 +00:00
|
|
|
void clutter_stage_set_key_focus (ClutterStage *stage,
|
|
|
|
|
ClutterActor *actor);
|
|
|
|
|
ClutterActor * clutter_stage_get_key_focus (ClutterStage *stage);
|
2007-08-13 20:48:01 +00:00
|
|
|
|
2007-12-21 16:04:39 +00:00
|
|
|
/* Commodity macro */
|
|
|
|
|
#define clutter_stage_add(stage,actor) G_STMT_START { \
|
|
|
|
|
if (CLUTTER_IS_STAGE ((stage)) && CLUTTER_IS_ACTOR ((actor))) \
|
|
|
|
|
{ \
|
|
|
|
|
ClutterContainer *_container = (ClutterContainer *) (stage); \
|
|
|
|
|
ClutterActor *_actor = (ClutterActor *) (actor); \
|
|
|
|
|
clutter_container_add_actor (_container, _actor); \
|
|
|
|
|
} } G_STMT_END
|
|
|
|
|
|
2006-05-29 08:59:36 +00:00
|
|
|
G_END_DECLS
|
|
|
|
|
|
2007-03-22 18:21:59 +00:00
|
|
|
#endif /* __CLUTTER_STAGE_H__ */
|