Enum raw_window_handle::RawDisplayHandle

source ·

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

Expand description

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 HasRawDisplayHandle 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)§

This enum is marked as 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.

§

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.

§