pub struct ShellEventContext<'a> { /* private fields */ }Expand description
Context providing access to shell state within custom event source callbacks
Obtained via event source callbacks registered through EventLoopHandle.
Implementations§
Source§impl ShellEventContext<'_>
impl ShellEventContext<'_>
Sourcepub fn get_surface_component(&self, name: &str) -> Option<&ComponentInstance>
pub fn get_surface_component(&self, name: &str) -> Option<&ComponentInstance>
Returns the component instance for a surface by name
Sourcepub fn all_surface_components(&self) -> impl Iterator<Item = &ComponentInstance>
pub fn all_surface_components(&self) -> impl Iterator<Item = &ComponentInstance>
Returns all surface component instances
Sourcepub fn render_frame_if_dirty(&mut self) -> Result<(), Error>
pub fn render_frame_if_dirty(&mut self) -> Result<(), Error>
Renders a new frame for all dirty surfaces
Sourcepub fn primary_output_handle(&self) -> Option<Handle<Output>>
pub fn primary_output_handle(&self) -> Option<Handle<Output>>
Returns the primary output handle
Sourcepub fn active_output_handle(&self) -> Option<Handle<Output>>
pub fn active_output_handle(&self) -> Option<Handle<Output>>
Returns the active output handle
Sourcepub fn output_registry(&self) -> &OutputRegistry
pub fn output_registry(&self) -> &OutputRegistry
Returns the output registry
Sourcepub fn outputs(
&self,
) -> impl Iterator<Item = (Handle<Output>, &ComponentInstance)>
pub fn outputs( &self, ) -> impl Iterator<Item = (Handle<Output>, &ComponentInstance)>
Returns all outputs with their handles and component instances
Sourcepub fn get_output_component(
&self,
handle: Handle<Output>,
) -> Option<&ComponentInstance>
pub fn get_output_component( &self, handle: Handle<Output>, ) -> Option<&ComponentInstance>
Returns the component instance for a specific output
Sourcepub fn get_output_info(&self, handle: Handle<Output>) -> Option<&OutputInfo>
pub fn get_output_info(&self, handle: Handle<Output>) -> Option<&OutputInfo>
Returns information about a specific output
Sourcepub fn all_output_info(&self) -> impl Iterator<Item = &OutputInfo>
pub fn all_output_info(&self) -> impl Iterator<Item = &OutputInfo>
Returns information about all outputs
Sourcepub fn outputs_with_info(
&self,
) -> impl Iterator<Item = (&OutputInfo, &ComponentInstance)>
pub fn outputs_with_info( &self, ) -> impl Iterator<Item = (&OutputInfo, &ComponentInstance)>
Returns all outputs with their info and component instances
Sourcepub fn compilation_result(&self) -> Option<Rc<CompilationResult>>
pub fn compilation_result(&self) -> Option<Rc<CompilationResult>>
Returns the compilation result if available
Auto Trait Implementations§
impl<'a> Freeze for ShellEventContext<'a>
impl<'a> !RefUnwindSafe for ShellEventContext<'a>
impl<'a> !Send for ShellEventContext<'a>
impl<'a> !Sync for ShellEventContext<'a>
impl<'a> Unpin for ShellEventContext<'a>
impl<'a> !UnwindSafe for ShellEventContext<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more