Type Alias Connection

pub type Connection = Connection<Device<Device, Device>, Device>;

Either a Wayland or an X11 display server connection.

Aliased Type

enum Connection {
    Default(Connection<Device, Device>),
    Alternate(Connection),
}

Variants

Default(Connection<Device, Device>)

The default connection to the display server.

Alternate(Connection)

The alternate connection to the display server.

Implementations

impl<Def, Alt> Connection<Def, Alt>

where Def: DeviceInterface, Alt: DeviceInterface, Def::Connection: ConnectionInterface<Device = Def>, Alt::Connection: ConnectionInterface<Device = Alt>,

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

Connects to the default display.

pub fn native_connection(&self) -> NativeConnection<Def, Alt>

Returns the native connection corresponding to this 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<Def, Alt>, Error>

Returns the “best” adapter on this system.

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

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

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

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

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

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

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

pub fn create_device( &self, adapter: &Adapter<Def, Alt>, ) -> Result<Device<Def, Alt>, 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<Def, Alt>, ) -> Result<Device<Def, Alt>, Error>

Wraps a native device in a device.

pub fn from_display_handle( handle: DisplayHandle<'_>, ) -> Result<Connection<Def, Alt>, 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<Def, Alt>

Create a native widget from a raw pointer

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

Create a native widget type from the given WindowHandle.

Trait Implementations

impl<Def, Alt> Clone for Connection<Def, Alt>

where Def: DeviceInterface, Alt: DeviceInterface, Def::Connection: Clone, Alt::Connection: Clone,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Def, Alt> Connection for Connection<Def, Alt>

where Def: DeviceInterface, Alt: DeviceInterface, Def::Connection: ConnectionInterface<Device = Def>, Alt::Connection: ConnectionInterface<Device = Alt>,

type Adapter = Adapter<Def, Alt>

The adapter type associated with this connection.

type Device = Device<Def, Alt>

The device type associated with this connection.

type NativeConnection = NativeConnection<Def, Alt>

The native type associated with this connection.

type NativeDevice = NativeDevice<Def, Alt>

The native device type associated with this connection.

type NativeWidget = NativeWidget<Def, Alt>

The native widget type associated with this connection.

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

Connects to the default display.

fn native_connection(&self) -> NativeConnection<Def, Alt>

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<Adapter<Def, Alt>, Error>

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

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

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

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

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

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

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

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

Opens a device.

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

Wraps an existing native device type in a device.

fn from_display_handle( handle: DisplayHandle<'_>, ) -> Result<Connection<Def, Alt>, 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>, ) -> NativeWidget<Def, Alt>

Creates a native widget from a raw pointer

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

Create a native widget type from the given WindowHandle.