scaled-scene-buffer: restructure source files
Some checks failed
labwc.github.io / notify (push) Has been cancelled

- Rename `scaled_scene_buffer` to `scaled_buffer`. This makes it clear
  that `scaled_{font,img,icon}_buffers` are implementations of it.
- Move the files from `src/common` to `src/scaled-buffer` as
  `scaled_icon_buffer` heavily depends on `server` and `view` etc.
This commit is contained in:
tokyo4j 2025-09-02 17:47:01 +09:00 committed by Johan Malm
parent 02be24bf59
commit 074b27fd47
22 changed files with 128 additions and 125 deletions

View file

@ -8,7 +8,7 @@ struct lab_layer_surface;
struct lab_layer_popup;
struct menuitem;
struct ssd_part;
struct scaled_scene_buffer;
struct scaled_buffer;
enum node_descriptor_type {
LAB_NODE_DESC_NODE = 0,
@ -20,7 +20,7 @@ enum node_descriptor_type {
LAB_NODE_DESC_IME_POPUP,
LAB_NODE_DESC_MENUITEM,
LAB_NODE_DESC_TREE,
LAB_NODE_DESC_SCALED_SCENE_BUFFER,
LAB_NODE_DESC_SCALED_BUFFER,
LAB_NODE_DESC_SSD_PART,
};
@ -84,10 +84,10 @@ struct ssd_part *node_ssd_part_from_node(
struct wlr_scene_node *wlr_scene_node);
/**
* node_scaled_scene_buffer_from_node - return scaled_scene_buffer from node
* node_scaled_buffer_from_node - return scaled_buffer from node
* @wlr_scene_node: wlr_scene_node from which to return data
*/
struct scaled_scene_buffer *node_scaled_scene_buffer_from_node(
struct scaled_buffer *node_scaled_buffer_from_node(
struct wlr_scene_node *wlr_scene_node);
#endif /* LABWC_NODE_DESCRIPTOR_H */

View file

@ -1,6 +1,6 @@
/* SPDX-License-Identifier: GPL-2.0-only */
#ifndef LABWC_SCALED_SCENE_BUFFER_H
#define LABWC_SCALED_SCENE_BUFFER_H
#ifndef LABWC_SCALED_BUFFER_H
#define LABWC_SCALED_BUFFER_H
#include <wayland-server-core.h>
@ -9,20 +9,20 @@
struct wlr_buffer;
struct wlr_scene_tree;
struct lab_data_buffer;
struct scaled_scene_buffer;
struct scaled_buffer;
struct scaled_scene_buffer_impl {
struct scaled_buffer_impl {
/* Return a new buffer optimized for the new scale */
struct lab_data_buffer *(*create_buffer)
(struct scaled_scene_buffer *scaled_buffer, double scale);
(struct scaled_buffer *scaled_buffer, double scale);
/* Might be NULL or used for cleaning up */
void (*destroy)(struct scaled_scene_buffer *scaled_buffer);
void (*destroy)(struct scaled_buffer *scaled_buffer);
/* Returns true if the two buffers are visually the same */
bool (*equal)(struct scaled_scene_buffer *scaled_buffer_a,
struct scaled_scene_buffer *scaled_buffer_b);
bool (*equal)(struct scaled_buffer *scaled_buffer_a,
struct scaled_buffer *scaled_buffer_b);
};
struct scaled_scene_buffer {
struct scaled_buffer {
struct wlr_scene_buffer *scene_buffer;
int width; /* unscaled, read only */
int height; /* unscaled, read only */
@ -35,7 +35,7 @@ struct scaled_scene_buffer {
struct wl_list cache; /* struct scaled_buffer_cache_entry.link */
struct wl_listener destroy;
struct wl_listener outputs_update;
const struct scaled_scene_buffer_impl *impl;
const struct scaled_buffer_impl *impl;
struct wl_list link; /* all_scaled_buffers */
};
@ -78,22 +78,22 @@ struct scaled_scene_buffer {
* to handle the majority of use cases where a view is moved between no more
* than two different scales.
*
* scaled_scene_buffer will clean up automatically once the internal
* scaled_buffer will clean up automatically once the internal
* wlr_scene_buffer is being destroyed. If implementation->destroy is set
* it will also get called so a consumer of this API may clean up its own
* allocations.
*
* Besides caching buffers for each scale per scaled_scene_buffer, we also
* store all the scaled_scene_buffers from all the implementers in a list
* Besides caching buffers for each scale per scaled_buffer, we also
* store all the scaled_buffers from all the implementers in a list
* in order to reuse backing buffers for visually duplicated
* scaled_scene_buffers found via impl->equal().
* scaled_buffers found via impl->equal().
*
* All requested lab_data_buffers via impl->create_buffer() will be locked
* during the lifetime of the buffer in the internal cache and unlocked
* when being evacuated from the cache (due to LAB_SCALED_BUFFER_MAX_CACHE
* or the internal wlr_scene_buffer being destroyed).
*
* If drop_buffer was set during creation of the scaled_scene_buffer, the
* If drop_buffer was set during creation of the scaled_buffer, the
* backing wlr_buffer behind a lab_data_buffer will also get dropped
* (via wlr_buffer_drop). If there are no more locks (consumers) of the
* respective buffer this will then cause the lab_data_buffer to be free'd.
@ -103,21 +103,21 @@ struct scaled_scene_buffer {
* destroyed until the buffer is evacuated from the internal cache and thus
* unlocked.
*
* This allows using scaled_scene_buffer for an autoscaling font_buffer
* This allows using scaled_buffer for an autoscaling font_buffer
* (which gets free'd automatically) and also for theme components like
* rounded corner images or button icons whose buffers only exist once but
* are references by multiple windows with their own scaled_scene_buffers.
* are references by multiple windows with their own scaled_buffers.
*
* The rough idea is: use drop_buffer = true for one-shot buffers and false
* for buffers that should outlive the scaled_scene_buffer instance itself.
* for buffers that should outlive the scaled_buffer instance itself.
*/
struct scaled_scene_buffer *scaled_scene_buffer_create(
struct scaled_buffer *scaled_buffer_create(
struct wlr_scene_tree *parent,
const struct scaled_scene_buffer_impl *implementation,
const struct scaled_buffer_impl *implementation,
bool drop_buffer);
/**
* scaled_scene_buffer_request_update - mark the buffer that needs to be
* scaled_buffer_request_update - mark the buffer that needs to be
* updated
* @width: the width of the buffer to be rendered, in scene coordinates
* @height: the height of the buffer to be rendered, in scene coordinates
@ -125,22 +125,22 @@ struct scaled_scene_buffer *scaled_scene_buffer_create(
* This function should be called when the states bound to the buffer are
* updated and ready for rendering.
*/
void scaled_scene_buffer_request_update(struct scaled_scene_buffer *self,
void scaled_buffer_request_update(struct scaled_buffer *self,
int width, int height);
/**
* scaled_scene_buffer_invalidate_sharing - clear the list of entire cached
* scaled_scene_buffers used to share visually dupliated buffers. This should
* scaled_buffer_invalidate_sharing - clear the list of entire cached
* scaled_buffers used to share visually dupliated buffers. This should
* be called on Reconfigure to force updates of newly created
* scaled_scene_buffers rather than reusing ones created before Reconfigure.
* scaled_buffers rather than reusing ones created before Reconfigure.
*/
void scaled_scene_buffer_invalidate_sharing(void);
void scaled_buffer_invalidate_sharing(void);
/* Private */
struct scaled_scene_buffer_cache_entry {
struct wl_list link; /* struct scaled_scene_buffer.cache */
struct scaled_buffer_cache_entry {
struct wl_list link; /* struct scaled_buffer.cache */
struct wlr_buffer *buffer;
double scale;
};
#endif /* LABWC_SCALED_SCENE_BUFFER_H */
#endif /* LABWC_SCALED_BUFFER_H */

View file

@ -6,7 +6,7 @@
struct wlr_scene_tree;
struct wlr_scene_buffer;
struct scaled_scene_buffer;
struct scaled_buffer;
struct scaled_font_buffer {
struct wlr_scene_buffer *scene_buffer;
@ -19,7 +19,7 @@ struct scaled_font_buffer {
float color[4];
float bg_color[4];
struct font font;
struct scaled_scene_buffer *scaled_buffer;
struct scaled_buffer *scaled_buffer;
/*
* The following fields are used only for the titlebar, where
@ -34,7 +34,7 @@ struct scaled_font_buffer {
/**
* Create an auto scaling font buffer, providing a wlr_scene_buffer node for
* display. It gets destroyed automatically when the backing scaled_scene_buffer
* display. It gets destroyed automatically when the backing scaled_buffer
* is being destroyed which in turn happens automatically when the backing
* wlr_scene_buffer (or one of its parents) is being destroyed.
*

View file

@ -10,7 +10,7 @@ struct wlr_scene_node;
struct wlr_scene_buffer;
struct scaled_icon_buffer {
struct scaled_scene_buffer *scaled_buffer;
struct scaled_buffer *scaled_buffer;
struct wlr_scene_buffer *scene_buffer;
struct server *server;
/* for window icon */
@ -34,7 +34,7 @@ struct scaled_icon_buffer {
/*
* Create an auto scaling icon buffer, providing a wlr_scene_buffer node for
* display. It gets destroyed automatically when the backing scaled_scene_buffer
* display. It gets destroyed automatically when the backing scaled_buffer
* is being destroyed which in turn happens automatically when the backing
* wlr_scene_buffer (or one of its parents) is being destroyed.
*/

View file

@ -10,7 +10,7 @@ struct wlr_scene_buffer;
struct lab_img;
struct scaled_img_buffer {
struct scaled_scene_buffer *scaled_buffer;
struct scaled_buffer *scaled_buffer;
struct wlr_scene_buffer *scene_buffer;
struct lab_img *img;
int width;
@ -56,7 +56,7 @@ struct scaled_img_buffer {
/*
* Create an auto scaling image buffer, providing a wlr_scene_buffer node for
* display. It gets destroyed automatically when the backing scaled_scene_buffer
* display. It gets destroyed automatically when the backing scaled_buffer
* is being destroyed which in turn happens automatically when the backing
* wlr_scene_buffer (or one of its parents) is being destroyed.
*