Enum raw_window_handle::RawDisplayHandle

#[non_exhaustive]
pub enum RawDisplayHandle {
    UiKit(UiKitDisplayHandle),
    AppKit(AppKitDisplayHandle),
    Orbital(OrbitalDisplayHandle),
    Ohos(OhosDisplayHandle),
    Xlib(XlibDisplayHandle),
    Xcb(XcbDisplayHandle),
    Wayland(WaylandDisplayHandle),
    Drm(DrmDisplayHandle),
    Gbm(GbmDisplayHandle),
    Windows(WindowsDisplayHandle),
    Web(WebDisplayHandle),
    Android(AndroidDisplayHandle),
    Haiku(HaikuDisplayHandle),
}

A display server handle for a particular windowing system.

The display usually represents a connection to some display server, but it is not necessarily tied to a particular window. Some APIs can use the display handle without ever creating a window handle (e.g. offscreen rendering, headless event handling).

Each variant contains a struct with fields specific to that windowing system (e.g. XlibDisplayHandle contains a Display connection to an X Server, WaylandDisplayHandle uses wl_display to connect to a compositor). Not all windowing systems have a separate display handle (or they haven’t been implemented yet) and their variants contain empty structs.

Variant Availability

Note that all variants are present on all targets (none are disabled behind #[cfg]s), but see the “Availability Hints” section on each variant for some hints on where this variant might be expected.

Note that these “Availability Hints” are not normative. That is to say, a HasDisplayHandle implementor is completely allowed to return something unexpected. (For example, it’s legal for someone to return a RawDisplayHandle::Xlib on macOS, it would just be weird, and probably requires something like XQuartz be used).

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

UiKit(UiKitDisplayHandle)

A raw display handle for UIKit (Apple’s non-macOS windowing library).

Availability Hints

This variant is likely to be used on iOS, tvOS, (in theory) watchOS, and Mac Catalyst ($arch-apple-ios-macabi targets, which can notably use UIKit or AppKit), as these are the targets that (currently) support UIKit.

AppKit(AppKitDisplayHandle)

A raw display handle for AppKit.

Availability Hints

This variant is likely to be used on macOS, although Mac Catalyst ($arch-apple-ios-macabi targets, which can notably use UIKit or AppKit) can also use it despite being target_os = "ios".

Orbital(OrbitalDisplayHandle)

A raw display handle for the Redox operating system.

Availability Hints

This variant is used by the Orbital Windowing System in the Redox operating system.

Ohos(OhosDisplayHandle)

A raw display handle for OpenHarmony OS NDK

Availability Hints

This variant is used on OpenHarmony OS (target_env = "ohos").

Xlib(XlibDisplayHandle)

A raw display handle for Xlib.

Availability Hints

This variant is likely to show up anywhere someone manages to get X11 working that Xlib can be built for, which is to say, most (but not all) Unix systems.

Xcb(XcbDisplayHandle)

A raw display handle for Xcb.

Availability Hints

This variant is likely to show up anywhere someone manages to get X11 working that XCB can be built for, which is to say, most (but not all) Unix systems.

Wayland(WaylandDisplayHandle)

A raw display handle for Wayland.

Availability Hints

This variant should be expected anywhere Wayland works, which is currently some subset of unix systems.

Drm(DrmDisplayHandle)

A raw display handle for the Linux Kernel Mode Set/Direct Rendering Manager

Availability Hints

This variant is used on Linux when neither X nor Wayland are available

Gbm(GbmDisplayHandle)

A raw display handle for the Linux Generic Buffer Manager.

Availability Hints

This variant is present regardless of windowing backend and likely to be used with EGL_MESA_platform_gbm or EGL_KHR_platform_gbm.

Windows(WindowsDisplayHandle)

A raw display handle for Win32.

Availability Hints

This variant is used on Windows systems.

Web(WebDisplayHandle)

A raw display handle for the Web.

Availability Hints

This variant is used on Wasm or asm.js targets when targeting the Web/HTML5.

Android(AndroidDisplayHandle)

A raw display handle for Android NDK.

Availability Hints

This variant is used on Android targets.

Haiku(HaikuDisplayHandle)

A raw display handle for Haiku.

Availability Hints

This variant is used on HaikuOS.

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 Clone for RawDisplayHandle

fn clone(&self) -> RawDisplayHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RawDisplayHandle

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

Formats the value using the given formatter.

impl From<AndroidDisplayHandle> for RawDisplayHandle

fn from(value: AndroidDisplayHandle) -> Self

Converts to this type from the input type.

impl From<AppKitDisplayHandle> for RawDisplayHandle

fn from(value: AppKitDisplayHandle) -> Self

Converts to this type from the input type.

impl From<DisplayHandle<'_>> for RawDisplayHandle

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

Converts to this type from the input type.

impl From<DrmDisplayHandle> for RawDisplayHandle

fn from(value: DrmDisplayHandle) -> Self

Converts to this type from the input type.

impl From<GbmDisplayHandle> for RawDisplayHandle

fn from(value: GbmDisplayHandle) -> Self

Converts to this type from the input type.

impl From<HaikuDisplayHandle> for RawDisplayHandle

fn from(value: HaikuDisplayHandle) -> Self

Converts to this type from the input type.

impl From<OhosDisplayHandle> for RawDisplayHandle

fn from(value: OhosDisplayHandle) -> Self

Converts to this type from the input type.

impl From<OrbitalDisplayHandle> for RawDisplayHandle

fn from(value: OrbitalDisplayHandle) -> Self

Converts to this type from the input type.

impl From<UiKitDisplayHandle> for RawDisplayHandle

fn from(value: UiKitDisplayHandle) -> Self

Converts to this type from the input type.

impl From<WaylandDisplayHandle> for RawDisplayHandle

fn from(value: WaylandDisplayHandle) -> Self

Converts to this type from the input type.

impl From<WebDisplayHandle> for RawDisplayHandle

fn from(value: WebDisplayHandle) -> Self

Converts to this type from the input type.

impl From<WindowsDisplayHandle> for RawDisplayHandle

fn from(value: WindowsDisplayHandle) -> Self

Converts to this type from the input type.

impl From<XcbDisplayHandle> for RawDisplayHandle

fn from(value: XcbDisplayHandle) -> Self

Converts to this type from the input type.

impl From<XlibDisplayHandle> for RawDisplayHandle

fn from(value: XlibDisplayHandle) -> Self

Converts to this type from the input type.

impl Hash for RawDisplayHandle

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 for RawDisplayHandle

fn eq(&self, other: &RawDisplayHandle) -> 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 Copy for RawDisplayHandle

impl Eq for RawDisplayHandle

impl StructuralPartialEq for RawDisplayHandle