Struct raw_window_handle::WindowHandle

pub struct WindowHandle<'a> {
    raw: RawWindowHandle,
    _active: ActiveHandle<'a>,
    _marker: PhantomData<&'a *const ()>,
}

The handle to a window.

This is the primary return type of the HasWindowHandle trait. All pointers within this type are guaranteed to be valid and not dangling for the lifetime of the handle. This excludes window IDs like XIDs and the window ID for web platforms. See the documentation on the HasWindowHandle trait for more information about these safety requirements.

This handle is guaranteed to be safe and valid. Get the underlying raw window handle with the HasRawWindowHandle trait.

Fields

raw: RawWindowHandle

_active: ActiveHandle<'a>

_marker: PhantomData<&'a *const ()>

Implementations

impl<'a> WindowHandle<'a>

pub unsafe fn borrow_raw(raw: RawWindowHandle, active: ActiveHandle<'a>) -> Self

Borrow a WindowHandle from a RawWindowHandle.

Safety

The RawWindowHandle must be valid for the lifetime and the application must not be suspended. The Active object that the ActiveHandle was created from must be associated directly with the display that the window handle is associated with.

Trait Implementations

impl<'a> Clone for WindowHandle<'a>

fn clone(&self) -> WindowHandle<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WindowHandle<'_>

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

Formats the value using the given formatter.

impl HasRawWindowHandle for WindowHandle<'_>

fn raw_window_handle(&self) -> RawWindowHandle

impl HasWindowHandle for WindowHandle<'_>

fn window_handle(&self) -> Result<Self, HandleError>

Get a handle to the window.

impl Hash for WindowHandle<'_>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<WindowHandle<'_>> for WindowHandle<'_>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for WindowHandle<'_>