Struct Image

pub struct Image { /* private fields */ }

Image, pixel data stored in CPU memory (RAM)

Implementations

impl Image

pub fn width(&self) -> u32

Image base width

pub fn height(&self) -> u32

Image base height

pub fn mipmaps(&self) -> u32

Mipmap levels, 1 by default

pub fn format(&self) -> PixelFormat

Data format

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

Load image from file into CPU memory (RAM)

pub fn from_raw_file( file_name: &str, width: u32, height: u32, format: PixelFormat, header_size: u32, ) -> Option<Self>

Load image from RAW file data

pub fn from_file_anim(file_name: &str) -> Option<(Self, usize)>

Load image sequence from file (frames appended to image.data)

Returns the amount of frames in the image.

pub fn from_memory( file_data: &[u8], format: Option<ImageFormat>, ) -> Option<Self>

Load image from memory buffer

If format is None, it will make an educated guess on the ImageFormat (not all formats are supported for guessing).

pub fn from_texture(texture: &Texture) -> Option<Self>

Load image from GPU texture data

pub fn from_screen(_raylib: &Raylib) -> Option<Self>

Load image from screen buffer and (screenshot)

pub fn export(&self, file_name: &str) -> bool

Export image data to file, returns true on success

pub fn export_as_code(&self, file_name: &str) -> bool

Export image as code file defining an array of bytes, returns true on success

pub fn generate_color(width: u32, height: u32, color: Color) -> Self

Generate image: plain color

pub fn generate_gradient_vertical( width: u32, height: u32, top: Color, bottom: Color, ) -> Self

Generate image: vertical gradient

pub fn generate_gradient_horizontal( width: u32, height: u32, left: Color, right: Color, ) -> Self

Generate image: horizontal gradient

pub fn generate_gradient_radial( width: u32, height: u32, density: f32, inner: Color, outer: Color, ) -> Self

Generate image: radial gradient

pub fn generate_checked( width: u32, height: u32, checks_x: u32, checks_y: u32, color1: Color, color2: Color, ) -> Self

Generate image: checked

pub fn generate_white_noise(width: u32, height: u32, factor: f32) -> Self

Generate image: white noise

pub fn generate_perlin_noise( width: u32, height: u32, offset_x: i32, offset_y: i32, scale: f32, ) -> Self

Generate image: perlin noise

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

Generate image: cellular algorithm, bigger tileSize means bigger cells

pub fn generate_text(width: u32, height: u32, text: &str) -> Self

Generate image: grayscale image from text data

pub fn from_other_image(image: Self, rect: Rectangle) -> Self

Create an image from another image piece

pub fn text(text: &str, font_size: u32, color: Color) -> Self

Create an image from text (default font)

pub fn text_with_font( text: &str, font: &Font, font_size: f32, spacing: f32, tint: Color, ) -> Self

Create an image from text (custom sprite font)

pub fn convert_to_format(&mut self, new_format: PixelFormat)

Convert image data to desired format

pub fn convert_to_power_of_two(&mut self, fill: Color)

Convert image to POT (power-of-two)

pub fn crop(&mut self, rect: Rectangle)

Crop an image to a defined rectangle

pub fn alpha_crop(&mut self, threshold: f32)

Crop image depending on alpha value

pub fn alpha_clear(&mut self, color: Color, threshold: f32)

Clear alpha channel to desired color

pub fn alpha_mask(&mut self, alpha_mask: &Image)

Apply alpha mask to image

pub fn alpha_premultiply(&mut self)

Premultiply alpha channel

pub fn blur_gaussian(&mut self, blur_size: u32)

Apply Gaussian blur using a box blur approximation

pub fn resize(&mut self, new_width: u32, new_height: u32)

Resize image (Bicubic scaling algorithm)

pub fn resize_nn(&mut self, new_width: u32, new_height: u32)

Resize image (Nearest-Neighbor scaling algorithm)

pub fn resize_canvas( &mut self, new_width: u32, new_height: u32, offset_x: i32, offset_y: i32, fill: Color, )

Resize canvas and fill with color

pub fn compute_mipmaps(&mut self)

Compute all mipmap levels for a provided image

pub fn dither(&mut self, r_bpp: u32, g_bpp: u32, b_bpp: u32, a_bpp: u32)

Dither image data to 16bpp or lower (Floyd-Steinberg dithering)

pub fn flip_vertical(&mut self)

Flip image vertically

pub fn flip_horizontal(&mut self)

Flip image horizontally

pub fn rotate_clockwise(&mut self)

Rotate image clockwise 90deg

pub fn rotate_counter_clockwise(&mut self)

Rotate image counter-clockwise 90deg

pub fn color_tint(&mut self, color: Color)

Modify image color: tint

pub fn color_invert(&mut self)

Modify image color: invert

pub fn color_grayscale(&mut self)

Modify image color: grayscale

pub fn color_contrast(&mut self, contrast: f32)

Modify image color: contrast (-100 to 100)

pub fn color_brightness(&mut self, brightness: i32)

Modify image color: brightness (-255 to 255)

pub fn color_replace(&mut self, color: Color, replace: Color)

Modify image color: replace color

pub fn load_colors(&self) -> Vec<Color>

Load color data from image as a Color array (RGBA - 32bit)

pub fn load_palette(&self, max_size: usize) -> Vec<Color>

Load colors palette from image as a Color array (RGBA - 32bit)

pub fn get_alpha_border(&self, threshold: f32) -> Rectangle

Get image alpha border rectangle

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

Get image pixel color at (x, y) position

pub fn clear_background(&mut self, color: Color)

Clear image background with given color

pub fn draw_pixel(&mut self, pos: Vector2, color: Color)

Draw pixel within an image

pub fn draw_line(&mut self, start: Vector2, end: Vector2, color: Color)

Draw line within an image

pub fn draw_circle(&mut self, center: Vector2, radius: u32, color: Color)

Draw a filled circle within an image

pub fn draw_circle_lines_v( &mut self, center: Vector2, radius: u32, color: Color, )

Draw circle outline within an image

pub fn draw_rectangle(&mut self, rect: Rectangle, color: Color)

Draw rectangle within an image

pub fn draw_rectangle_lines( &mut self, rect: Rectangle, thickness: u32, color: Color, )

Draw rectangle lines within an image

pub fn draw_image( &mut self, source: &Image, source_rect: Rectangle, dest_rect: Rectangle, tint: Color, )

Draw a source image within a destination image (tint applied to source)

pub fn draw_text( &mut self, text: &str, position: Vector2, font_size: u32, color: Color, )

Draw text (using default font) within an image (destination)

pub fn draw_text_with_font( &mut self, text: &str, pos: Vector2, font: &Font, font_size: f32, spacing: f32, tint: Color, )

Draw text (custom sprite font) within an image (destination)

pub fn get_pixel_data_size(&self) -> usize

Get pixel data size in bytes for this image

pub fn rectangle(&self) -> Rectangle

Returns a rectangle with x = 0, y = 0; width and height correspond to image’s dimensions

pub fn as_raw(&self) -> &Image

Get the ‘raw’ ffi type Take caution when cloning so it doesn’t outlive the original

pub fn as_raw_mut(&mut self) -> &mut Image

Get the ‘raw’ ffi type Take caution when cloning so it doesn’t outlive the original

pub unsafe fn from_raw(raw: Image) -> Self

Convert a ‘raw’ ffi object to a safe wrapper

Safety

• The raw object must be correctly initialized
• The raw object should be unique. Otherwise, make sure its clones don’t outlive the newly created object.

Trait Implementations

impl Clone for Image

fn clone(&self) -> Self

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 Drop for Image

fn drop(&mut self)

Executes the destructor for this type.