river: improve comments on pending/inflight/current

This commit is contained in:
Isaac Freund
2023-03-06 16:30:42 +01:00
parent 05e8fbc8b9
commit 684f26acac
2 changed files with 15 additions and 4 deletions

View File

@ -94,13 +94,12 @@ lock_render_state: enum {
/// The state of the output that is directly acted upon/modified through user input.
///
/// Pending state will be copied to the pending state and communicated to clients
/// Pending state will be copied to the inflight state and communicated to clients
/// to be applied as a single atomic transaction across all clients as soon as any
/// in progress transaction has been completed.
///
/// On completion of a transaction
/// Any time pending state is modified Root.dirty must be set.
///
/// Any time pending state is modified Root.applyPending() must be called
/// before yielding back to the event loop.
pending: struct {
/// A bit field of focused tags
tags: u32 = 1 << 0,