Struct Compositor

pub struct Compositor { /* private fields */ }

A window graphics backend for iced powered by wgpu.

Implementations

impl Compositor

pub async fn request<W: Window>( settings: Settings, compatible_window: Option<W>, ) -> Result<Self, Error>

Requests a new Compositor with the given Settings.

Returns None if no compatible graphics adapter could be found.

Trait Implementations

impl Compositor for Compositor

type Renderer = Renderer

The iced renderer of the backend.

type Surface = Surface<'static>

The surface of the backend.

async fn with_backend<W: Window>( settings: Settings, compatible_window: W, backend: Option<&str>, ) -> Result<Self, Error>

Creates a new [Compositor] with a backend preference.

fn create_renderer(&self) -> Self::Renderer

Creates a [Self::Renderer] for the [Compositor].

fn create_surface<W: Window>( &mut self, window: W, width: u32, height: u32, ) -> Self::Surface

Crates a new Surface for the given window.

fn configure_surface( &mut self, surface: &mut Self::Surface, width: u32, height: u32, )

Configures a new Surface with the given dimensions.

fn fetch_information(&self) -> Information

Returns [Information] used by this [Compositor].

fn present<T: AsRef<str>>( &mut self, renderer: &mut Self::Renderer, surface: &mut Self::Surface, viewport: &Viewport, background_color: Color, overlay: &[T], ) -> Result<(), SurfaceError>

Presents the Renderer primitives to the next frame of the given Surface.

fn screenshot<T: AsRef<str>>( &mut self, renderer: &mut Self::Renderer, viewport: &Viewport, background_color: Color, overlay: &[T], ) -> Vec<u8>

Screenshots the current Renderer primitives to an offscreen texture, and returns the bytes of the texture ordered as RGBA in the sRGB color space.

fn new<W>( settings: Settings, compatible_window: W, ) -> impl Future<Output = Result<Self, Error>>

where W: Window + Clone,

Creates a new [Compositor].

fn load_font(&mut self, font: Cow<'static, [u8]>)

Loads a font from its bytes.