Skip to main content

WgpuBackend

Struct WgpuBackend 

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

Headless GPU backend implementing RenderBackend.

Implementations§

Source§

impl WgpuBackend

Source

pub fn headless(width: u32, height: u32) -> Result<Self, UiError>

Initialise a headless backend with an offscreen target of width × height physical pixels.

§Errors

Returns UiError::Unsupported when no GPU adapter is available (so the caller can skip on a machine without a usable GPU), or UiError::Backend when device creation fails.

Source

pub fn set_clear_color(&mut self, color: Color)

Set the colour the offscreen target is cleared to before each frame.

Source

pub fn clear_color(&self) -> Color

Return the current clear colour.

Source

pub fn width(&self) -> u32

Target width in physical pixels.

Source

pub fn height(&self) -> u32

Target height in physical pixels.

Source

pub fn readback_rgba(&self) -> Result<Vec<u8>, UiError>

Read the offscreen colour target back into a tightly packed width * height * 4 RGBA byte vector (row padding stripped).

§Errors

Returns UiError::Render if the GPU poll or buffer mapping fails.

Source

pub fn read_pixel( &self, x: u32, y: u32, ) -> Result<Option<(u8, u8, u8, u8)>, UiError>

Read back a single pixel as (r, g, b, a), or None if out of bounds.

Trait Implementations§

Source§

impl RenderBackend for WgpuBackend

Source§

fn surface_size(&self) -> Size

Return the target surface dimensions in physical pixels.
Source§

fn supports_gradients(&self) -> bool

Return true if this backend can render gradient fills.
Source§

fn supports_paths(&self) -> bool

Return true if this backend can render arbitrary vector paths.
Source§

fn execute(&mut self, list: &DrawList) -> Result<(), UiError>

Replay an entire DrawList onto the backend’s surface. Read more
Source§

fn supports_blur(&self) -> bool

Return true if this backend can render blur effects (e.g. box shadows).
Source§

fn supports_images(&self) -> bool

Return true if this backend can blit ImageData.
Source§

fn supports_text(&self) -> bool

Return true if this backend can render text via DrawCommand::DrawText.

Auto Trait Implementations§

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<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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

impl<T> WasmNotSendSync for T

Source§

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