Struct surfman::platform::unix::wayland::connection::Connection

pub struct Connection {
    pub(crate) native_connection: Arc<NativeConnectionWrapper>,
}

A connection to the Wayland server.

Fields

native_connection: Arc<NativeConnectionWrapper>

Implementations

impl Connection

pub fn new() -> Result<Connection, Error>

Connects to the default Wayland server.

pub unsafe fn from_native_connection( native_connection: NativeConnection, ) -> Result<Connection, Error>

Wraps an existing EGL display in a Connection.

The display is not retained, as there is no way to do this in the EGL API. Therefore, it is the caller’s responsibility to ensure that the EGL display remains alive as long as the connection is.

pub fn native_connection(&self) -> NativeConnection

Returns the underlying native connection.

pub fn gl_api(&self) -> GLApi

Returns the OpenGL API flavor that this connection supports (OpenGL or OpenGL ES).

pub fn create_adapter(&self) -> Result<Adapter, Error>

Returns the “best” adapter on this system, preferring high-performance hardware adapters.

This is an alias for Connection::create_hardware_adapter().

pub fn create_hardware_adapter(&self) -> Result<Adapter, Error>

Returns the “best” adapter on this system, preferring high-performance hardware adapters.

pub fn create_low_power_adapter(&self) -> Result<Adapter, Error>

Returns the “best” adapter on this system, preferring low-power hardware adapters.

pub fn create_software_adapter(&self) -> Result<Adapter, Error>

Returns the “best” adapter on this system, preferring software adapters.

pub fn create_device(&self, adapter: &Adapter) -> Result<Device, Error>

Opens the hardware device corresponding to the given adapter.

Device handles are local to a single thread.

pub unsafe fn create_device_from_native_device( &self, native_device: NativeDevice, ) -> Result<Device, Error>

Opens the hardware device corresponding to the adapter wrapped in the given native device.

This is present for compatibility with other backends.

unsafe fn from_wayland_display( wayland_display: *mut wl_display, is_owned: bool, ) -> Result<Connection, Error>

fn from_egl_display( egl_display: *const c_void, wayland_display: Option<*mut wl_display>, ) -> Result<Connection, Error>

pub fn from_display_handle( handle: DisplayHandle<'_>, ) -> Result<Connection, Error>

Opens the display connection corresponding to the given DisplayHandle.

pub unsafe fn create_native_widget_from_ptr( &self, raw: *mut c_void, size: Size2D<i32>, ) -> NativeWidget

Create a native widget from a raw pointer

pub fn create_native_widget_from_window_handle( &self, handle: WindowHandle<'_>, window_size: Size2D<i32>, ) -> Result<NativeWidget, Error>

Creates a native widget type from the given WindowHandle

Trait Implementations

impl Clone for Connection

fn clone(&self) -> Connection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Connection for Connection

type Adapter = Adapter

The adapter type associated with this connection.

type Device = Device

The device type associated with this connection.

type NativeConnection = NativeConnection

The native type associated with this connection.

type NativeDevice = NativeDevice

The native device type associated with this connection.

type NativeWidget = NativeWidget

The native widget type associated with this connection.

fn new() -> Result<Connection, Error>

Connects to the default display.

fn native_connection(&self) -> Self::NativeConnection

Returns the native connection corresponding to this connection.

fn gl_api(&self) -> GLApi

Returns the OpenGL API flavor that this connection supports (OpenGL or OpenGL ES).

fn create_adapter(&self) -> Result<Self::Adapter, Error>

Returns the “best” adapter on this system, preferring high-performance hardware adapters.

fn create_hardware_adapter(&self) -> Result<Self::Adapter, Error>

Returns the “best” adapter on this system, preferring high-performance hardware adapters.

fn create_low_power_adapter(&self) -> Result<Self::Adapter, Error>

Returns the “best” adapter on this system, preferring low-power hardware adapters.

fn create_software_adapter(&self) -> Result<Self::Adapter, Error>

Returns the “best” adapter on this system, preferring software adapters.

fn create_device(&self, adapter: &Adapter) -> Result<Self::Device, Error>

Opens a device.

unsafe fn create_device_from_native_device( &self, native_device: Self::NativeDevice, ) -> Result<Device, Error>

Wraps an existing native device type in a device.

fn from_display_handle(handle: DisplayHandle<'_>) -> Result<Connection, Error>

Opens the display connection corresponding to the given DisplayHandle.

unsafe fn create_native_widget_from_ptr( &self, raw: *mut c_void, size: Size2D<i32>, ) -> Self::NativeWidget

Creates a native widget from a raw pointer

fn create_native_widget_from_window_handle( &self, window: WindowHandle<'_>, size: Size2D<i32>, ) -> Result<Self::NativeWidget, Error>

Create a native widget type from the given WindowHandle.

impl Send for Connection