Struct ggez::graphics::Image

pub struct Image { /* private fields */ }

Handle to an image stored in GPU memory.

Implementations

impl Image

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

Creates a new image specifically for use with a Canvas.

pub fn from_color( gfx: &impl Has<GraphicsContext>, width: u32, height: u32, color: Option<Color> ) -> Self

A little helper function that creates a blank Image that is of the given width and height and optional color.

The default color is Color::WHITE. Mainly useful for debugging.

pub fn from_pixels( gfx: &impl Has<GraphicsContext>, pixels: &[u8], format: ImageFormat, width: u32, height: u32 ) -> Self

Creates a new image initialized with given pixel data.

pub fn from_path( gfx: &impl Has<GraphicsContext>, path: impl AsRef<Path> ) -> GameResult<Self>

Creates a new image initialized with pixel data loaded from a given path as an encoded image Read (e.g. PNG or JPEG).

pub fn from_bytes( gfx: &impl Has<GraphicsContext>, encoded: &[u8] ) -> Result<Image, GameError>

Creates a new image initialized with pixel data from a given encoded image (e.g. PNG or JPEG)

pub fn wgpu(&self) -> (&Texture, &TextureView)

Returns the underlying wgpu::Texture and wgpu::TextureView for this Image.

pub fn to_pixels(&self, gfx: &impl Has<GraphicsContext>) -> GameResult<Vec<u8>>

Reads the pixels of this ImageView and returns as Vec<u8>. The format matches the GPU image format.

This is a very expensive operation - call sparingly.

pub fn encode( &self, ctx: &Context, format: ImageEncodingFormat, path: impl AsRef<Path> ) -> GameResult

Encodes the ImageView to the given file format and return the encoded bytes.

This is a very expensive operation - call sparingly.

pub fn format(&self) -> ImageFormat

Returns the image format of this image.

pub fn samples(&self) -> u32

Returns the number of MSAA samples this image has.

pub fn width(&self) -> u32

Returns the width (in pixels) of the image.

pub fn height(&self) -> u32

Returns the height (in pixels) of the image.

pub fn uv_rect(&self, x: u32, y: u32, w: u32, h: u32) -> Rect

Helper function that calculates a sub-rectangle of this image in UV coordinates, given pixel coordinates.

Trait Implementations

impl Clone for Image

fn clone(&self) -> Image

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Image

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

Formats the value using the given formatter.

impl Drawable for Image

fn draw(&self, canvas: &mut Canvas, param: impl Into<DrawParam>)

Draws the drawable onto the canvas.

fn dimensions(&self, _gfx: &impl Has<GraphicsContext>) -> Option<Rect>

Returns a bounding box in the form of a Rect.