Struct WGPUBackend 

pub struct WGPUBackend { /* private fields */ }

The wgpu-backed Backend implementation. Inserted as a resource once init finishes (see the Backend trait docs for how that’s driven); everything in super that uploads to the GPU (Res<WGPUBackend> in an Asset::upload impl) reads device/queue directly off this.

device/queue/surface/config are pub(crate) — every builder in wgpu::prelude that needs the device takes &WGPUBackend directly instead of a raw &wgpu::Device. Surface dimensions/format are exposed via surface_width/surface_height/ surface_format instead of the raw wgpu::SurfaceConfiguration.

Implementations

impl WGPUBackend

pub fn surface_width(&self) -> u32

Current surface width in pixels.

pub fn surface_height(&self) -> u32

Current surface height in pixels.

pub fn surface_format(&self) -> TextureFormat

The format the surface was negotiated at (a preferred sRGB format, chosen when the backend initializes).

pub fn sample_count(&self) -> u32

The multisample count ColorTarget::Default rendering (the window surface) currently uses — 1 (no MSAA) until set_msaa is called. A material meant to render into the default target needs Material { sample_count: backend.sample_count(), .. } to match.

pub fn set_msaa(&mut self, sample_count: u32)

Turns on (sample_count > 1) or off (sample_count: 1) multisampled rendering into the window surface. Builds — or rebuilds, matching the current surface size — an internal multisampled color texture that ColorTarget::Default renders into and automatically resolves from into the real surface; resize keeps it matched to the surface size afterward. Call this once at startup (or whenever you want to change the sample count), before building any material meant to render into the default target — see sample_count. Any depth attachment used alongside it needs a matching TextureBuilder::sample_count.

impl WGPUBackend

pub fn create_command_encoder(&self, label: Option<&str>) -> CommandEncoder

Starts a command encoder for standalone GPU work not tied to an acquired frame — a compute dispatch outside SystemStage::Render, say. Begin a ComputePass on it via CommandEncoder::compute_pass, then hand it to submit when done. Render passes don’t need this — ActiveFrame::begin_pass manages its own frame-tied encoder internally.

pub fn submit(&self, encoder: CommandEncoder)

Finishes and submits encoder’s recorded commands to the queue.

Trait Implementations

impl Asset<WGPUBackend> for GPUCompute

type Source = Compute

The raw source representation stored in Assets.

type Deps<'a> = ()

Resources (beyond B itself) required to perform the conversion. Use () when there are no extra dependencies.

fn upload<'a>( source: &Compute, backend: &WGPUBackend, _deps: &(), ) -> Option<Self>

Convert source into a processed asset using backend and deps.

impl Asset<WGPUBackend> for GPUCubemap

type Source = Cubemap

The raw source representation stored in Assets.

type Deps<'a> = Res<'a, MipmapGenerator>

Resources (beyond B itself) required to perform the conversion. Use () when there are no extra dependencies.

fn upload<'a>( source: &Cubemap, backend: &WGPUBackend, mipmap_generator: &Res<'a, MipmapGenerator>, ) -> Option<Self>

Convert source into a processed asset using backend and deps.

impl<T> Asset<WGPUBackend> for GPUBindingInstance<T>

where T: BindGroupTarget + 'static + Send + Sync,

type Source = BindingInstance<T>

The raw source representation stored in Assets.

type Deps<'a> = (Res<'a, ProcessedAssets<T>>, Res<'a, ProcessedAssets<GPUTexture>>, Res<'a, ProcessedAssets<GPUTextureArray>>, Res<'a, ProcessedAssets<GPUCubemap>>, Res<'a, GlobalSamplers>)

Resources (beyond B itself) required to perform the conversion. Use () when there are no extra dependencies.

fn upload<'a>( source: &Self::Source, backend: &WGPUBackend, deps: &Self::Deps<'a>, ) -> Option<Self>

Convert source into a processed asset using backend and deps.

impl Asset<WGPUBackend> for GPUMaterial

type Source = Material

The raw source representation stored in Assets.

type Deps<'a> = ()

Resources (beyond B itself) required to perform the conversion. Use () when there are no extra dependencies.

fn upload<'a>( source: &Material, backend: &WGPUBackend, _deps: &(), ) -> Option<Self>

Convert source into a processed asset using backend and deps.

impl Asset<WGPUBackend> for GPUMesh

type Source = Mesh

The raw source representation stored in Assets.

type Deps<'a> = ()

Resources (beyond B itself) required to perform the conversion. Use () when there are no extra dependencies.

fn upload<'a>(source: &Mesh, backend: &WGPUBackend, _deps: &()) -> Option<Self>

Convert source into a processed asset using backend and deps.

impl Asset<WGPUBackend> for GPUTextureArray

type Source = TextureArray

The raw source representation stored in Assets.

type Deps<'a> = Res<'a, MipmapGenerator>

Resources (beyond B itself) required to perform the conversion. Use () when there are no extra dependencies.

fn upload<'a>( source: &TextureArray, backend: &WGPUBackend, mipmap_generator: &Res<'a, MipmapGenerator>, ) -> Option<Self>

Convert source into a processed asset using backend and deps.

impl Asset<WGPUBackend> for GPUTexture

type Source = Texture

The raw source representation stored in Assets.

type Deps<'a> = Res<'a, MipmapGenerator>

Resources (beyond B itself) required to perform the conversion. Use () when there are no extra dependencies.

fn upload<'a>( source: &Texture, backend: &WGPUBackend, mipmap_generator: &Res<'a, MipmapGenerator>, ) -> Option<Self>

Convert source into a processed asset using backend and deps.

impl Backend for WGPUBackend

fn init( handle: impl GPUSurfaceHandle, width: u32, height: u32, sender: InitSender<Self>, )

Native blocks the calling thread on init_async via pollster::block_on (fine here — this only runs once, during App::build, and there’s no other work competing for the thread yet). Web can’t block its single thread, so it hands init_async to wasm_bindgen_futures::spawn_local instead and returns immediately — GraphicsPlugin polls the resulting sender/InitReceiver pair every tick either way, so callers don’t need to know which path ran. A second Backend implementation should follow the same split if it also needs to run on both targets.

type Frame = WGPUFrame

The per-frame type that exposes rendering operations.

fn resize(&mut self, width: u32, height: u32)

Called when the window is resized. Override to recreate the swapchain.

fn acquire(&mut self) -> Result<Self::Frame, AcquireError>

Acquire the next frame for rendering.

fn present(&mut self, frame: Self::Frame)

Present the completed frame to the display.

impl LazyResource<WGPUBackend> for MipmapGenerator

type Deps<'a> = ()

Other resources this singleton needs before it can be built. Use () if none are needed.

fn construct<'a>(backend: &WGPUBackend, _deps: &()) -> Option<Self>

Attempt to construct this singleton. Return None if construction can’t succeed yet for a reason not already covered by Deps readiness (e.g. a transient condition) — the plugin will retry next tick.

impl LazyResource<WGPUBackend> for GlobalSamplers

type Deps<'a> = ()

Other resources this singleton needs before it can be built. Use () if none are needed.

fn construct<'a>(backend: &WGPUBackend, _deps: &()) -> Option<Self>

Attempt to construct this singleton. Return None if construction can’t succeed yet for a reason not already covered by Deps readiness (e.g. a transient condition) — the plugin will retry next tick.