Struct ggez::graphics::ScreenImage

pub struct ScreenImage { /* private fields */ }

An image which is sized relative to the screen. This is primarily for canvas images.

Implementations

impl ScreenImage

pub fn new( gfx: &impl Has<GraphicsContext>, format: impl Into<Option<ImageFormat>>, width: f32, height: f32, samples: u32 ) -> Self

Creates a new ScreenImage with the given parameters.

width and height specify the fraction of the framebuffer width and height that the Image will have. For example, width = 1.0 and height = 1.0 means the image will be the same size as the framebuffer.

If format is None then the format will be inferred from the surface format.

pub fn image(&mut self, gfx: &impl Has<GraphicsContext>) -> Image

Returns the inner Image, also recreating it if the framebuffer has been resized.

Trait Implementations

impl Clone for ScreenImage

fn clone(&self) -> ScreenImage

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ScreenImage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.