Skip to main content

Gpu

Struct Gpu 

Source
pub struct Gpu { /* private fields */ }
Expand description

wgpu device + surface bundle for one OS window.

Implementations§

Source§

impl Gpu

Source

pub fn surface_configured(&self) -> bool

Is the swap chain currently configured?

false while a configure-failure run is in progress: a Surface::configure (in Self::resize or Self::try_acquire_frame) failed and no retry has succeeded yet, so Self::try_acquire_frame will skip frames until one does. A shell can use this to hold off attempts that cannot succeed — agg-gui-shell stops painting a minimized window only while this is false. Read-only; true again as soon as a configure succeeds.

Source

pub fn try_acquire_frame(&self) -> Result<FrameAcquire, SurfaceError>

Acquire the next surface texture.

  • A stale swap chain (Outdated/Lost) is reconfigured and the acquire retried once, this call.
  • A swap chain left unconfigured by a failed configure (here or in Self::resize) is configured again first, paced by a backoff: the first retry is immediate, later ones wait 50 ms doubling to 1 s, and a call made before the next attempt is due skips without calling configure (each attempt costs a full GPU wait-idle).
  • Otherwise the frame is skipped with the RetryWake the caller should arrange; see FrameAcquire.
§Errors

SurfaceError::ConfigureRetriesExhausted once a configure retry fails after the surface has been unconfigured for longer than crate::GpuConfig::surface_retry_budget and at least 12 attempts in the run have failed.

While the window is minimized and Self::surface_configured is false, don’t call this: every configure retry against a minimized window fails and counts against the budget (agg-gui-shell skips the paint in exactly that state). The budget clock still runs from the run’s first failure while attempts are paused, so it is the attempt minimum that gives a restored window a real retry run (about 6.5 s) instead of an exit at its first failed retry.

A lost device also fails configure; shells should check Self::device_lost before each frame and rebuild the Gpu, which starts with a fresh retry state, rather than let the budget run out.

Source

pub fn acquire_frame(&self, request_redraw: impl Fn()) -> Option<SurfaceTexture>

Legacy form of Self::try_acquire_frame, kept for existing callers. Prefer try_acquire_frame; this will be deprecated in 0.6.

Returns None when the frame must be skipped, and arranges the retry itself: RetryWake::Now calls request_redraw (pass a closure that calls Window::request_redraw), RetryWake::After schedules agg_gui::animation::request_draw_after — agg_gui’s thread-local draw state, so call this on the UI thread — and RetryWake::OnEvent does nothing.

§Panics

When Self::try_acquire_frame returns SurfaceError — the surface could not be configured for the whole retry budget. Before the retry existed the first failed configure panicked inside wgpu, so this keeps crash-and-restart supervision working; handle the error instead by moving to try_acquire_frame.

Source§

impl Gpu

Source

pub fn new( target: impl Into<SurfaceTarget<'static>>, size: (u32, u32), config: GpuConfig, ) -> Result<Self, GpuInitError>

Create the surface, adapter, device and queue for target (typically an Arc<winit::window::Window>) and configure the swap chain at size physical pixels, clamped by clamp_surface_size.

A non-sRGB surface format is preferred so the renderer’s colour maths — which writes linear-space values — isn’t gamma-corrected twice by the surface.

Source

pub fn device_lost(&self) -> bool

Has this device been lost since it was created?

Set from wgpu’s device-lost callback (TDR / driver reset / GPU removal / RDP session change); our own Device::destroy is not counted. A lost device cannot be revived — every resource created from it is dead too — so the only recovery is to build a fresh Gpu for the same window, rebuild the renderer on the new device, and drop any GPU resources the app cached. Shells should poll this once per frame.

The C# port polls the same flag at the top of a frame and rebuilds from it in PlatformWin32/win32/WebGpuControl.cs::TryRecoverDevice (agg-sharp), which is the closest thing to a reference implementation of the recovery this flag is meant to drive.

Source

pub fn device(&self) -> &Arc<Device> ⓘ

Source

pub fn queue(&self) -> &Arc<Queue> ⓘ

Source

pub fn surface(&self) -> &Surface<'static>

Source

pub fn surface_format(&self) -> TextureFormat

Source

pub fn config(&self) -> &SurfaceConfiguration

The live swap-chain configuration — width / height are the clamped physical pixel size the shell should hand to layout and WgpuGfxCtx.

Source

pub fn resize(&mut self, w: u32, h: u32)

Reconfigure the swap chain for a new physical size. A zero-sized (minimized) window is ignored — there is no presentable surface then, and wgpu rejects a zero extent.

A failed configure (DX12 ResizeBuffers rejecting a window Windows is still settling) does not panic: it is recorded, logged, and retried by Self::try_acquire_frame with backoff. A new size is new information, so it is configured immediately even while an earlier failure is backing off.

Auto Trait Implementations§

§

impl !Freeze for Gpu

§

impl !RefUnwindSafe for Gpu

§

impl !UnwindSafe for Gpu

§

impl Send for Gpu

§

impl Sync for Gpu

§

impl Unpin for Gpu

§

impl UnsafeUnpin for Gpu

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,