2032f85d94
This PR changes the way we handle transactions to a more simple method. The new method is to mark containers as dirty from low level code (eg. arranging, or container_destroy, and eventually seat_set_focus), then call transaction_commit_dirty which picks up those containers and runs them through a transaction. The old methods of using transactions (arrange_and_commit, or creating one manually) are now no longer possible. The highest-level code (execute_command and view implementation handlers) will call transaction_commit_dirty, so most other code just needs to set containers as dirty. This is done by arranging, but can also be done by calling container_set_dirty.
59 lines
2 KiB
C
59 lines
2 KiB
C
#ifndef _SWAY_TRANSACTION_H
|
|
#define _SWAY_TRANSACTION_H
|
|
#include <wlr/render/wlr_texture.h>
|
|
#include "sway/tree/container.h"
|
|
|
|
/**
|
|
* Transactions enable us to perform atomic layout updates.
|
|
*
|
|
* A transaction contains a list of containers and their new state.
|
|
* A state might contain a new size, or new border settings, or new parent/child
|
|
* relationships.
|
|
*
|
|
* Committing a transaction makes sway notify of all the affected clients with
|
|
* their new sizes. We then wait for all the views to respond with their new
|
|
* surface sizes. When all are ready, or when a timeout has passed, we apply the
|
|
* updates all at the same time.
|
|
*
|
|
* When we want to make adjustments to the layout, we change the pending state
|
|
* in containers, mark them as dirty and call transaction_commit_dirty(). This
|
|
* create and commits a transaction from the dirty containers.
|
|
*/
|
|
|
|
/**
|
|
* Find all dirty containers, create and commit a transaction containing them,
|
|
* and unmark them as dirty.
|
|
*/
|
|
void transaction_commit_dirty(void);
|
|
|
|
/**
|
|
* Notify the transaction system that a view is ready for the new layout.
|
|
*
|
|
* When all views in the transaction are ready, the layout will be applied.
|
|
*/
|
|
void transaction_notify_view_ready(struct sway_view *view, uint32_t serial);
|
|
|
|
/**
|
|
* Notify the transaction system that a view is ready for the new layout, but
|
|
* identifying the instruction by width and height rather than by serial.
|
|
*
|
|
* This is used by xwayland views, as they don't have serials.
|
|
*/
|
|
void transaction_notify_view_ready_by_size(struct sway_view *view,
|
|
int width, int height);
|
|
|
|
/**
|
|
* Get the saved texture that should be rendered for a view.
|
|
*
|
|
* The addresses pointed at by the width and height pointers will be populated
|
|
* with the surface's dimensions, which may be different to the texture's
|
|
* dimensions if output scaling is used.
|
|
*
|
|
* This function should only be called if it is known that the view has
|
|
* instructions.
|
|
*/
|
|
struct wlr_texture *transaction_get_saved_texture(struct sway_view *view,
|
|
int *width, int *height);
|
|
|
|
#endif
|