Struct Connection

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

A no-op connection.

Fields

native_connection: Arc<NativeConnectionWrapper>

Implementations

impl Connection

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

Opens a surfaceless Mesa display.

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

An alias for Connection::new(), present for consistency with other backends.

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.

On the OSMesa backend, this returns a software adapter.

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

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

On the OSMesa backend, this returns a software adapter.

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, _: NativeDevice, ) -> Result<Device, Error>

An alias for connection.create_device() with the default adapter.

pub fn from_display_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, _: WindowHandle<'_>, _size: Size2D<i32>, ) -> Result<NativeWidget, Error>

Create a native widget type from the given WindowHandle.

Trait Implementations

impl Clone for Connection

fn clone(&self) -> Connection

Returns a duplicate 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.