Struct sfml::graphics::Image

pub struct Image { /* fields omitted */ }

Loading, manipulating and saving images.

Methods

impl Image

pub fn new(width: u32, height: u32) -> Self

Create an image

This image is filled with black pixels.

Arguments

• width - Width of the image
• height - Height of the image

pub fn from_stream<T: Read + Seek>(stream: &mut T) -> Option<Self>

Create an image from a stream.

This image is filled with black pixels.

Arguments

• stream - Your struct, implementing Read and Seek

Return Some(Image) or None

pub fn from_memory(mem: &[u8]) -> Option<Self>

Create an image from memory

This image is filled with black pixels.

Arguments

• mem - Pointer to the file data in memory

Return Some(Image) or None

pub fn from_color(width: u32, height: u32, color: Color) -> Option<Self>

Create an image and fill it with a unique color

Arguments

• width - Width of the image
• height - Height of the image
• color - Fill color

Return Some(Image) or None

pub fn from_file(filename: &str) -> Option<Self>

Create an image from a file on disk

The supported image formats are bmp, png, tga, jpg, gif, psd, hdr and pic. Some format options are not supported, like progressive jpeg. If this function fails, the image is left unchanged.

Arguments

• filename - Path of the image file to load

Return Some(Image) or None

pub fn create_from_pixels(
    width: u32,
    height: u32,
    pixels: &[u8]
) -> Option<Self>

Create an image from an vector of pixels

The pixel vector is assumed to contain 32-bits RGBA pixels, and have the given width and height. If not, this is an undefined behaviour.

Arguments

• width - Width of the image
• height - Height of the image
• pixels - Vector of pixels to copy to the image

Return Some(Image) or None

pub fn save_to_file(&self, filename: &str) -> bool

Save an image to a file on disk

The format of the image is automatically deduced from the extension. The supported image formats are bmp, png, tga and jpg. The destination file is overwritten if it already exists. This function fails if the image is empty.

Arguments

• filename - Path of the file to save

Return true if saving was successful

pub fn size(&self) -> Vector2u

Return the size of an image

Return the size in pixels

pub fn create_mask_from_color(&self, color: Color, alpha: u8)

Create a transparency mask from a specified color-key

This function sets the alpha value of every pixel matching the given color to alpha (0 by default), so that they become transparent.

Arguments

• color - Color to make transparent
• alpha - Alpha value to assign to transparent pixels

pub fn set_pixel(&mut self, x: u32, y: u32, color: Color)

Change the color of a pixel in an image

This function doesn't check the validity of the pixel coordinates, using out-of-range values will result in an undefined behaviour.

Arguments

• x - X coordinate of pixel to change
• y - Y coordinate of pixel to change
• color - New color of the pixel

pub fn pixel_at(&self, x: u32, y: u32) -> Color

Get the color of a pixel in an image

This function doesn't check the validity of the pixel coordinates, using out-of-range values will result in an undefined behaviour.

Arguments

• x - X coordinate of pixel to get
• y - Y coordinate of pixel to get

Return the Color of the pixel at coordinates (x, y)

pub fn pixel_data(&self) -> &[u8]

Return the memory buffer of this image.

pub fn flip_horizontally(&mut self)

Flip an image horizontally (left <-> right)

pub fn flip_vertically(&mut self)

Flip an image vertically (top <-> bottom)

pub fn copy_image(
    &mut self,
    source: &Image,
    dest_x: u32,
    dest_y: u32,
    source_rect: &IntRect,
    apply_alpha: bool
)

Copy pixels from an image onto another

This function does a slow pixel copy and should not be used intensively. It can be used to prepare a complex static image from several others, but if you need this kind of feature in real-time you'd better use RenderTexture.

If sourceRect is empty, the whole image is copied. If applyAlpha is set to true, the transparency of source pixels is applied. If it is false, the pixels are copied unchanged with their alpha value.

Arguments

• source - Source image to copy
• destX - X coordinate of the destination position
• destY - Y coordinate of the destination position
• sourceRect - Sub-rectangle of the source image to copy
• applyAlpha - Should the copy take in account the source transparency?

Trait Implementations

impl Drop for Image

fn drop(&mut self)

Executes the destructor for this type.

impl Clone for Image

fn clone(&self) -> Self

Return a new Image or panic! if there is not enough memory

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.