Skip to main content

WindowBackend

Struct WindowBackend 

Source
pub struct WindowBackend {
    pub id: u32,
    /* private fields */
}
Expand description

Data associated to a specific window for overlay rendering.

Fields§

§id: u32

Unique identifier for the window.

Implementations§

Source§

impl WindowBackend

Source

pub fn reset(&self)

Reset the backend state. This reset all set user settable state.

Source

pub fn gpu_luid(&self) -> GpuLuid

Get the locally unique identifier for the GPU. This is the GPU adapter used by the window to present to surface. Overlay surface texture must be created with this GPU. Otherwise, surface cannot be rendered.

Source

pub fn update_surface(&self, handle: Option<NonZeroU32>) -> Result<()>

Update overlay surface using the given shared handle.

Source

pub fn layout(&self) -> OverlayLayout

Get overlay layout.

Source

pub fn update_layout(&self, f: impl FnOnce(&mut OverlayLayout))

Update overlay layout.

Source

pub fn invalidate_layout(&self)

Invalidate layout and recompute position.

Source

pub fn listen_input(&self, flags: ListenInputFlags)

Set which input events are being listened to.

Source

pub fn set_blocking_cursor(&self, cursor: Option<Cursor>)

Sets the cursor to be displayed while input is blocked.

Source

pub fn block_input(&self, block: bool)

Blocks or unblocks input for the window.

Source

pub fn execute_gui(&self, f: impl FnOnce(&WindowBackend) + Send + 'static)

Execute function on the GUI thread. Calling execute_gui inside the closure will deadlock.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more