Struct RawHandleWrapper

pub struct RawHandleWrapper { /* 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.

Implementations

impl RawHandleWrapper

pub fn new<W: HasWindowHandle + HasDisplayHandle + 'static>( window: &WindowWrapper<W>, ) -> Result<RawHandleWrapper, HandleError>

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.

pub fn get_window_handle(&self) -> RawWindowHandle

Gets the stored window handle.

pub unsafe fn set_window_handle( &mut self, window_handle: RawWindowHandle, ) -> &mut Self

Sets the window handle.

Safety

The passed in RawWindowHandle must be a valid window handle.

pub fn get_display_handle(&self) -> RawDisplayHandle

Gets the stored display handle

pub fn set_display_handle( &mut self, display_handle: RawDisplayHandle, ) -> &mut Self

Sets the display handle.

Safety

The passed in RawDisplayHandle must be a valid display handle.

Trait Implementations

impl Clone for RawHandleWrapper

fn clone(&self) -> RawHandleWrapper

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for RawHandleWrapper

where Self: Send + Sync + 'static,

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

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have [Component<Mutability = Mutable>], while immutable components will instead have [Component<Mutability = Immutable>].

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Debug for RawHandleWrapper

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

Formats the value using the given formatter.

impl Send for RawHandleWrapper

impl Sync for RawHandleWrapper