Enum SurfaceTargetUnsafe 

#[non_exhaustive]
pub enum SurfaceTargetUnsafe {
    RawHandle {
        raw_display_handle: Option<RawDisplayHandle>,
        raw_window_handle: RawWindowHandle,
    },
    Drm {
        fd: i32,
        plane: u32,
        connector_id: u32,
        width: u32,
        height: u32,
        refresh_rate: u32,
    },
}

The window/canvas/surface/swap-chain/etc. a surface is attached to, for use with unsafe surface creation.

This is either a window or an actual web canvas depending on the platform and enabled features. Refer to the individual variants for more information.

See also SurfaceTarget for safe variants.

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.

RawHandle

Raw window & display handle.

If the specified display and window handle are not supported by any of the backends, then the surface will not be supported by any adapters.

If the raw_display_handle is not None here and was not None in crate::InstanceDescriptor::display, their values must be identical.

Safety

• raw_window_handle & raw_display_handle must be valid objects to create a surface upon.
• raw_window_handle & raw_display_handle must remain valid until after the returned Surface is dropped.

Fields

raw_display_handle: Option<RawDisplayHandle>

Raw display handle, underlying display must outlive the surface created from this.

raw_window_handle: RawWindowHandle

Raw window handle, underlying window must outlive the surface created from this.

Drm

Available on Unix and non-Apple and non-target_family=wasm only.

Surface from a DRM device.

If the specified DRM configuration is not supported by any of the backends, then the surface will not be supported by any adapters.

Safety

• All parameters must point to valid DRM values and remain valid for as long as the resulting Surface exists.
• The file descriptor (fd), plane, connector, and mode configuration must be valid and compatible.

Fields

fd: i32

The file descriptor of the DRM device.

plane: u32

The plane index on which to create the surface.

connector_id: u32

The ID of the connector associated with the selected mode.

width: u32

The display width of the selected mode.

height: u32

The display height of the selected mode.

refresh_rate: u32

The display refresh rate of the selected mode multiplied by 1000 (e.g., 60Hz → 60000).

Implementations

impl SurfaceTargetUnsafe

pub unsafe fn from_display_and_window( display: &impl HasDisplayHandle, window: &impl HasWindowHandle, ) -> Result<Self, HandleError>

Creates a SurfaceTargetUnsafe::RawHandle from a display and window.

The display is optional and may be omitted if it was also passed to crate::InstanceDescriptor::display. If passed to both it must (currently) be identical.

Safety

• display must outlive the resulting surface target (and subsequently the surface created for this target).
• window must outlive the resulting surface target (and subsequently the surface created for this target).

pub unsafe fn from_window( window: &impl HasWindowHandle, ) -> Result<Self, HandleError>

Creates a SurfaceTargetUnsafe::RawHandle from a window.

Safety

• window must outlive the resulting surface target (and subsequently the surface created for this target).