Struct bevy::window::RawHandleWrapper

pub struct RawHandleWrapper {
    pub window_handle: RawWindowHandle,
    pub display_handle: RawDisplayHandle,
    /* private fields */
}

A wrapper over [RawWindowHandle] and [RawDisplayHandle] that allows us to safely pass it across threads.

Depending on the platform, the underlying pointer-containing handle cannot be used on all threads, and so we cannot simply make it (or any type that has a safe operation to get a [RawWindowHandle] or [RawDisplayHandle]) thread-safe.

Fields

window_handle: RawWindowHandle

Raw handle to a window.

display_handle: RawDisplayHandle

Raw handle to the display server.

Implementations

impl RawHandleWrapper

pub fn new<W>( window: &WindowWrapper<W> ) -> Result<RawHandleWrapper, HandleError>

where W: HasWindowHandle + HasDisplayHandle + 'static,

Creates a RawHandleWrapper from a WindowWrapper.

pub unsafe fn get_handle(&self) -> ThreadLockedRawWindowHandleWrapper

Returns a [HasWindowHandle] + [HasDisplayHandle] impl, which exposes [WindowHandle] and [DisplayHandle].

Safety

Some platforms have constraints on where/how this handle can be used. For example, some platforms don’t support doing window operations off of the main thread. The caller must ensure the RawHandleWrapper is only used in valid contexts.

Trait Implementations

impl Clone for RawHandleWrapper

fn clone(&self) -> RawHandleWrapper

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for RawHandleWrapper

where RawHandleWrapper: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

fn register_component_hooks(_hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.

impl Debug for RawHandleWrapper

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

Formats the value using the given formatter.

impl Send for RawHandleWrapper

impl Sync for RawHandleWrapper