2006-05-29 04:59:36 -04: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
|
2008-10-30 13:04:34 -04:00
|
|
|
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
|
2006-05-29 04:59:36 -04:00
|
|
|
*/
|
|
|
|
|
|
2008-10-30 13:04:34 -04:00
|
|
|
#if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
|
|
|
|
|
#error "Only <clutter/clutter.h> can be included directly."
|
|
|
|
|
#endif
|
|
|
|
|
|
2007-03-22 14:21:59 -04:00
|
|
|
#ifndef __CLUTTER_STAGE_H__
|
|
|
|
|
#define __CLUTTER_STAGE_H__
|
2006-05-29 04:59:36 -04:00
|
|
|
|
2008-03-28 18:50:55 -04:00
|
|
|
#include <clutter/clutter-types.h>
|
2006-05-29 04:59:36 -04:00
|
|
|
#include <clutter/clutter-group.h>
|
|
|
|
|
#include <clutter/clutter-color.h>
|
|
|
|
|
#include <clutter/clutter-event.h>
|
2011-07-12 12:16:43 -04:00
|
|
|
#include <cairo.h>
|
2008-04-25 09:37:36 -04:00
|
|
|
|
2006-05-29 04:59:36 -04:00
|
|
|
G_BEGIN_DECLS
|
|
|
|
|
|
2007-11-21 06:55:26 -05:00
|
|
|
#define CLUTTER_TYPE_STAGE (clutter_stage_get_type())
|
2006-05-29 04:59:36 -04:00
|
|
|
|
2009-12-08 20:52:09 -05: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))
|
2006-05-29 04:59:36 -04:00
|
|
|
|
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 09:38:31 -04:00
|
|
|
typedef struct _ClutterStageClass ClutterStageClass;
|
2007-03-22 14:21:59 -04:00
|
|
|
typedef struct _ClutterStagePrivate ClutterStagePrivate;
|
2006-05-29 04:59:36 -04:00
|
|
|
|
2009-03-16 11:00:55 -04:00
|
|
|
/**
|
|
|
|
|
* ClutterStage:
|
|
|
|
|
*
|
|
|
|
|
* The #ClutterStage structure contains only private data
|
|
|
|
|
* and should be accessed using the provided API
|
|
|
|
|
*
|
|
|
|
|
* Since: 0.1
|
|
|
|
|
*/
|
2006-05-29 04:59:36 -04:00
|
|
|
struct _ClutterStage
|
|
|
|
|
{
|
2007-08-07 10:03:58 -04:00
|
|
|
/*< private >*/
|
2007-03-22 14:21:59 -04:00
|
|
|
ClutterGroup parent_instance;
|
2007-11-28 10:31:41 -05:00
|
|
|
|
2006-05-29 04:59:36 -04:00
|
|
|
ClutterStagePrivate *priv;
|
2007-11-28 10:31:41 -05:00
|
|
|
};
|
2009-03-16 11:00:55 -04:00
|
|
|
/**
|
|
|
|
|
* ClutterStageClass:
|
|
|
|
|
* @fullscreen: handler for the #ClutterStage::fullscreen signal
|
|
|
|
|
* @unfullscreen: handler for the #ClutterStage::unfullscreen signal
|
|
|
|
|
* @activate: handler for the #ClutterStage::activate signal
|
2010-11-18 09:14:37 -05:00
|
|
|
* @deactivate: handler for the #ClutterStage::deactivate signal
|
2010-01-12 10:44:28 -05:00
|
|
|
* @delete_event: handler for the #ClutterStage::delete-event signal
|
2009-03-16 11:00:55 -04:00
|
|
|
*
|
|
|
|
|
* The #ClutterStageClass structure contains only private data
|
|
|
|
|
*
|
|
|
|
|
* Since: 0.1
|
|
|
|
|
*/
|
2006-05-29 04:59:36 -04:00
|
|
|
|
2007-11-28 10:31:41 -05:00
|
|
|
struct _ClutterStageClass
|
2006-05-29 04:59:36 -04:00
|
|
|
{
|
2007-08-07 10:03:58 -04:00
|
|
|
/*< private >*/
|
2006-05-29 04:59:36 -04:00
|
|
|
ClutterGroupClass parent_class;
|
|
|
|
|
|
2007-08-07 10:03:58 -04:00
|
|
|
/*< public >*/
|
2008-04-04 11:02:11 -04:00
|
|
|
/* signals */
|
|
|
|
|
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 09:38:31 -04:00
|
|
|
|
2010-01-12 10:44:28 -05:00
|
|
|
gboolean (* delete_event) (ClutterStage *stage,
|
|
|
|
|
ClutterEvent *event);
|
|
|
|
|
|
2007-06-16 17:15:31 -04: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 09:38:31 -04:00
|
|
|
/* padding for future expansion */
|
2010-01-12 10:44:28 -05:00
|
|
|
gpointer _padding_dummy[31];
|
2007-01-23 15:29:11 -05:00
|
|
|
};
|
|
|
|
|
|
2007-08-07 10:03:58 -04:00
|
|
|
/**
|
|
|
|
|
* ClutterPerspective:
|
2007-12-24 11:24:26 -05: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 10:03:58 -04:00
|
|
|
*
|
2007-12-24 11:24:26 -05:00
|
|
|
* Stage perspective definition. #ClutterPerspective is only used by
|
|
|
|
|
* the fixed point version of clutter_stage_set_perspective().
|
2007-08-07 10:03:58 -04:00
|
|
|
*
|
|
|
|
|
* Since: 0.4
|
|
|
|
|
*/
|
2007-03-26 19:18:39 -04:00
|
|
|
struct _ClutterPerspective
|
|
|
|
|
{
|
[stage] Coalesce fog and perspective API
The fog and perspective API is currently split in two parts:
- the floating point version, using values
- the fixed point version, using structures
The relative properties are using the structure types, since they
are meant to set multiple values at the same time. Instead of
using bare values, the whole API should be coalesced into two
simple calls using structures to match the GObject properties.
Thus:
clutter_stage_set_fog (ClutterStage*, const ClutterFog*)
clutter_stage_get_fog (ClutterStage*, ClutterFog*)
clutter_stage_set_perspective (ClutterStage*, const ClutterPerspective*)
clutter_stage_get_perspective (ClutterStage*, ClutterPerspective*)
Which supercedes the fixed point and floating point variants.
More importantly, both ClutterFog and ClutterPerspective should
using floating point values, since that's what get passed to
COGL anyway.
ClutterFog should also drop the "density" member, since ClutterStage
only allows linear fog; non-linear fog distribution can be achieved
using a signal handler and calling cogl_set_fog() directly; this keeps
the API compact yet extensible.
Finally, there is no ClutterStage:fog so it should be added.
2009-03-09 13:24:44 -04:00
|
|
|
gfloat fovy;
|
|
|
|
|
gfloat aspect;
|
|
|
|
|
gfloat z_near;
|
|
|
|
|
gfloat z_far;
|
2007-05-25 06:56:09 -04:00
|
|
|
};
|
|
|
|
|
|
2007-11-21 06:55:26 -05:00
|
|
|
/**
|
|
|
|
|
* ClutterFog:
|
2007-12-24 11:24:26 -05: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 06:55:26 -05:00
|
|
|
*
|
[stage] Coalesce fog and perspective API
The fog and perspective API is currently split in two parts:
- the floating point version, using values
- the fixed point version, using structures
The relative properties are using the structure types, since they
are meant to set multiple values at the same time. Instead of
using bare values, the whole API should be coalesced into two
simple calls using structures to match the GObject properties.
Thus:
clutter_stage_set_fog (ClutterStage*, const ClutterFog*)
clutter_stage_get_fog (ClutterStage*, ClutterFog*)
clutter_stage_set_perspective (ClutterStage*, const ClutterPerspective*)
clutter_stage_get_perspective (ClutterStage*, ClutterPerspective*)
Which supercedes the fixed point and floating point variants.
More importantly, both ClutterFog and ClutterPerspective should
using floating point values, since that's what get passed to
COGL anyway.
ClutterFog should also drop the "density" member, since ClutterStage
only allows linear fog; non-linear fog distribution can be achieved
using a signal handler and calling cogl_set_fog() directly; this keeps
the API compact yet extensible.
Finally, there is no ClutterStage:fog so it should be added.
2009-03-09 13:24:44 -04:00
|
|
|
* Fog settings used to create the depth cueing effect.
|
2007-11-21 06:55:26 -05:00
|
|
|
*
|
|
|
|
|
* Since: 0.6
|
|
|
|
|
*/
|
|
|
|
|
struct _ClutterFog
|
|
|
|
|
{
|
[stage] Coalesce fog and perspective API
The fog and perspective API is currently split in two parts:
- the floating point version, using values
- the fixed point version, using structures
The relative properties are using the structure types, since they
are meant to set multiple values at the same time. Instead of
using bare values, the whole API should be coalesced into two
simple calls using structures to match the GObject properties.
Thus:
clutter_stage_set_fog (ClutterStage*, const ClutterFog*)
clutter_stage_get_fog (ClutterStage*, ClutterFog*)
clutter_stage_set_perspective (ClutterStage*, const ClutterPerspective*)
clutter_stage_get_perspective (ClutterStage*, ClutterPerspective*)
Which supercedes the fixed point and floating point variants.
More importantly, both ClutterFog and ClutterPerspective should
using floating point values, since that's what get passed to
COGL anyway.
ClutterFog should also drop the "density" member, since ClutterStage
only allows linear fog; non-linear fog distribution can be achieved
using a signal handler and calling cogl_set_fog() directly; this keeps
the API compact yet extensible.
Finally, there is no ClutterStage:fog so it should be added.
2009-03-09 13:24:44 -04:00
|
|
|
gfloat z_near;
|
|
|
|
|
gfloat z_far;
|
2007-11-21 06:55:26 -05:00
|
|
|
};
|
2007-08-07 10:03:58 -04:00
|
|
|
|
2011-12-30 05:23:15 -05:00
|
|
|
GType clutter_perspective_get_type (void) G_GNUC_CONST;
|
|
|
|
|
GType clutter_fog_get_type (void) G_GNUC_CONST;
|
|
|
|
|
GType clutter_stage_get_type (void) G_GNUC_CONST;
|
|
|
|
|
|
|
|
|
|
ClutterActor * clutter_stage_new (void);
|
|
|
|
|
|
|
|
|
|
void clutter_stage_set_perspective (ClutterStage *stage,
|
|
|
|
|
ClutterPerspective *perspective);
|
|
|
|
|
void clutter_stage_get_perspective (ClutterStage *stage,
|
|
|
|
|
ClutterPerspective *perspective);
|
|
|
|
|
void clutter_stage_set_fullscreen (ClutterStage *stage,
|
|
|
|
|
gboolean fullscreen);
|
|
|
|
|
gboolean clutter_stage_get_fullscreen (ClutterStage *stage);
|
|
|
|
|
void clutter_stage_show_cursor (ClutterStage *stage);
|
|
|
|
|
void clutter_stage_hide_cursor (ClutterStage *stage);
|
|
|
|
|
void clutter_stage_set_title (ClutterStage *stage,
|
|
|
|
|
const gchar *title);
|
|
|
|
|
const gchar * clutter_stage_get_title (ClutterStage *stage);
|
|
|
|
|
void clutter_stage_set_user_resizable (ClutterStage *stage,
|
|
|
|
|
gboolean resizable);
|
|
|
|
|
gboolean clutter_stage_get_user_resizable (ClutterStage *stage);
|
|
|
|
|
|
|
|
|
|
void clutter_stage_set_minimum_size (ClutterStage *stage,
|
|
|
|
|
guint width,
|
|
|
|
|
guint height);
|
|
|
|
|
void clutter_stage_get_minimum_size (ClutterStage *stage,
|
|
|
|
|
guint *width,
|
|
|
|
|
guint *height);
|
|
|
|
|
void clutter_stage_set_no_clear_hint (ClutterStage *stage,
|
|
|
|
|
gboolean no_clear);
|
|
|
|
|
gboolean clutter_stage_get_no_clear_hint (ClutterStage *stage);
|
|
|
|
|
void clutter_stage_set_use_alpha (ClutterStage *stage,
|
|
|
|
|
gboolean use_alpha);
|
|
|
|
|
gboolean clutter_stage_get_use_alpha (ClutterStage *stage);
|
|
|
|
|
|
|
|
|
|
void clutter_stage_set_key_focus (ClutterStage *stage,
|
|
|
|
|
ClutterActor *actor);
|
|
|
|
|
ClutterActor * clutter_stage_get_key_focus (ClutterStage *stage);
|
|
|
|
|
void clutter_stage_set_throttle_motion_events (ClutterStage *stage,
|
|
|
|
|
gboolean throttle);
|
|
|
|
|
gboolean clutter_stage_get_throttle_motion_events (ClutterStage *stage);
|
|
|
|
|
void clutter_stage_set_motion_events_enabled (ClutterStage *stage,
|
|
|
|
|
gboolean enabled);
|
|
|
|
|
gboolean clutter_stage_get_motion_events_enabled (ClutterStage *stage);
|
|
|
|
|
void clutter_stage_set_accept_focus (ClutterStage *stage,
|
|
|
|
|
gboolean accept_focus);
|
|
|
|
|
gboolean clutter_stage_get_accept_focus (ClutterStage *stage);
|
|
|
|
|
gboolean clutter_stage_event (ClutterStage *stage,
|
|
|
|
|
ClutterEvent *event);
|
|
|
|
|
|
|
|
|
|
ClutterActor * clutter_stage_get_actor_at_pos (ClutterStage *stage,
|
|
|
|
|
ClutterPickMode pick_mode,
|
|
|
|
|
gint x,
|
|
|
|
|
gint y);
|
|
|
|
|
guchar * clutter_stage_read_pixels (ClutterStage *stage,
|
|
|
|
|
gint x,
|
|
|
|
|
gint y,
|
|
|
|
|
gint width,
|
|
|
|
|
gint height);
|
|
|
|
|
|
|
|
|
|
void clutter_stage_get_redraw_clip_bounds (ClutterStage *stage,
|
|
|
|
|
cairo_rectangle_int_t *clip);
|
|
|
|
|
|
|
|
|
|
void clutter_stage_ensure_current (ClutterStage *stage);
|
|
|
|
|
void clutter_stage_ensure_viewport (ClutterStage *stage);
|
|
|
|
|
void clutter_stage_ensure_redraw (ClutterStage *stage);
|
2011-06-20 06:41:28 -04:00
|
|
|
|
2006-05-29 04:59:36 -04:00
|
|
|
G_END_DECLS
|
|
|
|
|
|
2007-03-22 14:21:59 -04:00
|
|
|
#endif /* __CLUTTER_STAGE_H__ */
|