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-07-01 06:08:28 -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
|
|
|
|
|
|
|
|
|
|
#ifndef __CLUTTER_EVENT_H__
|
|
|
|
|
#define __CLUTTER_EVENT_H__
|
2006-05-29 04:59:36 -04:00
|
|
|
|
2007-08-13 16:48:01 -04:00
|
|
|
#include <clutter/clutter-types.h>
|
2011-10-04 08:28:04 -04:00
|
|
|
#include <clutter/clutter-input-device.h>
|
2006-05-29 04:59:36 -04:00
|
|
|
|
2011-12-20 07:28:06 -05:00
|
|
|
G_BEGIN_DECLS
|
|
|
|
|
|
2012-01-27 04:43:06 -05:00
|
|
|
#define CLUTTER_TYPE_EVENT (clutter_event_get_type ())
|
2007-11-23 08:11:10 -05:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* CLUTTER_PRIORITY_EVENTS:
|
|
|
|
|
*
|
|
|
|
|
* Priority for event handling.
|
|
|
|
|
*
|
|
|
|
|
* Since: 0.4
|
|
|
|
|
*/
|
2012-01-27 04:43:06 -05:00
|
|
|
#define CLUTTER_PRIORITY_EVENTS (G_PRIORITY_DEFAULT)
|
2007-11-23 08:11:10 -05:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* CLUTTER_CURRENT_TIME:
|
|
|
|
|
*
|
|
|
|
|
* Default value for "now".
|
|
|
|
|
*
|
|
|
|
|
* Since: 0.4
|
|
|
|
|
*/
|
2012-01-27 04:43:06 -05:00
|
|
|
#define CLUTTER_CURRENT_TIME (0L)
|
2006-05-29 04:59:36 -04:00
|
|
|
|
2011-12-20 07:28:06 -05:00
|
|
|
/**
|
|
|
|
|
* CLUTTER_EVENT_PROPAGATE:
|
|
|
|
|
*
|
|
|
|
|
* Continues the propagation of an event; this macro should be
|
|
|
|
|
* used in event-related signals.
|
|
|
|
|
*
|
|
|
|
|
* Since: 1.10
|
|
|
|
|
*/
|
2012-01-27 04:43:06 -05:00
|
|
|
#define CLUTTER_EVENT_PROPAGATE (FALSE)
|
2011-12-20 07:28:06 -05:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* CLUTTER_EVENT_STOP:
|
|
|
|
|
*
|
2012-05-03 06:27:22 -04:00
|
|
|
* Stops the propagation of an event; this macro should be used
|
2011-12-20 07:28:06 -05:00
|
|
|
* in event-related signals.
|
|
|
|
|
*
|
|
|
|
|
* Since: 1.10
|
|
|
|
|
*/
|
2012-01-27 04:43:06 -05:00
|
|
|
#define CLUTTER_EVENT_STOP (TRUE)
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* CLUTTER_BUTTON_PRIMARY:
|
|
|
|
|
*
|
|
|
|
|
* The primary button of a pointer device.
|
|
|
|
|
*
|
|
|
|
|
* This is typically the left mouse button in a right-handed
|
|
|
|
|
* mouse configuration.
|
|
|
|
|
*
|
|
|
|
|
* Since: 1.10
|
|
|
|
|
*/
|
|
|
|
|
#define CLUTTER_BUTTON_PRIMARY (1)
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* CLUTTER_BUTTON_MIDDLE:
|
|
|
|
|
*
|
|
|
|
|
* The middle button of a pointer device.
|
|
|
|
|
*
|
|
|
|
|
* Since: 1.10
|
|
|
|
|
*/
|
|
|
|
|
#define CLUTTER_BUTTON_MIDDLE (2)
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* CLUTTER_BUTTON_SECONDARY:
|
|
|
|
|
*
|
|
|
|
|
* The secondary button of a pointer device.
|
|
|
|
|
*
|
|
|
|
|
* This is typically the right mouse button in a right-handed
|
|
|
|
|
* mouse configuration.
|
|
|
|
|
*
|
|
|
|
|
* Since: 1.10
|
|
|
|
|
*/
|
|
|
|
|
#define CLUTTER_BUTTON_SECONDARY (3)
|
2006-05-29 04:59:36 -04:00
|
|
|
|
2007-03-22 14:21:59 -04:00
|
|
|
typedef struct _ClutterAnyEvent ClutterAnyEvent;
|
|
|
|
|
typedef struct _ClutterButtonEvent ClutterButtonEvent;
|
|
|
|
|
typedef struct _ClutterKeyEvent ClutterKeyEvent;
|
|
|
|
|
typedef struct _ClutterMotionEvent ClutterMotionEvent;
|
|
|
|
|
typedef struct _ClutterScrollEvent ClutterScrollEvent;
|
|
|
|
|
typedef struct _ClutterStageStateEvent ClutterStageStateEvent;
|
2007-10-03 05:28:16 -04:00
|
|
|
typedef struct _ClutterCrossingEvent ClutterCrossingEvent;
|
2012-03-19 09:47:19 -04:00
|
|
|
typedef struct _ClutterTouchEvent ClutterTouchEvent;
|
|
|
|
|
|
2012-05-03 06:27:22 -04:00
|
|
|
/**
|
|
|
|
|
* ClutterEventSequence:
|
|
|
|
|
*
|
|
|
|
|
* The <structname>ClutterEventSequence</structname> structure is an opaque
|
|
|
|
|
* type used to denote the event sequence of a touch event.
|
|
|
|
|
*
|
|
|
|
|
* Since: 1.12
|
|
|
|
|
*/
|
2012-03-19 09:47:19 -04:00
|
|
|
typedef struct _ClutterEventSequence ClutterEventSequence;
|
2006-05-29 04:59:36 -04:00
|
|
|
|
2007-12-15 09:36:27 -05:00
|
|
|
/**
|
|
|
|
|
* ClutterAnyEvent:
|
|
|
|
|
* @type: event type
|
|
|
|
|
* @time: event time
|
|
|
|
|
* @flags: event flags
|
|
|
|
|
* @source: event source actor
|
|
|
|
|
*
|
|
|
|
|
* Common members for a #ClutterEvent
|
|
|
|
|
*
|
|
|
|
|
* Since: 0.2
|
|
|
|
|
*/
|
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
|
|
|
struct _ClutterAnyEvent
|
|
|
|
|
{
|
Remove Units from the public API
With the recent change to internal floating point values, ClutterUnit
has become a redundant type, defined to be a float. All integer entry
points are being internally converted to floating point values to be
passed to the GL pipeline with the least amount of conversion.
ClutterUnit is thus exposed as just a "pixel with fractionary bits",
and not -- as users might think -- as generic, resolution and device
independent units. not that it was the case, but a definitive amount
of people was convinced it did provide this "feature", and was flummoxed
about the mere existence of this type.
So, having ClutterUnit exposed in the public API doubles the entry
points and has the following disadvantages:
- we have to maintain twice the amount of entry points in ClutterActor
- we still do an integer-to-float implicit conversion
- we introduce a weird impedance between pixels and "pixels with
fractionary bits"
- language bindings will have to choose what to bind, and resort
to manually overriding the API
+ *except* for language bindings based on GObject-Introspection, as
they cannot do manual overrides, thus will replicate the entire
set of entry points
For these reason, we should coalesces every Actor entry point for
pixels and for ClutterUnit into a single entry point taking a float,
like:
void clutter_actor_set_x (ClutterActor *self,
gfloat x);
void clutter_actor_get_size (ClutterActor *self,
gfloat *width,
gfloat *height);
gfloat clutter_actor_get_height (ClutterActor *self);
etc.
The issues I have identified are:
- we'll have a two cases of compiler warnings:
- printf() format of the return values from %d to %f
- clutter_actor_get_size() taking floats instead of unsigned ints
- we'll have a problem with varargs when passing an integer instead
of a floating point value, except on 64bit platforms where the
size of a float is the same as the size of an int
To be clear: the *intent* of the API should not change -- we still use
pixels everywhere -- but:
- we remove ambiguity in the API with regard to pixels and units
- we remove entry points we get to maintain for the whole 1.0
version of the API
- we make things simpler to bind for both manual language bindings
and automatic (gobject-introspection based) ones
- we have the simplest API possible while still exposing the
capabilities of the underlying GL implementation
2009-05-06 11:44:47 -04:00
|
|
|
ClutterEventType type;
|
|
|
|
|
guint32 time;
|
2007-09-27 17:38:38 -04:00
|
|
|
ClutterEventFlags flags;
|
2008-03-28 18:50:55 -04:00
|
|
|
ClutterStage *stage;
|
2007-11-12 14:12:02 -05:00
|
|
|
ClutterActor *source;
|
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
|
|
|
};
|
|
|
|
|
|
2007-12-15 09:36:27 -05:00
|
|
|
/**
|
|
|
|
|
* ClutterKeyEvent:
|
|
|
|
|
* @type: event type
|
|
|
|
|
* @time: event time
|
|
|
|
|
* @flags: event flags
|
2008-05-15 10:31:43 -04:00
|
|
|
* @stage: event source stage
|
2007-12-15 09:36:27 -05:00
|
|
|
* @source: event source actor
|
|
|
|
|
* @modifier_state: key modifiers
|
|
|
|
|
* @keyval: raw key value
|
|
|
|
|
* @hardware_keycode: raw hardware key value
|
2008-01-18 06:58:16 -05:00
|
|
|
* @unicode_value: Unicode representation
|
2009-02-11 12:54:52 -05:00
|
|
|
* @device: reserved for future use
|
2007-12-15 09:36:27 -05:00
|
|
|
*
|
|
|
|
|
* Key event
|
|
|
|
|
*
|
|
|
|
|
* Since: 0.2
|
|
|
|
|
*/
|
2006-05-29 04:59:36 -04:00
|
|
|
struct _ClutterKeyEvent
|
|
|
|
|
{
|
|
|
|
|
ClutterEventType type;
|
2007-03-22 14:21:59 -04:00
|
|
|
guint32 time;
|
2007-09-27 17:38:38 -04:00
|
|
|
ClutterEventFlags flags;
|
2008-03-28 18:50:55 -04:00
|
|
|
ClutterStage *stage;
|
2007-11-12 14:12:02 -05:00
|
|
|
ClutterActor *source;
|
2009-06-19 08:07:20 -04:00
|
|
|
|
2007-06-11 05:02:40 -04:00
|
|
|
ClutterModifierType modifier_state;
|
2007-03-22 14:21:59 -04:00
|
|
|
guint keyval;
|
|
|
|
|
guint16 hardware_keycode;
|
2008-01-18 06:58:16 -05:00
|
|
|
gunichar unicode_value;
|
2009-02-11 12:54:52 -05:00
|
|
|
ClutterInputDevice *device;
|
2006-05-29 04:59:36 -04:00
|
|
|
};
|
|
|
|
|
|
2007-12-15 09:36:27 -05:00
|
|
|
/**
|
|
|
|
|
* ClutterButtonEvent:
|
|
|
|
|
* @type: event type
|
|
|
|
|
* @time: event time
|
|
|
|
|
* @flags: event flags
|
2008-06-10 13:11:14 -04:00
|
|
|
* @stage: event source stage
|
2007-12-15 09:36:27 -05:00
|
|
|
* @source: event source actor
|
2009-01-21 17:03:31 -05:00
|
|
|
* @x: event X coordinate, relative to the stage
|
|
|
|
|
* @y: event Y coordinate, relative to the stage
|
2007-12-15 09:36:27 -05:00
|
|
|
* @modifier_state: button modifiers
|
|
|
|
|
* @button: event button
|
|
|
|
|
* @click_count: number of button presses within the default time
|
|
|
|
|
* and radius
|
|
|
|
|
* @axes: reserved for future use
|
|
|
|
|
* @device: reserved for future use
|
|
|
|
|
*
|
2009-01-21 17:03:31 -05:00
|
|
|
* Button event.
|
|
|
|
|
*
|
|
|
|
|
* The event coordinates are relative to the stage that received the
|
|
|
|
|
* event, and can be transformed into actor-relative coordinates by
|
|
|
|
|
* using clutter_actor_transform_stage_point().
|
2007-12-15 09:36:27 -05:00
|
|
|
*
|
|
|
|
|
* Since: 0.2
|
|
|
|
|
*/
|
2006-05-29 04:59:36 -04:00
|
|
|
struct _ClutterButtonEvent
|
|
|
|
|
{
|
2007-03-22 14:21:59 -04:00
|
|
|
ClutterEventType type;
|
|
|
|
|
guint32 time;
|
2007-09-27 17:38:38 -04:00
|
|
|
ClutterEventFlags flags;
|
2008-03-28 18:50:55 -04:00
|
|
|
ClutterStage *stage;
|
2007-11-12 14:12:02 -05:00
|
|
|
ClutterActor *source;
|
2009-06-19 08:07:20 -04:00
|
|
|
|
Remove Units from the public API
With the recent change to internal floating point values, ClutterUnit
has become a redundant type, defined to be a float. All integer entry
points are being internally converted to floating point values to be
passed to the GL pipeline with the least amount of conversion.
ClutterUnit is thus exposed as just a "pixel with fractionary bits",
and not -- as users might think -- as generic, resolution and device
independent units. not that it was the case, but a definitive amount
of people was convinced it did provide this "feature", and was flummoxed
about the mere existence of this type.
So, having ClutterUnit exposed in the public API doubles the entry
points and has the following disadvantages:
- we have to maintain twice the amount of entry points in ClutterActor
- we still do an integer-to-float implicit conversion
- we introduce a weird impedance between pixels and "pixels with
fractionary bits"
- language bindings will have to choose what to bind, and resort
to manually overriding the API
+ *except* for language bindings based on GObject-Introspection, as
they cannot do manual overrides, thus will replicate the entire
set of entry points
For these reason, we should coalesces every Actor entry point for
pixels and for ClutterUnit into a single entry point taking a float,
like:
void clutter_actor_set_x (ClutterActor *self,
gfloat x);
void clutter_actor_get_size (ClutterActor *self,
gfloat *width,
gfloat *height);
gfloat clutter_actor_get_height (ClutterActor *self);
etc.
The issues I have identified are:
- we'll have a two cases of compiler warnings:
- printf() format of the return values from %d to %f
- clutter_actor_get_size() taking floats instead of unsigned ints
- we'll have a problem with varargs when passing an integer instead
of a floating point value, except on 64bit platforms where the
size of a float is the same as the size of an int
To be clear: the *intent* of the API should not change -- we still use
pixels everywhere -- but:
- we remove ambiguity in the API with regard to pixels and units
- we remove entry points we get to maintain for the whole 1.0
version of the API
- we make things simpler to bind for both manual language bindings
and automatic (gobject-introspection based) ones
- we have the simplest API possible while still exposing the
capabilities of the underlying GL implementation
2009-05-06 11:44:47 -04:00
|
|
|
gfloat x;
|
|
|
|
|
gfloat y;
|
2007-06-11 05:02:40 -04:00
|
|
|
ClutterModifierType modifier_state;
|
2007-03-22 14:21:59 -04:00
|
|
|
guint32 button;
|
2007-09-27 17:38:38 -04:00
|
|
|
guint click_count;
|
2007-03-22 14:21:59 -04:00
|
|
|
gdouble *axes; /* Future use */
|
2009-06-19 08:07:20 -04:00
|
|
|
ClutterInputDevice *device;
|
2006-05-29 04:59:36 -04:00
|
|
|
};
|
|
|
|
|
|
2008-06-27 17:13:19 -04:00
|
|
|
/**
|
|
|
|
|
* ClutterCrossingEvent:
|
|
|
|
|
* @type: event type
|
|
|
|
|
* @time: event time
|
|
|
|
|
* @flags: event flags
|
|
|
|
|
* @stage: event source stage
|
|
|
|
|
* @source: event source actor
|
|
|
|
|
* @x: event X coordinate
|
|
|
|
|
* @y: event Y coordinate
|
|
|
|
|
* @related: actor related to the crossing
|
2008-09-25 07:08:06 -04:00
|
|
|
* @device: reserved for future use
|
2008-06-27 17:13:19 -04:00
|
|
|
*
|
|
|
|
|
* Event for the movement of the pointer across different actors
|
|
|
|
|
*
|
|
|
|
|
* Since: 0.2
|
|
|
|
|
*/
|
2007-10-03 05:28:16 -04:00
|
|
|
struct _ClutterCrossingEvent
|
|
|
|
|
{
|
|
|
|
|
ClutterEventType type;
|
|
|
|
|
guint32 time;
|
|
|
|
|
ClutterEventFlags flags;
|
2008-03-28 18:50:55 -04:00
|
|
|
ClutterStage *stage;
|
2007-11-12 14:12:02 -05:00
|
|
|
ClutterActor *source;
|
2009-06-19 08:07:20 -04:00
|
|
|
|
Remove Units from the public API
With the recent change to internal floating point values, ClutterUnit
has become a redundant type, defined to be a float. All integer entry
points are being internally converted to floating point values to be
passed to the GL pipeline with the least amount of conversion.
ClutterUnit is thus exposed as just a "pixel with fractionary bits",
and not -- as users might think -- as generic, resolution and device
independent units. not that it was the case, but a definitive amount
of people was convinced it did provide this "feature", and was flummoxed
about the mere existence of this type.
So, having ClutterUnit exposed in the public API doubles the entry
points and has the following disadvantages:
- we have to maintain twice the amount of entry points in ClutterActor
- we still do an integer-to-float implicit conversion
- we introduce a weird impedance between pixels and "pixels with
fractionary bits"
- language bindings will have to choose what to bind, and resort
to manually overriding the API
+ *except* for language bindings based on GObject-Introspection, as
they cannot do manual overrides, thus will replicate the entire
set of entry points
For these reason, we should coalesces every Actor entry point for
pixels and for ClutterUnit into a single entry point taking a float,
like:
void clutter_actor_set_x (ClutterActor *self,
gfloat x);
void clutter_actor_get_size (ClutterActor *self,
gfloat *width,
gfloat *height);
gfloat clutter_actor_get_height (ClutterActor *self);
etc.
The issues I have identified are:
- we'll have a two cases of compiler warnings:
- printf() format of the return values from %d to %f
- clutter_actor_get_size() taking floats instead of unsigned ints
- we'll have a problem with varargs when passing an integer instead
of a floating point value, except on 64bit platforms where the
size of a float is the same as the size of an int
To be clear: the *intent* of the API should not change -- we still use
pixels everywhere -- but:
- we remove ambiguity in the API with regard to pixels and units
- we remove entry points we get to maintain for the whole 1.0
version of the API
- we make things simpler to bind for both manual language bindings
and automatic (gobject-introspection based) ones
- we have the simplest API possible while still exposing the
capabilities of the underlying GL implementation
2009-05-06 11:44:47 -04:00
|
|
|
gfloat x;
|
|
|
|
|
gfloat y;
|
2009-06-19 08:07:20 -04:00
|
|
|
ClutterInputDevice *device;
|
2007-10-03 05:28:16 -04:00
|
|
|
ClutterActor *related;
|
|
|
|
|
};
|
|
|
|
|
|
2008-06-27 17:13:19 -04:00
|
|
|
/**
|
|
|
|
|
* ClutterMotionEvent:
|
|
|
|
|
* @type: event type
|
|
|
|
|
* @time: event time
|
|
|
|
|
* @flags: event flags
|
|
|
|
|
* @stage: event source stage
|
|
|
|
|
* @source: event source actor
|
|
|
|
|
* @x: event X coordinate
|
|
|
|
|
* @y: event Y coordinate
|
|
|
|
|
* @modifier_state: button modifiers
|
|
|
|
|
* @axes: reserved for future use
|
|
|
|
|
* @device: reserved for future use
|
|
|
|
|
*
|
|
|
|
|
* Event for the pointer motion
|
|
|
|
|
*
|
|
|
|
|
* Since: 0.2
|
|
|
|
|
*/
|
2006-05-29 04:59:36 -04:00
|
|
|
struct _ClutterMotionEvent
|
|
|
|
|
{
|
2007-03-22 14:21:59 -04:00
|
|
|
ClutterEventType type;
|
|
|
|
|
guint32 time;
|
2007-09-27 17:38:38 -04:00
|
|
|
ClutterEventFlags flags;
|
2008-03-28 18:50:55 -04:00
|
|
|
ClutterStage *stage;
|
2007-11-12 14:12:02 -05:00
|
|
|
ClutterActor *source;
|
2009-06-19 08:07:20 -04:00
|
|
|
|
Remove Units from the public API
With the recent change to internal floating point values, ClutterUnit
has become a redundant type, defined to be a float. All integer entry
points are being internally converted to floating point values to be
passed to the GL pipeline with the least amount of conversion.
ClutterUnit is thus exposed as just a "pixel with fractionary bits",
and not -- as users might think -- as generic, resolution and device
independent units. not that it was the case, but a definitive amount
of people was convinced it did provide this "feature", and was flummoxed
about the mere existence of this type.
So, having ClutterUnit exposed in the public API doubles the entry
points and has the following disadvantages:
- we have to maintain twice the amount of entry points in ClutterActor
- we still do an integer-to-float implicit conversion
- we introduce a weird impedance between pixels and "pixels with
fractionary bits"
- language bindings will have to choose what to bind, and resort
to manually overriding the API
+ *except* for language bindings based on GObject-Introspection, as
they cannot do manual overrides, thus will replicate the entire
set of entry points
For these reason, we should coalesces every Actor entry point for
pixels and for ClutterUnit into a single entry point taking a float,
like:
void clutter_actor_set_x (ClutterActor *self,
gfloat x);
void clutter_actor_get_size (ClutterActor *self,
gfloat *width,
gfloat *height);
gfloat clutter_actor_get_height (ClutterActor *self);
etc.
The issues I have identified are:
- we'll have a two cases of compiler warnings:
- printf() format of the return values from %d to %f
- clutter_actor_get_size() taking floats instead of unsigned ints
- we'll have a problem with varargs when passing an integer instead
of a floating point value, except on 64bit platforms where the
size of a float is the same as the size of an int
To be clear: the *intent* of the API should not change -- we still use
pixels everywhere -- but:
- we remove ambiguity in the API with regard to pixels and units
- we remove entry points we get to maintain for the whole 1.0
version of the API
- we make things simpler to bind for both manual language bindings
and automatic (gobject-introspection based) ones
- we have the simplest API possible while still exposing the
capabilities of the underlying GL implementation
2009-05-06 11:44:47 -04:00
|
|
|
gfloat x;
|
|
|
|
|
gfloat y;
|
2007-06-11 05:02:40 -04:00
|
|
|
ClutterModifierType modifier_state;
|
2007-03-22 14:21:59 -04:00
|
|
|
gdouble *axes; /* Future use */
|
2009-06-19 08:07:20 -04:00
|
|
|
ClutterInputDevice *device;
|
2007-03-22 14:21:59 -04:00
|
|
|
};
|
|
|
|
|
|
2008-06-27 17:13:19 -04:00
|
|
|
/**
|
|
|
|
|
* ClutterScrollEvent:
|
|
|
|
|
* @type: event type
|
|
|
|
|
* @time: event time
|
|
|
|
|
* @flags: event flags
|
|
|
|
|
* @stage: event source stage
|
|
|
|
|
* @source: event source actor
|
|
|
|
|
* @x: event X coordinate
|
|
|
|
|
* @y: event Y coordinate
|
|
|
|
|
* @direction: direction of the scrolling
|
|
|
|
|
* @modifier_state: button modifiers
|
|
|
|
|
* @axes: reserved for future use
|
|
|
|
|
* @device: reserved for future use
|
|
|
|
|
*
|
|
|
|
|
* Scroll wheel (or similar device) event
|
|
|
|
|
*
|
|
|
|
|
* Since: 0.2
|
|
|
|
|
*/
|
2007-03-22 14:21:59 -04:00
|
|
|
struct _ClutterScrollEvent
|
|
|
|
|
{
|
|
|
|
|
ClutterEventType type;
|
|
|
|
|
guint32 time;
|
2007-09-27 17:38:38 -04:00
|
|
|
ClutterEventFlags flags;
|
2008-03-28 18:50:55 -04:00
|
|
|
ClutterStage *stage;
|
2007-11-12 14:12:02 -05:00
|
|
|
ClutterActor *source;
|
2009-06-19 08:07:20 -04:00
|
|
|
|
Remove Units from the public API
With the recent change to internal floating point values, ClutterUnit
has become a redundant type, defined to be a float. All integer entry
points are being internally converted to floating point values to be
passed to the GL pipeline with the least amount of conversion.
ClutterUnit is thus exposed as just a "pixel with fractionary bits",
and not -- as users might think -- as generic, resolution and device
independent units. not that it was the case, but a definitive amount
of people was convinced it did provide this "feature", and was flummoxed
about the mere existence of this type.
So, having ClutterUnit exposed in the public API doubles the entry
points and has the following disadvantages:
- we have to maintain twice the amount of entry points in ClutterActor
- we still do an integer-to-float implicit conversion
- we introduce a weird impedance between pixels and "pixels with
fractionary bits"
- language bindings will have to choose what to bind, and resort
to manually overriding the API
+ *except* for language bindings based on GObject-Introspection, as
they cannot do manual overrides, thus will replicate the entire
set of entry points
For these reason, we should coalesces every Actor entry point for
pixels and for ClutterUnit into a single entry point taking a float,
like:
void clutter_actor_set_x (ClutterActor *self,
gfloat x);
void clutter_actor_get_size (ClutterActor *self,
gfloat *width,
gfloat *height);
gfloat clutter_actor_get_height (ClutterActor *self);
etc.
The issues I have identified are:
- we'll have a two cases of compiler warnings:
- printf() format of the return values from %d to %f
- clutter_actor_get_size() taking floats instead of unsigned ints
- we'll have a problem with varargs when passing an integer instead
of a floating point value, except on 64bit platforms where the
size of a float is the same as the size of an int
To be clear: the *intent* of the API should not change -- we still use
pixels everywhere -- but:
- we remove ambiguity in the API with regard to pixels and units
- we remove entry points we get to maintain for the whole 1.0
version of the API
- we make things simpler to bind for both manual language bindings
and automatic (gobject-introspection based) ones
- we have the simplest API possible while still exposing the
capabilities of the underlying GL implementation
2009-05-06 11:44:47 -04:00
|
|
|
gfloat x;
|
|
|
|
|
gfloat y;
|
2007-03-22 14:21:59 -04:00
|
|
|
ClutterScrollDirection direction;
|
2007-06-11 05:02:40 -04:00
|
|
|
ClutterModifierType modifier_state;
|
2007-03-22 14:21:59 -04:00
|
|
|
gdouble *axes; /* future use */
|
2009-06-19 08:07:20 -04:00
|
|
|
ClutterInputDevice *device;
|
2007-03-22 14:21:59 -04:00
|
|
|
};
|
|
|
|
|
|
2008-06-27 17:13:19 -04:00
|
|
|
/**
|
|
|
|
|
* ClutterStageStateEvent:
|
|
|
|
|
* @type: event type
|
|
|
|
|
* @time: event time
|
|
|
|
|
* @flags: event flags
|
|
|
|
|
* @stage: event source stage
|
|
|
|
|
* @source: event source actor (unused)
|
|
|
|
|
* @changed_mask: bitwise OR of the changed flags
|
|
|
|
|
* @new_state: bitwise OR of the current state flags
|
|
|
|
|
*
|
|
|
|
|
* Event signalling a change in the #ClutterStage state.
|
|
|
|
|
*
|
|
|
|
|
* Since: 0.2
|
|
|
|
|
*/
|
2007-03-22 14:21:59 -04:00
|
|
|
struct _ClutterStageStateEvent
|
|
|
|
|
{
|
|
|
|
|
ClutterEventType type;
|
2007-09-27 17:38:38 -04:00
|
|
|
guint32 time;
|
|
|
|
|
ClutterEventFlags flags;
|
2008-03-28 18:50:55 -04:00
|
|
|
ClutterStage *stage;
|
2009-06-19 08:07:20 -04:00
|
|
|
ClutterActor *source; /* XXX: should probably be the stage itself */
|
|
|
|
|
|
2007-03-22 14:21:59 -04:00
|
|
|
ClutterStageState changed_mask;
|
|
|
|
|
ClutterStageState new_state;
|
2006-05-29 04:59:36 -04:00
|
|
|
};
|
|
|
|
|
|
2012-03-19 09:47:19 -04:00
|
|
|
/**
|
|
|
|
|
* ClutterTouchEvent:
|
|
|
|
|
* @type: event type
|
|
|
|
|
* @time: event time
|
|
|
|
|
* @flags: event flags
|
|
|
|
|
* @stage: event source stage
|
|
|
|
|
* @source: event source actor (unused)
|
|
|
|
|
* @x: the X coordinate of the pointer, relative to the stage
|
|
|
|
|
* @y: the Y coordinate of the pointer, relative to the stage
|
2012-03-19 10:57:46 -04:00
|
|
|
* @sequence: the event sequence that this event belongs to
|
|
|
|
|
* @modifier_state: (type ClutterModifierType): a bit-mask representing the state
|
2012-03-19 09:47:19 -04:00
|
|
|
* of modifier keys (e.g. Control, Shift, and Alt) and the pointer
|
|
|
|
|
* buttons. See #ClutterModifierType
|
2012-03-19 10:57:46 -04:00
|
|
|
* @axes: reserved
|
2012-03-19 09:47:19 -04:00
|
|
|
* @device: the device that originated the event
|
|
|
|
|
*
|
|
|
|
|
* Used for touch events.
|
|
|
|
|
*
|
|
|
|
|
* The @type field will be one of %CLUTTER_TOUCH_BEGIN, %CLUTTER_TOUCH_END,
|
|
|
|
|
* %CLUTTER_TOUCH_UPDATE, or %CLUTTER_TOUCH_CANCEL.
|
|
|
|
|
*
|
|
|
|
|
* Touch events are grouped into sequences; each touch sequence will begin
|
|
|
|
|
* with a %CLUTTER_TOUCH_BEGIN event, progress with %CLUTTER_TOUCH_UPDATE
|
|
|
|
|
* events, and end either with a %CLUTTER_TOUCH_END event or with a
|
|
|
|
|
* %CLUTTER_TOUCH_CANCEL event.
|
|
|
|
|
*
|
|
|
|
|
* With multi-touch capable devices there can be multiple event sequence
|
|
|
|
|
* running at the same time.
|
|
|
|
|
*
|
|
|
|
|
* Since: 1.10
|
|
|
|
|
*/
|
|
|
|
|
struct _ClutterTouchEvent
|
|
|
|
|
{
|
|
|
|
|
ClutterEventType type;
|
|
|
|
|
guint32 time;
|
|
|
|
|
ClutterEventFlags flags;
|
|
|
|
|
ClutterStage *stage;
|
|
|
|
|
ClutterActor *source;
|
|
|
|
|
|
|
|
|
|
gfloat x;
|
|
|
|
|
gfloat y;
|
|
|
|
|
ClutterEventSequence *sequence;
|
|
|
|
|
ClutterModifierType modifier_state;
|
2012-03-19 10:57:46 -04:00
|
|
|
gdouble *axes; /* reserved */
|
2012-03-19 09:47:19 -04:00
|
|
|
ClutterInputDevice *device;
|
|
|
|
|
};
|
|
|
|
|
|
2008-06-27 17:13:19 -04:00
|
|
|
/**
|
|
|
|
|
* ClutterEvent:
|
|
|
|
|
*
|
|
|
|
|
* Generic event wrapper.
|
|
|
|
|
*
|
|
|
|
|
* Since: 0.2
|
|
|
|
|
*/
|
2006-05-29 04:59:36 -04:00
|
|
|
union _ClutterEvent
|
|
|
|
|
{
|
2010-05-19 11:10:05 -04:00
|
|
|
/*< private >*/
|
2007-03-22 14:21:59 -04:00
|
|
|
ClutterEventType type;
|
2008-06-27 17:13:19 -04:00
|
|
|
|
2007-03-22 14:21:59 -04:00
|
|
|
ClutterAnyEvent any;
|
2006-07-10 06:52:04 -04:00
|
|
|
ClutterButtonEvent button;
|
2007-03-22 14:21:59 -04:00
|
|
|
ClutterKeyEvent key;
|
2006-07-10 06:52:04 -04:00
|
|
|
ClutterMotionEvent motion;
|
2007-03-22 14:21:59 -04:00
|
|
|
ClutterScrollEvent scroll;
|
|
|
|
|
ClutterStageStateEvent stage_state;
|
2007-10-03 05:28:16 -04:00
|
|
|
ClutterCrossingEvent crossing;
|
2012-03-19 09:47:19 -04:00
|
|
|
ClutterTouchEvent touch;
|
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
|
|
|
GType clutter_event_get_type (void) G_GNUC_CONST;
|
|
|
|
|
|
2011-02-22 12:12:34 -05:00
|
|
|
gboolean clutter_events_pending (void);
|
|
|
|
|
ClutterEvent * clutter_event_get (void);
|
|
|
|
|
ClutterEvent * clutter_event_peek (void);
|
|
|
|
|
void clutter_event_put (const ClutterEvent *event);
|
|
|
|
|
|
|
|
|
|
ClutterEvent * clutter_event_new (ClutterEventType type);
|
|
|
|
|
ClutterEvent * clutter_event_copy (const ClutterEvent *event);
|
|
|
|
|
void clutter_event_free (ClutterEvent *event);
|
|
|
|
|
|
|
|
|
|
ClutterEventType clutter_event_type (const ClutterEvent *event);
|
|
|
|
|
void clutter_event_set_flags (ClutterEvent *event,
|
|
|
|
|
ClutterEventFlags flags);
|
|
|
|
|
ClutterEventFlags clutter_event_get_flags (const ClutterEvent *event);
|
|
|
|
|
void clutter_event_set_time (ClutterEvent *event,
|
|
|
|
|
guint32 time_);
|
|
|
|
|
guint32 clutter_event_get_time (const ClutterEvent *event);
|
|
|
|
|
void clutter_event_set_state (ClutterEvent *event,
|
|
|
|
|
ClutterModifierType state);
|
|
|
|
|
ClutterModifierType clutter_event_get_state (const ClutterEvent *event);
|
|
|
|
|
void clutter_event_set_device (ClutterEvent *event,
|
|
|
|
|
ClutterInputDevice *device);
|
|
|
|
|
ClutterInputDevice * clutter_event_get_device (const ClutterEvent *event);
|
|
|
|
|
void clutter_event_set_source_device (ClutterEvent *event,
|
|
|
|
|
ClutterInputDevice *device);
|
|
|
|
|
|
|
|
|
|
ClutterInputDevice * clutter_event_get_source_device (const ClutterEvent *event);
|
2011-06-09 10:40:26 -04:00
|
|
|
void clutter_event_set_source (ClutterEvent *event,
|
|
|
|
|
ClutterActor *actor);
|
2011-02-22 12:12:34 -05:00
|
|
|
ClutterActor * clutter_event_get_source (const ClutterEvent *event);
|
|
|
|
|
void clutter_event_set_stage (ClutterEvent *event,
|
|
|
|
|
ClutterStage *stage);
|
|
|
|
|
ClutterStage * clutter_event_get_stage (const ClutterEvent *event);
|
|
|
|
|
|
|
|
|
|
gint clutter_event_get_device_id (const ClutterEvent *event);
|
|
|
|
|
ClutterInputDeviceType clutter_event_get_device_type (const ClutterEvent *event);
|
|
|
|
|
|
|
|
|
|
void clutter_event_set_coords (ClutterEvent *event,
|
|
|
|
|
gfloat x,
|
|
|
|
|
gfloat y);
|
|
|
|
|
void clutter_event_get_coords (const ClutterEvent *event,
|
|
|
|
|
gfloat *x,
|
|
|
|
|
gfloat *y);
|
2012-04-19 07:16:54 -04:00
|
|
|
CLUTTER_AVAILABLE_IN_1_12
|
|
|
|
|
void clutter_event_get_position (const ClutterEvent *event,
|
|
|
|
|
ClutterPoint *position);
|
|
|
|
|
CLUTTER_AVAILABLE_IN_1_12
|
|
|
|
|
float clutter_event_get_distance (const ClutterEvent *source,
|
|
|
|
|
const ClutterEvent *target);
|
|
|
|
|
CLUTTER_AVAILABLE_IN_1_12
|
|
|
|
|
double clutter_event_get_angle (const ClutterEvent *source,
|
|
|
|
|
const ClutterEvent *target);
|
2011-02-22 12:12:34 -05:00
|
|
|
|
|
|
|
|
gdouble * clutter_event_get_axes (const ClutterEvent *event,
|
|
|
|
|
guint *n_axes);
|
|
|
|
|
|
|
|
|
|
void clutter_event_set_key_symbol (ClutterEvent *event,
|
|
|
|
|
guint key_sym);
|
|
|
|
|
guint clutter_event_get_key_symbol (const ClutterEvent *event);
|
|
|
|
|
void clutter_event_set_key_code (ClutterEvent *event,
|
|
|
|
|
guint16 key_code);
|
|
|
|
|
guint16 clutter_event_get_key_code (const ClutterEvent *event);
|
|
|
|
|
void clutter_event_set_key_unicode (ClutterEvent *event,
|
|
|
|
|
guint32 key_unicode);
|
|
|
|
|
guint32 clutter_event_get_key_unicode (const ClutterEvent *event);
|
|
|
|
|
|
|
|
|
|
void clutter_event_set_button (ClutterEvent *event,
|
|
|
|
|
guint32 button);
|
|
|
|
|
guint32 clutter_event_get_button (const ClutterEvent *event);
|
|
|
|
|
guint clutter_event_get_click_count (const ClutterEvent *event);
|
|
|
|
|
|
|
|
|
|
void clutter_event_set_related (ClutterEvent *event,
|
|
|
|
|
ClutterActor *actor);
|
|
|
|
|
ClutterActor * clutter_event_get_related (const ClutterEvent *event);
|
|
|
|
|
|
|
|
|
|
void clutter_event_set_scroll_direction (ClutterEvent *event,
|
|
|
|
|
ClutterScrollDirection direction);
|
|
|
|
|
ClutterScrollDirection clutter_event_get_scroll_direction (const ClutterEvent *event);
|
2012-03-19 08:15:41 -04:00
|
|
|
CLUTTER_AVAILABLE_IN_1_10
|
|
|
|
|
void clutter_event_set_scroll_delta (ClutterEvent *event,
|
|
|
|
|
gdouble dx,
|
|
|
|
|
gdouble dy);
|
|
|
|
|
CLUTTER_AVAILABLE_IN_1_10
|
|
|
|
|
void clutter_event_get_scroll_delta (const ClutterEvent *event,
|
|
|
|
|
gdouble *dx,
|
|
|
|
|
gdouble *dy);
|
2011-02-22 12:12:34 -05:00
|
|
|
|
2012-03-19 09:47:19 -04:00
|
|
|
CLUTTER_AVAILABLE_IN_1_10
|
|
|
|
|
ClutterEventSequence * clutter_event_get_event_sequence (const ClutterEvent *event);
|
|
|
|
|
|
2011-02-22 12:12:34 -05:00
|
|
|
guint32 clutter_keysym_to_unicode (guint keyval);
|
2012-02-27 11:31:53 -05:00
|
|
|
CLUTTER_AVAILABLE_IN_1_10
|
2011-10-07 07:05:39 -04:00
|
|
|
guint clutter_unicode_to_keysym (guint32 wc);
|
2011-02-22 12:12:34 -05:00
|
|
|
|
|
|
|
|
guint32 clutter_get_current_event_time (void);
|
Eliminate G_CONST_RETURN
The G_CONST_RETURN define in GLib is, and has always been, a bit fuzzy.
We always used it to conform to the platform, at least for public-facing
API.
At first I assumed it has something to do with brain-damaged compilers
or with weird platforms where const was not really supported; sadly,
it's something much, much worse: it's a define that can be toggled at
compile-time to remove const from the signature of public API. This is a
truly terrifying feature that I assume was added in the past century,
and whose inception clearly had something to do with massive doses of
absynthe and opium — because any other explanation would make the
existence of such a feature even worse than assuming drugs had anything
to do with it.
Anyway, and pleasing the gods, this dubious feature is being
removed/deprecated in GLib; see bug:
https://bugzilla.gnome.org/show_bug.cgi?id=644611
Before deprecation, though, we should just remove its usage from the
whole API. We should especially remove its usage from Cally's internals,
since there it never made sense in the first place.
2011-06-07 10:49:20 -04:00
|
|
|
const ClutterEvent * clutter_get_current_event (void);
|
2009-06-06 10:27:37 -04:00
|
|
|
|
2006-05-29 04:59:36 -04:00
|
|
|
G_END_DECLS
|
|
|
|
|
|
2008-10-30 13:04:34 -04:00
|
|
|
#endif /* __CLUTTER_EVENT_H__ */
|