Struct nannou_wgpu::ActiveAdapter

pub struct ActiveAdapter { /* fields omitted */ }

A single active adapter and its map of connected devices.

Implementations

impl ActiveAdapter

pub fn get_or_request_device(
    &self,
    descriptor: DeviceDescriptor<'static>
) -> Arc<DeviceQueuePair>

Check for a device with the given descriptor or request one.

First checks for a connected device that matches the given descriptor. If one exists, it is returned. Otherwise, a new device connection is requested via Adapter::request_device.

pub fn request_device(
    &self,
    descriptor: DeviceDescriptor<'static>
) -> Arc<DeviceQueuePair>

Request a device with the given descriptor.

This will always request a new device connection and will never attempt to share an existing one. The new device will take the place of the old within the map in the case that an existing connected device exists.

pub async fn get_or_request_device_async(
    &self,
    descriptor: DeviceDescriptor<'static>
) -> Arc<DeviceQueuePair>

Check for a device with the given descriptor or request one.

First checks for a connected device that matches the given descriptor. If one exists, it is returned. Otherwise, a new device connection is requested via Adapter::request_device.

pub async fn request_device_async(
    &self,
    descriptor: DeviceDescriptor<'static>
) -> Arc<DeviceQueuePair>

Request a device with the given descriptor.

This will always request a new device connection and will never attempt to share an existing one. The new device will take the place of the old within the map in the case that an existing connected device exists.

pub fn device_count(&self) -> usize

A count of devices that are currently active.

pub fn clear_inactive_devices(&self)

Clear all device queue pairs that have been dropped.

Methods from Deref<Target = Adapter>

pub fn request_device(
    &self,
    desc: &DeviceDescriptor<Option<&str>>,
    trace_path: Option<&Path>
) -> impl Future<Output = Result<(Device, Queue), RequestDeviceError>> + Send

Requests a connection to a physical device, creating a logical device.

Returns the Device together with a Queue that executes command buffers.

Arguments

• desc - Description of the features and limits requested from the given device.
• trace_path - Can be used for API call tracing, if that feature is enabled in wgpu-core.

Panics

• Features specified by desc are not supported by this adapter.
• Unsafe features were requested but not enabled when requesting the adapter.
• Limits requested exceed the values provided by the adapter.
• Adapter does not support all features wgpu requires to safely operate.

pub unsafe fn create_device_from_hal<A>(
    &self,
    hal_device: OpenDevice<A>,
    desc: &DeviceDescriptor<Option<&str>>,
    trace_path: Option<&Path>
) -> Result<(Device, Queue), RequestDeviceError> where
    A: HalApi, 

Create a wgpu Device and Queue from a wgpu-hal OpenDevice

Safety

• hal_device must be created from this adapter internal handle.
• desc.features must be a subset of hal_device features.

pub fn is_surface_supported(&self, surface: &Surface) -> bool

Returns whether this adapter may present to the passed surface.

pub fn features(&self) -> Features

List all features that are supported with this adapter.

Features must be explicitly requested in Adapter::request_device in order to use them.

pub fn limits(&self) -> Limits

List the “best” limits that are supported by this adapter.

Limits must be explicitly requested in Adapter::request_device to set the values that you are allowed to use.

pub fn get_info(&self) -> AdapterInfo

Get info about the adapter itself.

pub fn get_downlevel_properties(&self) -> DownlevelCapabilities

Get info about the adapter itself.

pub fn get_texture_format_features(
    &self,
    format: TextureFormat
) -> TextureFormatFeatures

Returns the features supported for a given texture format by this adapter.

Note that the WebGPU spec further restricts the available usages/features. To disable these restrictions on a device, request the Features::TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES feature.

Trait Implementations

impl Deref for ActiveAdapter

type Target = Adapter

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.