Struct runa_orbiter::shell::surface::SurfaceState

pub struct SurfaceState<S: Shell> { /* private fields */ }

To support the current state and the pending state double buffering, the surface state must be deep cloneable.

Implementations

impl<S: Shell> SurfaceState<S>

pub fn new(surface: Rc<Surface<S>>) -> Self

Create a new surface state

pub fn stack(&self) -> &VecList<SurfaceStackEntry<S>>

Returns a reference to the surface stack in this surface state

pub fn stack_mut(&mut self) -> &mut VecList<SurfaceStackEntry<S>>

Returns unique reference to the surface stack in this surface state

impl<S: Shell> SurfaceState<S>

pub fn parent(&self) -> Option<S::Token>

Returns the token of the parent surface state of this surface state, if any. None if this surface is not a subsurface.

pub fn top(this: S::Token, shell: &S) -> (S::Token, Point<i32, Surface>)

Find the top of the subtree rooted at this surface. Returns the token, and it’s offset relative to this surface.

pub fn next_in_stack( &self, index: Index<SurfaceStackEntry<S>>, shell: &S ) -> Option<(S::Token, Point<i32, Surface>)>

The the surface on top of the index surface in the subtree rooted at this surface. Returns the token, and it’s offset relative to this surface.

Example

Say surface A has stack “B A C D”, and surface D has stack “E D F G”. Then A.next_in_stack(C) will return E. Because D is the next surface of C in A’s stack, and the first surface of D’s stack is E.

pub fn bottom(this: S::Token, shell: &S) -> (S::Token, Point<i32, Surface>)

Find the bottom of the subtree rooted at this surface. Returns the token, and it’s offset relative to this surface.

Example

Say surface A has stack “B A C D”, and surface B has stack “E D F G”. Then A.bottom() will return E. Because B is the bottom of A’s immediate stack, and the bottom surface of B’s stack is E.

pub fn prev_in_stack( &self, index: Index<SurfaceStackEntry<S>>, shell: &S ) -> Option<(S::Token, Point<i32, Surface>)>

The the surface beneath the index surface in the subtree rooted at this surface. Returns the token, and it’s offset relative to this surface.

Example

Say surface A has stack “B A C D”, and surface C has stack “E C F G”. Then A.prev_in_stack(D) will return G. Because C is the previous surface of D in A’s stack, and the bottom most surface of C’s stack is G.

pub fn buffer_scale_f32(&self) -> Scale<NotNan<f32>>

Return the buffer scale

pub fn set_buffer_scale(&mut self, scale: u32)

Set the buffer scale

pub fn surface(&self) -> &Weak<Surface<S>>

Get a weak reference to the surface this surface state belongs to.

pub fn damage_buffer(&mut self)

Mark the surface’s buffer as damaged. No-op if the surface has no buffer.

pub fn set_buffer_from_object(&mut self, buffer: &Buffer<S::Buffer>)

Set the buffer.

pub fn buffer(&self) -> Option<&Rc<S::Buffer>>

Get a reference to the buffer.

pub fn add_frame_callback(&mut self, callback: u32)

Add a frame callback.

pub fn set_role_state<T: RoleState>(&mut self, state: T)

Set role related state.

pub fn role_state<T: RoleState>(&self) -> Option<Option<&T>>

Get a reference to the role related state.

None if there is no role related state assigned to this surface. Some(None) if T is not the correct type.

pub fn role_state_mut<T: RoleState>(&mut self) -> Option<Option<&mut T>>

Get a unique reference to the role related state.

None if there is no role related state assigned to this surface. Some(None) if T is not the correct type.

pub fn scan_for_freeing(token: S::Token, shell: &S, queue: &mut Vec<S::Token>)

Assuming token is going to be released, scan the tree for any transient children that can be freed as well, and append them to queue.

Trait Implementations

impl<S: Shell> Clone for SurfaceState<S>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S: Shell> Debug for SurfaceState<S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.