Struct Image

pub struct Image(/* private fields */);

Graphics image object.

Implementations

impl Image

pub fn create((width, height): (u32, u32), with_alpha: bool) -> Result<Image>

Create a new blank image.

pub fn new((width, height): (u32, u32), with_alpha: bool) -> Result<Image>

👎Deprecated: Use Image::create instead.

Create a new blank image.

pub fn with_data( (width, height): (u32, u32), with_alpha: bool, pixmap: &[u8], ) -> Result<Image>

Create image from BGRA data. Size of the pixmap is width * height * 4 bytes.

pub fn load(image_data: &[u8]) -> Result<Image>

Load image from memory.

Supported formats are: GIF, JPEG, PNG, WebP. On Windows also are BMP, ICO, TIFF and WMP.

pub fn save(&self, encoding: SaveImageEncoding) -> Result<Vec<u8>>

Save content of the image as a byte vector.

pub fn paint<PaintFn>(&mut self, painter: PaintFn) -> Result<()>

where PaintFn: Fn(&mut Graphics, (f32, f32)) -> Result<()>,

Render on bitmap image using methods of the Graphics object.

The image must be created using Image::new() or Image::with_data() methods or loaded from a BMP file.

PaintFn painter type must be the following:

use sciter::graphics::{Graphics, Result};

fn paint(gfx: &mut Graphics, (width, height): (f32, f32)) -> Result<()>

Note that errors inside painter are promoted back to the caller of the paint().

Example:

let mut image = Image::new((100, 100), false).unwrap();
image.paint(|gfx, size| {
  gfx.rectangle((5.0, 5.0), (size.0 - 5.0, size.1 - 5.0))?;
  Ok(())
}).unwrap();

pub fn dimensions(&self) -> Result<(u32, u32)>

Get width and height of the image (in pixels).

pub fn clear(&mut self) -> Result<()>

Clear image by filling it with the black color.

pub fn clear_with(&mut self, color: Color) -> Result<()>

Clear image by filling it with the specified color.

Trait Implementations

impl Clone for Image

Copies image object.

All allocated objects are reference counted so copying is just a matter of increasing reference counts.

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Drop for Image

Destroy pointed image object.

fn drop(&mut self)

Executes the destructor for this type.

impl From<Image> for Value

Store the Image object as a Value.

fn from(i: Image) -> Value

Converts to this type from the input type.

impl FromValue for Image

Get an Image object contained in the Value.

fn from_value(v: &Value) -> Option<Image>

Converts value to specified type.