Struct coffee::graphics::Image

pub struct Image { /* fields omitted */ }

A loaded image.

You can use this to load your spritesheets and draw your sprites!

Cloning an Image is cheap, it only clones a handle. It does not create a new copy of the image on the GPU.

Implementations

impl Image

pub fn new<P: AsRef<Path>>(gpu: &mut Gpu, path: P) -> Result<Image>

Loads an Image from the given path.

pub fn load<P: Into<PathBuf>>(path: P) -> Task<Image>

Creates a Task that loads an Image from the given path.

pub fn from_image(gpu: &mut Gpu, image: &DynamicImage) -> Result<Image>

Creates an Image from a DynamicImage of the image crate.

pub fn from_colors(gpu: &mut Gpu, colors: &[Color]) -> Result<Image>

Creates an Image representing a color palette.

Each Color will be a pixel of the image, arranged horizontally.

pub fn width(&self) -> u16

Returns the width of the Image.

pub fn height(&self) -> u16

Returns the height of the Image.

pub fn draw<Q: IntoQuad>(&self, quad: Q, target: &mut Target)

Draws the Image on the given Target.

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.