struct wlr_compositor ¶

struct wlr_compositor {
	struct wl_global *global;
	struct wlr_renderer *renderer; // may be NULL
	
	struct {
		struct wl_signal new_surface;
		struct wl_signal destroy;
	} events;
	
	struct {
		struct wl_listener display_destroy;
		struct wl_listener renderer_destroy;
	} WLR_PRIVATE;
};

struct wlr_surface ¶

struct wlr_surface {
	struct wl_resource *resource;
	struct wlr_compositor *compositor;
	/**
	 * The surface's buffer, if any. A surface has an attached buffer when it
	 * commits with a non-null buffer in its pending state. A surface will not
	 * have a buffer if it has never committed one, has committed a null buffer,
	 * or something went wrong with uploading the buffer.
	 */
	struct wlr_client_buffer *buffer;
	/**
	 * The last commit's buffer damage, in buffer-local coordinates. This
	 * contains both the damage accumulated by the client via
	 * `wlr_surface_state.surface_damage` and `wlr_surface_state.buffer_damage`.
	 * If the buffer has been resized, the whole buffer is damaged.
	 *
	 * This region needs to be scaled and transformed into output coordinates,
	 * just like the buffer's texture. In addition, if the buffer has shrunk the
	 * old size needs to be damaged and if the buffer has moved the old and new
	 * positions need to be damaged.
	 */
	pixman_region32_t buffer_damage;
	/**
	 * The current opaque region, in surface-local coordinates. It is clipped to
	 * the surface bounds. If the surface's buffer is using a fully opaque
	 * format, this is set to the whole surface.
	 */
	pixman_region32_t opaque_region;
	/**
	 * The current input region, in surface-local coordinates. It is clipped to
	 * the surface bounds.
	 *
	 * If the protocol states that the input region is ignored, this is empty.
	 */
	pixman_region32_t input_region;
	/**
	 * `current` contains the current, committed surface state. `pending`
	 * accumulates state changes from the client between commits and shouldn't
	 * be accessed by the compositor directly.
	 */
	struct wlr_surface_state current, pending;
	
	struct wl_list cached; // wlr_surface_state.cached_link
	
	/**
	 * Whether the surface is ready to be displayed.
	 */
	 bool mapped;
	
	/**
	 * The lifetime-bound role of the surface. NULL if the role was never set.
	 */
	const struct wlr_surface_role *role;
	
	/**
	 * The role object representing the role. NULL if the role isn't
	 * represented by any object or the object was destroyed.
	 */
	struct wl_resource *role_resource;
	
	struct {
		/**
		 * Signals that the client has sent a wl_surface.commit request.
		 *
		 * The state to be committed can be accessed in wlr_surface.pending.
		 *
		 * The commit may not be applied immediately, in which case it's marked
		 * as "cached" and put into a queue. See wlr_surface_lock_pending().
		 */
		struct wl_signal client_commit;
		/**
		 * Signals that a commit has been applied.
		 *
		 * The new state can be accessed in wlr_surface.current.
		 */
		struct wl_signal commit;
		
		/**
		 * Signals that the surface has a non-null buffer committed and is
		 * ready to be displayed.
		 */
		struct wl_signal map;
		/**
		 * Signals that the surface shouldn't be displayed anymore. This can
		 * happen when a null buffer is committed, the associated role object
		 * is destroyed, or when the role-specific conditions for the surface
		 * to be mapped no longer apply.
		 */
		struct wl_signal unmap;
		
		/**
		 * Signals that a new child sub-surface has been added.
		 *
		 * Note: unlike other new_* signals, new_subsurface is emitted when
		 * the subsurface is added to the parent surface's current state,
		 * not when the object is created.
		 */
		struct wl_signal new_subsurface; // struct wlr_subsurface
		
		/**
		 * Signals that the surface is being destroyed.
		 */
		struct wl_signal destroy;
	} events;
	
	struct wl_list current_outputs; // wlr_surface_output.link
	
	struct wlr_addon_set addons;
	void *data;
	
	struct {
		struct wl_listener role_resource_destroy;
		
		struct {
			int32_t scale;
			enum wl_output_transform transform;
			int width, height;
			int buffer_width, buffer_height;
		} previous;
		
		bool unmap_commit;
		
		bool opaque;
		
		bool handling_commit;
		bool pending_rejected;
		
		int32_t preferred_buffer_scale;
		bool preferred_buffer_transform_sent;
		enum wl_output_transform preferred_buffer_transform;
		
		struct wl_list synced; // wlr_surface_synced.link
		size_t synced_len;
		
		struct wl_resource *pending_buffer_resource;
		struct wl_listener pending_buffer_resource_destroy;
	} WLR_PRIVATE;
};

struct wlr_surface_output ¶

struct wlr_surface_output {
	struct wlr_surface *surface;
	struct wlr_output *output;
	
	struct wl_list link; // wlr_surface.current_outputs
	
	struct {
		struct wl_listener bind;
		struct wl_listener destroy;
	} WLR_PRIVATE;
};

struct wlr_surface_role ¶

struct wlr_surface_role {
	const char *name;
	/**
	 * If true, the role isn't represented by any object.
	 * For example, this applies to cursor surfaces.
	 */
	 bool no_object;
	/**
	 * Called when the client sends the wl_surface.commit request. May be NULL.
	 * Typically used to check that the pending state is valid, and send
	 * protocol errors if not.
	 *
	 * If the role is represented by an object, this is only called if
	 * such object exists.
	 */
	void (*client_commit)(​struct wlr_surface *surface);
	/**
	 * Called when a new surface state is committed. May be NULL.
	 *
	 * If the role is represented by an object, this is only called if
	 * such object exists.
	 */
	void (*commit)(​struct wlr_surface *surface);
	/**
	 * Called when the surface is mapped. May be NULL.
	 *
	 * If the role is represented by an object, this is only called if
	 * such object exists.
	 */
	void (*map)(​struct wlr_surface *surface);
	/**
	 * Called when the surface is unmapped. May be NULL.
	 *
	 * If the role is represented by an object, this is only called if
	 * such object exists.
	 */
	void (*unmap)(​struct wlr_surface *surface);
	/**
	 * Called when the object representing the role is destroyed. May be NULL.
	 */
	void (*destroy)(​struct wlr_surface *surface);
};

struct wlr_surface_state ¶

struct wlr_surface_state {
	uint32_t committed; // enum wlr_surface_state_field
	// Sequence number of the surface state. Incremented on each commit, may
	// overflow.
	uint32_t seq;
	
	struct wlr_buffer *buffer;
	int32_t dx, dy; // relative to previous position
	pixman_region32_t surface_damage, buffer_damage; // clipped to bounds
	pixman_region32_t opaque, input;
	enum wl_output_transform transform;
	int32_t scale;
	struct wl_list frame_callback_list; // wl_resource
	
	int width, height; // in surface-local coordinates
	int buffer_width, buffer_height;
	
	struct wl_list subsurfaces_below;
	struct wl_list subsurfaces_above;
	
	/**
	 * The viewport is applied after the surface transform and scale.
	 *
	 * If has_src is true, the surface content is cropped to the provided
	 * rectangle. If has_dst is true, the surface content is scaled to the
	 * provided rectangle.
	 */
	struct {
		bool has_src, has_dst;
		// In coordinates after scale/transform are applied, but before the
		// destination rectangle is applied
		struct wlr_fbox src;
		int dst_width, dst_height; // in surface-local coordinates
	} viewport;
	
	// Number of locks that prevent this surface state from being committed.
	size_t cached_state_locks;
	struct wl_list cached_state_link; // wlr_surface.cached
	
	// Sync'ed object states, one per struct wlr_surface_synced
	struct wl_array synced; // void *
};

struct wlr_surface_synced ¶

struct wlr_surface_synced {
	struct wlr_surface *surface;
	const struct wlr_surface_synced_impl *impl;
	struct wl_list link; // wlr_surface.synced
	size_t index;
};

An object synchronized with a surface.

This is typically used by surface add-ons which integrate with the surface commit mechanism.

A sync'ed object maintains state whose lifecycle is managed by struct wlr_surface_synced_impl. Clients make requests to mutate the pending state, then clients commit the pending state via wl_surface.commit. The pending state may become cached, then becomes current when it's applied.

struct wlr_surface_synced_impl ¶

struct wlr_surface_synced_impl {
	// Size in bytes of the state struct.
	size_t state_size;
	// Initialize a state. If NULL, this is a no-op.
	void (*init_state)(​void *state);
	// Finish a state. If NULL, this is a no-op.
	void (*finish_state)(​void *state);
	// Move a state. If NULL, memcpy() is used.
	void (*move_state)(​void *dst, void *src);
};

Implementation for struct wlr_surface_synced.

struct wlr_surface takes care of allocating the sync'ed object state.

The only mandatory field is state_size.