Trait Headless

pub trait Headless {
    // Required methods
    fn new(
        default_font: Font,
        default_text_size: Pixels,
        backend: Option<&str>,
    ) -> impl Future<Output = Option<Self>>
       where Self: Sized;
    fn name(&self) -> String;
    fn screenshot(
        &mut self,
        size: Size<u32>,
        scale_factor: f32,
        background_color: Color,
    ) -> Vec<u8> ;
}

Available on crate feature advanced only.

A headless renderer is a renderer that can render offscreen without a window nor a compositor.

Required Methods

fn new( default_font: Font, default_text_size: Pixels, backend: Option<&str>, ) -> impl Future<Output = Option<Self>>

where Self: Sized,

Creates a new Headless renderer;

fn name(&self) -> String

Returns the unique name of the renderer.

This name may be used by testing libraries to uniquely identify snapshots.

fn screenshot( &mut self, size: Size<u32>, scale_factor: f32, background_color: Color, ) -> Vec<u8>

Draws offscreen into a screenshot, returning a collection of bytes representing the rendered pixels in RGBA order.

Implementations on Foreign Types

impl Headless for Renderer

async fn new( default_font: Font, default_text_size: Pixels, backend: Option<&str>, ) -> Option<Renderer>

fn name(&self) -> String

fn screenshot( &mut self, size: Size<u32>, scale_factor: f32, background_color: Color, ) -> Vec<u8>

impl Headless for Renderer

async fn new( default_font: Font, default_text_size: Pixels, backend: Option<&str>, ) -> Option<Renderer>

fn name(&self) -> String

fn screenshot( &mut self, size: Size<u32>, scale_factor: f32, background_color: Color, ) -> Vec<u8>

impl<A, B> Headless for Renderer<A, B>

where A: Headless, B: Headless,

async fn new( default_font: Font, default_text_size: Pixels, backend: Option<&str>, ) -> Option<Renderer<A, B>>

fn name(&self) -> String

fn screenshot( &mut self, size: Size<u32>, scale_factor: f32, background_color: Color, ) -> Vec<u8>

Implementors