Enum WgpuSetup

pub enum WgpuSetup {
    CreateNew(WgpuSetupCreateNew),
    Existing(WgpuSetupExisting),
}

Variants

CreateNew(WgpuSetupCreateNew)

Construct a wgpu setup using some predefined settings & heuristics. This is the default option. You can customize most behaviours overriding the supported backends, power preferences, and device description.

By default can also be configured with various environment variables:

• WGPU_BACKEND: vulkan, dx12, metal, opengl, webgpu
• WGPU_POWER_PREF: low, high or none
• WGPU_TRACE: Path to a file to output a wgpu trace file.

Each instance flag also comes with an environment variable (for details see wgpu::InstanceFlags):

• WGPU_VALIDATION: Enables validation (enabled by default in debug builds).
• WGPU_DEBUG: Generate debug information in shaders and objects (enabled by default in debug builds).
• WGPU_ALLOW_UNDERLYING_NONCOMPLIANT_ADAPTER: Whether wgpu should expose adapters that run on top of non-compliant adapters.
• WGPU_GPU_BASED_VALIDATION: Enable GPU-based validation.

Existing(WgpuSetupExisting)

Run on an existing wgpu setup.

Implementations

impl WgpuSetup

pub async fn new_instance(&self) -> Instance

Creates a new wgpu::Instance or clones the existing one.

Does not store the wgpu instance, so calling this repeatedly may create a new instance every time!

Trait Implementations

impl Clone for WgpuSetup

fn clone(&self) -> WgpuSetup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WgpuSetup

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for WgpuSetup

fn default() -> Self

Returns the “default value” for a type.

impl From<WgpuSetupCreateNew> for WgpuSetup

fn from(create_new: WgpuSetupCreateNew) -> Self

Converts to this type from the input type.

impl From<WgpuSetupExisting> for WgpuSetup

fn from(existing: WgpuSetupExisting) -> Self

Converts to this type from the input type.