brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
54101b1948
mutter/clutter/clutter/clutter-backend-private.h

166 lines
7.9 KiB
C
Raw Normal View History

Add copyright notices
2010-10-21 12:13:00 +00:00
/*
* Clutter.
*
* An OpenGL based 'interactive canvas' library.
*
* Copyright (C) 2010 Intel Corporation.
*
* 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, see <http://www.gnu.org/licenses/>.
*/
Clean up clutter-private.h/4 Move the private Backend API to a separate header. This also allows us to finally move the class vtable and instance structure to a separate file and plug the visibility hole that left the Backend class bare for everyone to poke into.
2010-10-21 10:49:37 +00:00
#ifndef __CLUTTER_BACKEND_PRIVATE_H__
#define __CLUTTER_BACKEND_PRIVATE_H__
#include <clutter/clutter-backend.h>
Clean up the windowing system defines Instead of defining new symbols for the windowing systems enabled at configure time, we can reuse the same symbols for both the compile time and run time checks, e.g.: #ifdef CLUTTER_WINDOWING_X11 if (clutter_check_windowing_backend (CLUTTER_WINDOWING_X11)) /* use the clutter_x11_* API */ else #endif #ifdef CLUTTER_WINDOWING_WIN32 if (clutter_check_windowing_backend (CLUTTER_WINDOWING_WIN32)) /* use the clutter_win32_* API */ #endif This scheme allows us to ensure that the input system namespace is free for us to use and select at run time in later versions of Clutter.
2011-10-17 15:03:19 +00:00
#include <clutter/clutter-device-manager.h>
evdev: Implement ClutterKeymap Just move the minimal bits to this ClutterKeymapEvdev object. Much of the functionality of a keymap is spread along ClutterSeatEvdev, ClutterDeviceManagerEvdev and ClutterVirtualInputDevice. Future refactors are due here. Also, ideally keymaps are per-seat objects (at least keyboard state is). We don't expose much info about seats altogether outside the evdev device manager implementation. We just poke the main seat at places, but eventually seats should be public.
2019-01-10 15:13:20 +00:00
#include <clutter/clutter-keymap.h>
Clean up the windowing system defines Instead of defining new symbols for the windowing systems enabled at configure time, we can reuse the same symbols for both the compile time and run time checks, e.g.: #ifdef CLUTTER_WINDOWING_X11 if (clutter_check_windowing_backend (CLUTTER_WINDOWING_X11)) /* use the clutter_x11_* API */ else #endif #ifdef CLUTTER_WINDOWING_WIN32 if (clutter_check_windowing_backend (CLUTTER_WINDOWING_WIN32)) /* use the clutter_win32_* API */ #endif This scheme allows us to ensure that the input system namespace is free for us to use and select at run time in later versions of Clutter.
2011-10-17 15:03:19 +00:00
#include <clutter/clutter-stage-window.h>
backend: Move event translators to the base class In the future, we want event translators to be the way to handle events in backends. For this reason, they should be a part of the base abstract ClutterBackend class, and not an X11-only concept.
2011-02-09 12:20:56 +00:00
#include "clutter-event-translator.h"
Clean up clutter-private.h/4 Move the private Backend API to a separate header. This also allows us to finally move the class vtable and instance structure to a separate file and plug the visibility hole that left the Backend class bare for everyone to poke into.
2010-10-21 10:49:37 +00:00
#define CLUTTER_BACKEND_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), CLUTTER_TYPE_BACKEND, ClutterBackendClass))
#define CLUTTER_IS_BACKEND_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), CLUTTER_TYPE_BACKEND))
#define CLUTTER_BACKEND_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), CLUTTER_TYPE_BACKEND, ClutterBackendClass))
G_BEGIN_DECLS
typedef struct _ClutterBackendPrivate ClutterBackendPrivate;
struct _ClutterBackend
{
/*< private >*/
backend: Clean up the device manager creation Create the device manager during the event initialization, where it makes sense. This allows us to get rid of the per-backend get_device_manager() virtual function, and just store the DeviceManager pointer into the ClutterBackend structure.
2011-11-04 19:25:54 +00:00
GObject parent_instance;
Moves all GLX code down from Clutter to Cogl This migrates all the GLX window system code down from the Clutter backend code into a Cogl winsys. Moving OpenGL window system binding code down from Clutter into Cogl is the biggest blocker to having Cogl become a standalone 3D graphics library, so this is an important step in that direction.
2010-11-05 12:28:33 +00:00
backend: Clean up the device manager creation Create the device manager during the event initialization, where it makes sense. This allows us to get rid of the per-backend get_device_manager() virtual function, and just store the DeviceManager pointer into the ClutterBackend structure.
2011-11-04 19:25:54 +00:00
CoglRenderer *cogl_renderer;
CoglDisplay *cogl_display;
CoglContext *cogl_context;
clutter-backend: Use the Cogl main loop mechanism Cogl now requires that all applications integrate their main loop with Cogl so that it can listen for events from winsys. This patch just adds Cogl's GSource to the main loop. Reviewed-by: Emmanuele Bassi <ebassi@linux.intel.com> Reviewed-by: Robert Bragg <robert@linux.intel.com>
2011-12-21 15:13:53 +00:00
GSource *cogl_source;
backend: Clean up the device manager creation Create the device manager during the event initialization, where it makes sense. This allows us to get rid of the per-backend get_device_manager() virtual function, and just store the DeviceManager pointer into the ClutterBackend structure.
2011-11-04 19:25:54 +00:00
x11: stage window: reset framebuffer on foreign window unrealize Similarly to 13dbb74c81bec861d3a135fb53966ae5562831a7, we need to reset the framebuffer in the x11 for foreign windows. https://bugzilla.gnome.org/show_bug.cgi?id=755014
2015-09-14 23:30:05 +00:00
CoglOnscreen *dummy_onscreen;
backend: Clean up the device manager creation Create the device manager during the event initialization, where it makes sense. This allows us to get rid of the per-backend get_device_manager() virtual function, and just store the DeviceManager pointer into the ClutterBackend structure.
2011-11-04 19:25:54 +00:00
ClutterDeviceManager *device_manager;
Moves all GLX code down from Clutter to Cogl This migrates all the GLX window system code down from the Clutter backend code into a Cogl winsys. Moving OpenGL window system binding code down from Clutter into Cogl is the biggest blocker to having Cogl become a standalone 3D graphics library, so this is an important step in that direction.
2010-11-05 12:28:33 +00:00
backend: Remove unnecessary private data structure The whole of ClutterBackend is a final/protected type, so having a bunch of instance fields and an instance private data structure is redundant at best, and less efficient at worst.
2015-07-08 10:10:45 +00:00
cairo_font_options_t *font_options;
gchar *font_name;
gfloat units_per_em;
gint32 units_serial;
GList *event_translators;
clutter: Add ClutterBackend IM setter/getter The input method will be global to Clutter and shared between all the IM aware foci. These methods allow querying it and setting one up.
2017-12-06 11:44:55 +00:00
ClutterInputMethod *input_method;
evdev: Implement ClutterKeymap Just move the minimal bits to this ClutterKeymapEvdev object. Much of the functionality of a keymap is spread along ClutterSeatEvdev, ClutterDeviceManagerEvdev and ClutterVirtualInputDevice. Future refactors are due here. Also, ideally keymaps are per-seat objects (at least keyboard state is). We don't expose much info about seats altogether outside the evdev device manager implementation. We just poke the main seat at places, but eventually seats should be public.
2019-01-10 15:13:20 +00:00
ClutterKeymap *keymap;
Clean up clutter-private.h/4 Move the private Backend API to a separate header. This also allows us to finally move the class vtable and instance structure to a separate file and plug the visibility hole that left the Backend class bare for everyone to poke into.
2010-10-21 10:49:37 +00:00
};
struct _ClutterBackendClass
{
/*< private >*/
GObjectClass parent_class;
/* vfuncs */
gboolean (* pre_parse) (ClutterBackend *backend,
GError **error);
gboolean (* post_parse) (ClutterBackend *backend,
GError **error);
ClutterStageWindow * (* create_stage) (ClutterBackend *backend,
ClutterStage *wrapper,
GError **error);
void (* init_events) (ClutterBackend *backend);
void (* init_features) (ClutterBackend *backend);
void (* add_options) (ClutterBackend *backend,
GOptionGroup *group);
ClutterFeatureFlags (* get_features) (ClutterBackend *backend);
backend: Provide a default create_context() Since we use Cogl for the context creation we can now provide a default context creation that should just work, plus a couple of hooks to allow plugging into the creation sequence for platforms supported by Cogl that require special handling — like foreign displays or alpha-enabled swap chains. The various backends have now two choices: either replace the create_context() in its entirety, or plug themselves into the default context creation.
2011-11-04 15:50:47 +00:00
CoglRenderer * (* get_renderer) (ClutterBackend *backend,
GError **error);
CoglDisplay * (* get_display) (ClutterBackend *backend,
CoglRenderer *renderer,
CoglSwapChain *swap_chain,
GError **error);
Clean up clutter-private.h/4 Move the private Backend API to a separate header. This also allows us to finally move the class vtable and instance structure to a separate file and plug the visibility hole that left the Backend class bare for everyone to poke into.
2010-10-21 10:49:37 +00:00
gboolean (* create_context) (ClutterBackend *backend,
GError **error);
ClutterDeviceManager *(* get_device_manager) (ClutterBackend *backend);
void (* copy_event_data) (ClutterBackend *backend,
const ClutterEvent *src,
ClutterEvent *dest);
void (* free_event_data) (ClutterBackend *backend,
ClutterEvent *event);
event/x11: Rework the way we translate X11 events This is a lump commit that is fairly difficult to break down without either breaking bisecting or breaking the test cases. The new design for handling X11 event translation works this way: - ClutterBackend::translate_event() has been added as the central point used by a ClutterBackend implementation to translate a native event into a ClutterEvent; - ClutterEventTranslator is a private interface that should be implemented by backend-specific objects, like stage implementations and ClutterDeviceManager sub-classes, and allows dealing with class-specific event translation; - ClutterStageX11 implements EventTranslator, and deals with the stage-relative X11 events coming from the X11 event source; - ClutterStageGLX overrides EventTranslator, in order to deal with the INTEL_GLX_swap_event extension, and it chains up to the X11 default implementation; - ClutterDeviceManagerX11 has been split into two separate classes, one that deals with core and (optionally) XI1 events, and the other that deals with XI2 events; the selection is done at run-time, since the core+XI1 and XI2 mechanisms are mutually exclusive. All the other backends we officially support still use their own custom event source and translation function, but the end goal is to migrate them to the translate_event() virtual function, and have the event source be a shared part of Clutter core.
2011-01-04 12:32:04 +00:00
gboolean (* translate_event) (ClutterBackend *backend,
gpointer native,
ClutterEvent *event);
backend: Add private accessor for the keymap direction We need to ask the backend (wherever possible) for the direction of the current keymap. https://bugzilla.gnome.org/show_bug.cgi?id=705779
2014-03-03 23:22:13 +00:00
PangoDirection (* get_keymap_direction) (ClutterBackend *backend);
clutter/backend: Add bell-notify We'll need a way to trigger a bell from within clutter for keyboard accessibility features, add the necessary hooks to be able to call a backend bell-notify method. https://bugzilla.gnome.org/show_bug.cgi?id=788564
2017-10-12 13:03:48 +00:00
void (* bell_notify) (ClutterBackend *backend);
clutter: Add generic ClutterKeymap object We thus far have similar objects/code internal to backends. Expose the minimum API necessary to cater for gnome-shell as a generic object. So far only the X11 backend has an actual GObject for it, and was made to be a subclass right away.
2019-01-10 11:34:28 +00:00
ClutterKeymap * (* get_keymap) (ClutterBackend *backend);
Clean up clutter-private.h/4 Move the private Backend API to a separate header. This also allows us to finally move the class vtable and instance structure to a separate file and plug the visibility hole that left the Backend class bare for everyone to poke into.
2010-10-21 10:49:37 +00:00
/* signals */
void (* resolution_changed) (ClutterBackend *backend);
void (* font_changed) (ClutterBackend *backend);
void (* settings_changed) (ClutterBackend *backend);
};
Add API to restrict the windowing backend to load In situations when the default backend would fail (for example when compiled with X11 support but run without DISPLAY), or when the application is using backend specific code, it makes sense to let the application choose the backend explicitly. https://bugzilla.gnome.org/show_bug.cgi?id=707869
2013-09-10 16:29:28 +00:00
ClutterBackend * _clutter_create_backend (void);
backend: Remove ClutterBackend::redraw The ::redraw virtual function was a throwback from olden times, and has been thoroughly replaced by the equivalent vfunc on the StageWindow interface. We can safely remove it, now, and simplify the flow of the redraw code inside ClutterStage.
2012-01-12 13:31:21 +00:00
ClutterStageWindow * _clutter_backend_create_stage (ClutterBackend *backend,
ClutterStage *wrapper,
GError **error);
gboolean _clutter_backend_create_context (ClutterBackend *backend,
GError **error);
void _clutter_backend_add_options (ClutterBackend *backend,
GOptionGroup *group);
gboolean _clutter_backend_pre_parse (ClutterBackend *backend,
GError **error);
gboolean _clutter_backend_post_parse (ClutterBackend *backend,
GError **error);
void _clutter_backend_init_events (ClutterBackend *backend);
void _clutter_backend_copy_event_data (ClutterBackend *backend,
const ClutterEvent *src,
ClutterEvent *dest);
void _clutter_backend_free_event_data (ClutterBackend *backend,
ClutterEvent *event);
gboolean _clutter_backend_translate_event (ClutterBackend *backend,
gpointer native,
ClutterEvent *event);
Explicitly create per backend stage windows Split the stage window implementations into three separate objects: one for X11 as a compositing manager, one for X11 running as a nested Wayland compositor, and one for running with the native backend. The new stage window implementations are only thin shells; this is in preparation for making the stage windows behave more differently. https://bugzilla.gnome.org/show_bug.cgi?id=768976
2016-05-20 07:58:10 +00:00
clutter: Remove clutter specific version Use the mutter version when something is still needed.
2018-05-22 21:01:54 +00:00
CLUTTER_EXPORT
backend: Remove ClutterBackend::redraw The ::redraw virtual function was a throwback from olden times, and has been thoroughly replaced by the equivalent vfunc on the StageWindow interface. We can safely remove it, now, and simplify the flow of the redraw code inside ClutterStage.
2012-01-12 13:31:21 +00:00
void _clutter_backend_add_event_translator (ClutterBackend *backend,
ClutterEventTranslator *translator);
Explicitly create per backend stage windows Split the stage window implementations into three separate objects: one for X11 as a compositing manager, one for X11 running as a nested Wayland compositor, and one for running with the native backend. The new stage window implementations are only thin shells; this is in preparation for making the stage windows behave more differently. https://bugzilla.gnome.org/show_bug.cgi?id=768976
2016-05-20 07:58:10 +00:00
backend: Remove ClutterBackend::redraw The ::redraw virtual function was a throwback from olden times, and has been thoroughly replaced by the equivalent vfunc on the StageWindow interface. We can safely remove it, now, and simplify the flow of the redraw code inside ClutterStage.
2012-01-12 13:31:21 +00:00
void _clutter_backend_remove_event_translator (ClutterBackend *backend,
ClutterEventTranslator *translator);
ClutterFeatureFlags _clutter_backend_get_features (ClutterBackend *backend);
gfloat _clutter_backend_get_units_per_em (ClutterBackend *backend,
PangoFontDescription *font_desc);
gint32 _clutter_backend_get_units_serial (ClutterBackend *backend);
backend: Move event translators to the base class In the future, we want event translators to be the way to handle events in backends. For this reason, they should be a part of the base abstract ClutterBackend class, and not an X11-only concept.
2011-02-09 12:20:56 +00:00
backend: Add private accessor for the keymap direction We need to ask the backend (wherever possible) for the direction of the current keymap. https://bugzilla.gnome.org/show_bug.cgi?id=705779
2014-03-03 23:22:13 +00:00
PangoDirection _clutter_backend_get_keymap_direction (ClutterBackend *backend);
clutter: Remove clutter specific version Use the mutter version when something is still needed.
2018-05-22 21:01:54 +00:00
CLUTTER_EXPORT
x11: stage window: reset framebuffer on foreign window unrealize Similarly to 13dbb74c81bec861d3a135fb53966ae5562831a7, we need to reset the framebuffer in the x11 for foreign windows. https://bugzilla.gnome.org/show_bug.cgi?id=755014
2015-09-14 23:30:05 +00:00
void _clutter_backend_reset_cogl_framebuffer (ClutterBackend *backend);
Allow overriding the list of Cogl drivers via configuration file Clutter has a configuration file that can be used to override various settings, including the ones from environment variables.
2015-12-10 16:52:45 +00:00
void clutter_set_allowed_drivers (const char *drivers);
x11: stage window: reset framebuffer on foreign window unrealize Similarly to 13dbb74c81bec861d3a135fb53966ae5562831a7, we need to reset the framebuffer in the x11 for foreign windows. https://bugzilla.gnome.org/show_bug.cgi?id=755014
2015-09-14 23:30:05 +00:00
Clean up clutter-private.h/4 Move the private Backend API to a separate header. This also allows us to finally move the class vtable and instance structure to a separate file and plug the visibility hole that left the Backend class bare for everyone to poke into.
2010-10-21 10:49:37 +00:00
G_END_DECLS
#endif /* __CLUTTER_BACKEND_PRIVATE_H__ */
Reference in New Issue Copy Permalink