brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
75d8fedcf5
mutter/clutter/clutter/clutter-mutter.h

131 lines
4.5 KiB
C
Raw Normal View History

Make mutter manage its own clutter backends Introduce two new clutter backends: MetaClutterBackendX11 and MetaClutterBackendNative. They are so far only wrap ClutterBackendX11 and ClutterBackendEglNative respectively, but the aim is to move things from the original clutter backends when needed. https://bugzilla.gnome.org/show_bug.cgi?id=768976
2016-05-04 08:19:23 +00:00
/*
* Clutter.
*
* An OpenGL based 'interactive canvas' library.
*
* Copyright (C) 2016 Red Hat Inc.
*
* 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/>.
*
*/
#ifndef __CLUTTER_MUTTER_H__
#define __CLUTTER_MUTTER_H__
#define __CLUTTER_H_INSIDE__
#include "clutter-backend.h"
backends: Shuffle ClutterBackendX11 code into MetaClutterBackendX11 We have a Clutter implementation of the X11, just to subclass it in our backends. Move the implementation entirely to src/backends/x11. Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1862>
2021-05-10 21:40:49 +00:00
#include "clutter-backend-private.h"
clutter: Make ClutterDamageHistory API public to mutter We are moving things to src/backends, make this helper object able to be used there. This is a temporary measure as ClutterDamageHistory itself should be moved too. Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1862>
2021-05-10 14:13:25 +00:00
#include "clutter-damage-history.h"
clutter: Move X11 input to src/backends/x11 The end goal is to have all clutter backend code in src/backends. Input is the larger chunk of it, which is now part of our specific MutterClutterBackendX11, this extends to device manager, input devices, tools and keymap. This was supposed to be nice and incremental, but there's no sane way to cut this through. As a result of the refactor, a number of private Clutter functions are now exported for external backends to be possible. https://gitlab.gnome.org/GNOME/mutter/merge_requests/672
2019-03-22 12:53:00 +00:00
#include "clutter-event-private.h"
clutter: Drop ClutterDeviceManager This is mostly replaced by ClutterSeat, which offers a per-seat instead of a global device abstraction. https://gitlab.gnome.org/GNOME/mutter/merge_requests/852
2019-10-04 21:01:54 +00:00
#include "clutter-input-device-private.h"
clutter: Move X11 input to src/backends/x11 The end goal is to have all clutter backend code in src/backends. Input is the larger chunk of it, which is now part of our specific MutterClutterBackendX11, this extends to device manager, input devices, tools and keymap. This was supposed to be nice and incremental, but there's no sane way to cut this through. As a result of the refactor, a number of private Clutter functions are now exported for external backends to be possible. https://gitlab.gnome.org/GNOME/mutter/merge_requests/672
2019-03-22 12:53:00 +00:00
#include "clutter-input-pointer-a11y-private.h"
Make mutter manage its own clutter backends Introduce two new clutter backends: MetaClutterBackendX11 and MetaClutterBackendNative. They are so far only wrap ClutterBackendX11 and ClutterBackendEglNative respectively, but the aim is to move things from the original clutter backends when needed. https://bugzilla.gnome.org/show_bug.cgi?id=768976
2016-05-04 08:19:23 +00:00
#include "clutter-macros.h"
clutter: Move X11 input to src/backends/x11 The end goal is to have all clutter backend code in src/backends. Input is the larger chunk of it, which is now part of our specific MutterClutterBackendX11, this extends to device manager, input devices, tools and keymap. This was supposed to be nice and incremental, but there's no sane way to cut this through. As a result of the refactor, a number of private Clutter functions are now exported for external backends to be possible. https://gitlab.gnome.org/GNOME/mutter/merge_requests/672
2019-03-22 12:53:00 +00:00
#include "clutter-private.h"
#include "clutter-stage-private.h"
Introduce regional stage rendering Add support for drawing a stage using multiple framebuffers each making up one part of the stage. This works by the stage backend (ClutterStageWindow) providing a list of views which will be for splitting up the stage in different regions. A view layout, for now, is a set of rectangles. The stage window (i.e. stage "backend" will use this information when drawing a frame, using one framebuffer for each view. The scene graph is adapted to explictly take a view when painting the stage. It will use this view, its assigned framebuffer and layout to offset and clip the drawing accordingly. This effectively removes any notion of "stage framebuffer", since each stage now may consist of multiple framebuffers. Therefore, API involving this has been deprecated and made no-ops; namely clutter_stage_ensure_context(). Callers are now assumed to either always use a framebuffer reference explicitly, or push/pop the framebuffer of a given view where the code has not yet changed to use the explicit-buffer-using cogl API. Currently only the nested X11 backend supports this mode fully, and the per view framebuffers are all offscreen. Upon frame completion, it'll blit each view's framebuffer onto the onscreen framebuffer before swapping. Other backends (X11 CM and native/KMS) are adapted to manage a full-stage view. The X11 CM backend will continue to use this method, while the native/KMS backend will be adopted to use multiple view drawing. https://bugzilla.gnome.org/show_bug.cgi?id=768976
2016-05-27 03:09:24 +00:00
#include "clutter-stage-view.h"
clutter: Make ClutterStageView API public to mutter All subclasses and stage implementations will come from src/backends, so this internal API must be accessible there. Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1862>
2021-05-10 14:16:15 +00:00
#include "clutter-stage-view-private.h"
backends: Shuffle ClutterBackendX11 code into MetaClutterBackendX11 We have a Clutter implementation of the X11, just to subclass it in our backends. Move the implementation entirely to src/backends/x11. Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1862>
2021-05-10 21:40:49 +00:00
#include "clutter.h"
Make mutter manage its own clutter backends Introduce two new clutter backends: MetaClutterBackendX11 and MetaClutterBackendNative. They are so far only wrap ClutterBackendX11 and ClutterBackendEglNative respectively, but the aim is to move things from the original clutter backends when needed. https://bugzilla.gnome.org/show_bug.cgi?id=768976
2016-05-04 08:19:23 +00:00
Explicitly create the clutter context and backend This changes the setup phase of clutter to not be result of calling an init function that sets up a few global singletons, via global singleton setup vfuncs. The way it worked was that mutter first did some initial setup (connecting to the X11 server), then set a "custom backend" setup vfunc global, before calling clutter_init(). During the clutter_init() call, the context and backend was setup by calling the global singleton getters, which implicitly created the backend and context on-demand. This has now changed to mutter explicitly creating a `ClutterContext` (which is actually a `ClutterMainContext`, but with the name shortened to be consistent with `CoglContext` and `MetaContext`), calling it with a backend constructor vfunc and user data pointer. This function now explicitly creates the backend, without having to go via the previously set global vfunc. This changes the behavior of some "get_default()" like functions, which will now fail if called after mutter has shut down, as when it does so, it now destroys the backends and contexts, not only its own, but the clutter ones too. The "ownership" of the clutter backend is also moved to `ClutterContext`, and MetaBackend is changed to fetch it via the clutter context. This also removed the unused option parsing that existed in clutter. In some places, NULL checks for fetching the clutter context, or backend, and fetching the cogl context from the clutter backend, had to be added. The reason for this is that some code that handles EGL contexts attempts to restore the cogl EGL context tracking so that the right EGL context is used by cogl the next time. This makes no sense to do before Cogl and Clutter are even initialized, which was the case. It wasn't noticed because the relevant singletons were initialized on demand via their "getters". Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/2002>
2021-09-16 09:38:49 +00:00
typedef struct _ClutterMainContext ClutterContext;
typedef ClutterBackend * (* ClutterBackendConstructor) (gpointer user_data);
/**
* clutter_context_new: (skip)
*/
CLUTTER_EXPORT
ClutterContext * clutter_context_new (ClutterBackendConstructor backend_constructor,
gpointer user_data,
GError **error);
/**
* clutter_context_free: (skip)
*/
CLUTTER_EXPORT
void clutter_context_free (ClutterContext *clutter_context);
/**
* clutter_context_get_backend:
*
* Returns: (transfer none): The corresponding %ClutterBackend
*/
CLUTTER_EXPORT
ClutterBackend * clutter_context_get_backend (ClutterContext *clutter_context);
screen-cast: Add RecordArea for screen cast arbitrary area It takes coordinates in stage coordinate space, and will result in a screen cast stream consisting of that area, but scaled up by the scale factor of the view that overlaps with the area and has the highest scale factor. https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1207
2020-03-04 20:42:52 +00:00
CLUTTER_EXPORT
GList * clutter_stage_peek_stage_views (ClutterStage *stage);
clutter/actor: Add API to check whether actor or clone is on view The new function returns TRUE if an actor is effectively on the passed view, where effectively refers to itself or a clone containing itself. https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1285
2020-06-25 14:00:15 +00:00
CLUTTER_EXPORT
gboolean clutter_actor_is_effectively_on_stage_view (ClutterActor *self,
ClutterStageView *view);
clutter: Remove clutter specific version Use the mutter version when something is still needed.
2018-05-22 21:01:54 +00:00
CLUTTER_EXPORT
compositor: Don't access use the onscreen framebuffer directly Instead of assuming there is a single onscreen framebuffer, use the helper functions for setting the frame callback and getting the frame counter. https://bugzilla.gnome.org/show_bug.cgi?id=768976
2016-05-25 06:40:12 +00:00
int64_t clutter_stage_get_frame_counter (ClutterStage *stage);
clutter: Expose 'capture_view_into()` as API It'll be used to explicitly capture the content of a single view. Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1698>
2021-01-27 22:14:29 +00:00
CLUTTER_EXPORT
void clutter_stage_capture_view_into (ClutterStage *stage,
ClutterStageView *view,
cairo_rectangle_int_t *rect,
uint8_t *data,
int stride);
clutter: Add API to get the resource scale of an actor A clutter actor might be painted on a stage view with a view scale other than 1. In this case, to show the content in full resolution, the actor must use a higher resolution resource (e.g. texture), which will be down scaled to the stage coordinate space, then scaled up again to the stage view framebuffer scale. Use a 'resource-scale' property to save information and notify when it changes. The resource scale is the ceiled value of the highest stage view scale a actor is visible on. The value is ceiled because using a higher resolution resource consistently results in better output quality. One reason for this is that rendering is often not perfectly pixel aligned, meaning even if we load a resource with a suitable size, due to us still scaling ever so slightly, the quality is affected. Using a higher resolution resource avoids this problem. For situations inside clutter where the actual maximum view scale is needed, a function _clutter_actor_get_real_resource_scale() is provided, which returns the non-ceiled value. Make sure we ignore resource scale computation requests during size requests or allocation while ensure we've proper resource-scale on pre-paint. https://bugzilla.gnome.org/show_bug.cgi?id=765011 https://gitlab.gnome.org/GNOME/mutter/merge_requests/3
2017-04-07 12:06:36 +00:00
CLUTTER_EXPORT
clutter/stage: Rename update_resource_scales to clear_stage_views When the stage views the stage is shown on are changed, ClutterStage currently provides a clutter_stage_update_resource_scales() method that allows invalidating the resource scales of all actors. With the new stage-views API that's going to be added to ClutterActor, we also need a method to invalidate the stage-views lists of actors in case the stage views are rebuilt and fortunately we can re-use the infrastructure for invalidating resource scales for that. So since resource scales depend on the stage views an actor is on, rename clutter_stage_update_resource_scales() and related methods to clutter_stage_clear_stage_views(), which also covers resource scales. https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1196
2020-04-10 10:33:35 +00:00
void clutter_stage_clear_stage_views (ClutterStage *stage);
clutter: Add API to get the resource scale of an actor A clutter actor might be painted on a stage view with a view scale other than 1. In this case, to show the content in full resolution, the actor must use a higher resolution resource (e.g. texture), which will be down scaled to the stage coordinate space, then scaled up again to the stage view framebuffer scale. Use a 'resource-scale' property to save information and notify when it changes. The resource scale is the ceiled value of the highest stage view scale a actor is visible on. The value is ceiled because using a higher resolution resource consistently results in better output quality. One reason for this is that rendering is often not perfectly pixel aligned, meaning even if we load a resource with a suitable size, due to us still scaling ever so slightly, the quality is affected. Using a higher resolution resource avoids this problem. For situations inside clutter where the actual maximum view scale is needed, a function _clutter_actor_get_real_resource_scale() is provided, which returns the non-ceiled value. Make sure we ignore resource scale computation requests during size requests or allocation while ensure we've proper resource-scale on pre-paint. https://bugzilla.gnome.org/show_bug.cgi?id=765011 https://gitlab.gnome.org/GNOME/mutter/merge_requests/3
2017-04-07 12:06:36 +00:00
clutter/view: Make it possible to assign a temporary direct scanout Make it possible to cause the next frame to scan out directly from the passed CoglScannout. This makes it possible to completely bypass compositing for the following frame. https://gitlab.gnome.org/GNOME/mutter/merge_requests/798
2019-09-12 09:28:50 +00:00
CLUTTER_EXPORT
void clutter_stage_view_assign_next_scanout (ClutterStageView *stage_view,
CoglScanout *scanout);
clutter: Add clutter_actor_has_damage() API Will be used to check whether there are any damage to an actor. https://gitlab.gnome.org/GNOME/mutter/merge_requests/413
2019-01-23 17:40:07 +00:00
CLUTTER_EXPORT
gboolean clutter_actor_has_damage (ClutterActor *actor);
clutter/actor: Add semi-private API to check for transitions Transitions are used for animating actors when e.g. going from/to fullscreen, and the like. We need to know such things when deciding whether to avoid compositing a window actor, so make add API visible to mutter that checks whether there are any transitions active. https://gitlab.gnome.org/GNOME/mutter/merge_requests/798
2019-09-11 09:49:47 +00:00
CLUTTER_EXPORT
gboolean clutter_actor_has_transitions (ClutterActor *actor);
clutter/actor: Make frame clock picking semi private API Let's not expose that outside of mutter quite yet; it's not used in gnome-shell, and to avoid future breakage if it starts to be used, lets move it to clutter-mutter.h so only mutter and clutter itself can use it. https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1404
2020-08-12 16:06:32 +00:00
CLUTTER_EXPORT
clutter/actor: Return the actor used when picking clock The actor used might be relevant, so that e.g. if it moves or for some other reason changes stage views, the user can listen for that. https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1404
2020-08-12 16:08:35 +00:00
ClutterFrameClock * clutter_actor_pick_frame_clock (ClutterActor *self,
ClutterActor **out_actor);
clutter: Make ClutterSeat::handle_device_event vfunc more generic Make it able to handle not just device added/removed events, but perform any kind of post-processing that needed to be done on ClutterEvents at the seat level. Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1403>
2020-08-11 09:27:18 +00:00
CLUTTER_EXPORT
gboolean clutter_seat_handle_event_post (ClutterSeat *seat,
const ClutterEvent *event);
clutter/actor: Make frame clock picking semi private API Let's not expose that outside of mutter quite yet; it's not used in gnome-shell, and to avoid future breakage if it starts to be used, lets move it to clutter-mutter.h so only mutter and clutter itself can use it. https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1404
2020-08-12 16:06:32 +00:00
clutter: Add function to update input device actors to clutter-main We're moving keeping track of input devices and their associated actors out of ClutterInputDevice, this commit basically adds replacements for clutter_input_device_update() and clutter_input_device_set_actor() to clutter-main and shuffles the internals of those functions around a bit for clarity. clutter_stage_update_device() is made available in clutter-mutter.h because we need to update the actor of input devices not only from ClutterStage (when repicking after relayout), but also from MetaWaylandPointer (inside meta_wayland_pointer_repick()). Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1633>
2020-10-15 14:46:08 +00:00
CLUTTER_EXPORT
void clutter_stage_update_device (ClutterStage *stage,
ClutterInputDevice *device,
ClutterEventSequence *sequence,
graphene_point_t point,
uint32_t time,
ClutterActor *new_actor,
clutter: Store the per-pointer picked actor's clear area And resort to it first, unless we are told to ignore the cache (e.g. after relayouts). This avoids further pick context operations while the pointer is on the current actor. Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1915>
2021-07-05 15:23:21 +00:00
cairo_region_t *region,
clutter: Add function to update input device actors to clutter-main We're moving keeping track of input devices and their associated actors out of ClutterInputDevice, this commit basically adds replacements for clutter_input_device_update() and clutter_input_device_set_actor() to clutter-main and shuffles the internals of those functions around a bit for clarity. clutter_stage_update_device() is made available in clutter-mutter.h because we need to update the actor of input devices not only from ClutterStage (when repicking after relayout), but also from MetaWaylandPointer (inside meta_wayland_pointer_repick()). Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1633>
2020-10-15 14:46:08 +00:00
gboolean emit_crossing);
clutter/stage: Add infrastructure to track devices and their actors With the introduction of the input thread, we want to avoid modifying ClutterInputDevices from the main thread, since they're owned and updated by the thread. There's one part of ClutterInputDevice that's still modified from the main thread though, that is device-actors of pointer devices, and we're going to move that state-tracking into ClutterStage instead. So start that by adding the infrastructure to ClutterStage to keep track of those things. It consists of two hashtables which associate devices and touch sequences with actors, those hashtables get updated using clutter_stage_update_device_entry() and clutter_stage_remove_device_entry(), they can be queried by calling clutter_stage_get_device_actor(), which will replace clutter_input_device_get_actor(). clutter_stage_get_device_coords() is added and made available in clutter-mutter.h because we need to get the coordinates when repicking in meta_wayland_pointer_repick(). Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1633>
2020-10-15 14:39:00 +00:00
CLUTTER_EXPORT
void clutter_stage_get_device_coords (ClutterStage *stage,
ClutterInputDevice *device,
ClutterEventSequence *sequence,
graphene_point_t *coords);
clutter/main: Add clutter_stage_repick_device() call This is the very same code than meta_wayland_pointer_repick(), made part of Clutter, so triggering repicks on the same pointer coordinates is made easy. The intention is to remove meta_wayland_pointer_repick() in favor of this call. Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1654>
2020-12-22 17:22:41 +00:00
CLUTTER_EXPORT
void clutter_stage_repick_device (ClutterStage *stage,
ClutterInputDevice *device);
clutter/stage: Add infrastructure to track devices and their actors With the introduction of the input thread, we want to avoid modifying ClutterInputDevices from the main thread, since they're owned and updated by the thread. There's one part of ClutterInputDevice that's still modified from the main thread though, that is device-actors of pointer devices, and we're going to move that state-tracking into ClutterStage instead. So start that by adding the infrastructure to ClutterStage to keep track of those things. It consists of two hashtables which associate devices and touch sequences with actors, those hashtables get updated using clutter_stage_update_device_entry() and clutter_stage_remove_device_entry(), they can be queried by calling clutter_stage_get_device_actor(), which will replace clutter_input_device_get_actor(). clutter_stage_get_device_coords() is added and made available in clutter-mutter.h because we need to get the coordinates when repicking in meta_wayland_pointer_repick(). Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1633>
2020-10-15 14:39:00 +00:00
clutter: Export private function to get debug flags We're shuffling some code into src/backends, that needs knowing about these flags to minimize immediate refactors. Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1862>
2021-05-10 17:57:37 +00:00
CLUTTER_EXPORT
void clutter_get_debug_flags (ClutterDebugFlag *debug_flags,
ClutterDrawDebugFlag *draw_flags,
ClutterPickDebugFlag *pick_flags);
Make mutter manage its own clutter backends Introduce two new clutter backends: MetaClutterBackendX11 and MetaClutterBackendNative. They are so far only wrap ClutterBackendX11 and ClutterBackendEglNative respectively, but the aim is to move things from the original clutter backends when needed. https://bugzilla.gnome.org/show_bug.cgi?id=768976
2016-05-04 08:19:23 +00:00
#undef __CLUTTER_H_INSIDE__
#endif /* __CLUTTER_MUTTER_H__ */
Reference in New Issue Copy Permalink