Struct raw_window_handle::borrowed::DisplayHandle

#[repr(transparent)]
pub struct DisplayHandle<'a> {
    raw: RawDisplayHandle,
    _marker: PhantomData<&'a ()>,
}

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.

Fields

raw: RawDisplayHandle

_marker: PhantomData<&'a ()>

Implementations

impl DisplayHandle<'static>

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);

impl DisplayHandle<'static>

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);

impl<'a> DisplayHandle<'a>

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.

pub fn as_raw(&self) -> RawDisplayHandle

Get the underlying raw display handle.

impl DisplayHandle<'static>

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);

impl DisplayHandle<'static>

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);

impl DisplayHandle<'static>

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);

impl DisplayHandle<'static>

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);

impl DisplayHandle<'static>

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);

impl DisplayHandle<'static>

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

impl AsRef<RawDisplayHandle> for DisplayHandle<'_>

fn as_ref(&self) -> &RawDisplayHandle

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

impl Borrow<RawDisplayHandle> for DisplayHandle<'_>

fn borrow(&self) -> &RawDisplayHandle

Immutably borrows from an owned value.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DisplayHandle<'_>

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

Formats the value using the given formatter.

impl From<DisplayHandle<'_>> for RawDisplayHandle

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

Converts to this type from the input type.

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

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

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

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

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<'a> PartialEq for DisplayHandle<'a>

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

Tests for self and other values to be equal, and is used by ==.

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

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

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

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

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