raw_window_handle

Struct DisplayHandle

source
pub struct DisplayHandle<'a> { /* private fields */ }
Expand description

The handle to the display controller of the windowing system.

This is the primary return type of the HasDisplayHandle trait. It is guaranteed to contain a valid platform-specific display handle for its lifetime.

Implementations§

source§

impl DisplayHandle<'static>

source

pub fn android() -> Self

Create an Android-based display handle.

As no data is borrowed by this handle, it is completely safe to create. This function may be useful to windowing framework implementations that want to avoid unsafe code.

§Example
let handle = DisplayHandle::android();
do_something(handle);
source§

impl DisplayHandle<'static>

source

pub fn appkit() -> Self

Create an AppKit-based display handle.

As no data is borrowed by this handle, it is completely safe to create. This function may be useful to windowing framework implementations that want to avoid unsafe code.

§Example
let handle = DisplayHandle::appkit();
do_something(handle);
source§

impl<'a> DisplayHandle<'a>

source

pub unsafe fn borrow_raw(raw: RawDisplayHandle) -> Self

Create a DisplayHandle from a RawDisplayHandle.

§Safety

Users can safely assume that non-null/0 fields are valid handles, and it is up to the implementer of this trait to ensure that condition is upheld.

Despite that qualification, implementors should still make a best-effort attempt to fill in all available fields. If an implementation doesn’t, and a downstream user needs the field, it should try to derive the field from other fields the implementer does provide via whatever methods the platform provides.

It is not possible to invalidate a DisplayHandle on any platform without additional unsafe code.

source

pub fn as_raw(&self) -> RawDisplayHandle

Get the underlying raw display handle.

source§

impl DisplayHandle<'static>

source

pub fn haiku() -> Self

Create an Haiku-based display handle.

As no data is borrowed by this handle, it is completely safe to create. This function may be useful to windowing framework implementations that want to avoid unsafe code.

§Example
let handle = DisplayHandle::haiku();
do_something(handle);
source§

impl DisplayHandle<'static>

source

pub fn ohos() -> Self

Create an OpenHarmony-based display handle.

As no data is borrowed by this handle, it is completely safe to create. This function may be useful to windowing framework implementations that want to avoid unsafe code.

§Example
let handle = DisplayHandle::ohos();
do_something(handle);
source§

impl DisplayHandle<'static>

source

pub fn orbital() -> Self

Create an Orbital-based display handle.

As no data is borrowed by this handle, it is completely safe to create. This function may be useful to windowing framework implementations that want to avoid unsafe code.

§Example
let handle = DisplayHandle::orbital();
do_something(handle);
source§

impl DisplayHandle<'static>

source

pub fn uikit() -> Self

Create a UiKit-based display handle.

As no data is borrowed by this handle, it is completely safe to create. This function may be useful to windowing framework implementations that want to avoid unsafe code.

§Example
let handle = DisplayHandle::uikit();
do_something(handle);
source§

impl DisplayHandle<'static>

source

pub fn web() -> Self

Create a Web-based display handle.

As no data is borrowed by this handle, it is completely safe to create. This function may be useful to windowing framework implementations that want to avoid unsafe code.

§Example
let handle = DisplayHandle::web();
do_something(handle);
source§

impl DisplayHandle<'static>

source

pub fn windows() -> Self

Create a Windows-based display handle.

As no data is borrowed by this handle, it is completely safe to create. This function may be useful to windowing framework implementations that want to avoid unsafe code.

§Example
let handle = DisplayHandle::windows();
do_something(handle);

Trait Implementations§

source§

impl AsRef<RawDisplayHandle> for DisplayHandle<'_>

source§

fn as_ref(&self) -> &RawDisplayHandle

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl Borrow<RawDisplayHandle> for DisplayHandle<'_>

source§

fn borrow(&self) -> &RawDisplayHandle

Immutably borrows from an owned value. Read more
source§

impl<'a> Clone for DisplayHandle<'a>

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for DisplayHandle<'_>

source§

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

Formats the value using the given formatter. Read more
source§

impl From<DisplayHandle<'_>> for RawDisplayHandle

source§

fn from(handle: DisplayHandle<'_>) -> Self

Converts to this type from the input type.
source§

impl<'a> HasDisplayHandle for DisplayHandle<'a>

source§

fn display_handle(&self) -> Result<DisplayHandle<'_>, HandleError>

Get a handle to the display controller of the windowing system.
source§

impl<'a> Hash for DisplayHandle<'a>

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'a> PartialEq for DisplayHandle<'a>

source§

fn eq(&self, other: &DisplayHandle<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'a> Copy for DisplayHandle<'a>

source§

impl<'a> Eq for DisplayHandle<'a>

source§

impl<'a> StructuralPartialEq for DisplayHandle<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for DisplayHandle<'a>

§

impl<'a> RefUnwindSafe for DisplayHandle<'a>

§

impl<'a> !Send for DisplayHandle<'a>

§

impl<'a> !Sync for DisplayHandle<'a>

§

impl<'a> Unpin for DisplayHandle<'a>

§

impl<'a> UnwindSafe for DisplayHandle<'a>

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> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> HasRawDisplayHandle for T
where T: HasDisplayHandle + ?Sized,

source§

fn raw_display_handle(&self) -> Result<RawDisplayHandle, HandleError>

👎Deprecated: Use HasDisplayHandle instead
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> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.