Struct tetra::graphics::ImageData [−][src]
pub struct ImageData { /* fields omitted */ }
Expand description
Raw image data.
Supported Formats
Various file formats are supported, and can be enabled or disabled via Cargo features:
Format | Cargo feature | Enabled by default? |
---|---|---|
PNG | texture_png | Yes |
JPEG | texture_jpeg | Yes |
GIF | texture_gif | Yes |
BMP | texture_bmp | Yes |
TIFF | texture_tiff | No |
TGA | texture_tga | No |
WebP | texture_webp | No |
ICO | texture_ico | No |
PNM | texture_pnm | No |
DDS/DXT | texture_dds | No |
Performance
Creating or cloning an ImageData
is a relatively expensive operation. If you can, store them in your
State
struct rather than recreating them each frame.
Implementations
impl ImageData
[src]
impl ImageData
[src]pub fn from_file<P>(path: P) -> Result<ImageData> where
P: AsRef<Path>,
[src]
pub fn from_file<P>(path: P) -> Result<ImageData> where
P: AsRef<Path>,
[src]Loads image data from the given file.
The format will be determined based on the file extension.
Errors
TetraError::FailedToLoadAsset
will be returned if the file could not be loaded.TetraError::InvalidTexture
will be returned if the image data was invalid.
pub fn from_file_data(data: &[u8]) -> Result<ImageData>
[src]
pub fn from_file_data(data: &[u8]) -> Result<ImageData>
[src]Decodes image data that is encoded in one of Tetra’s supported file formats (except for TGA).
This is useful in combination with include_bytes
, as it
allows you to include your image data directly in the binary.
The format will be determined based on the ‘magic bytes’ at the beginning of the data. Note that TGA files do not have recognizable magic bytes, so this function will not recognize them.
Errors
TetraError::InvalidTexture
will be returned if the image data was invalid.
pub fn from_rgba8<D>(width: i32, height: i32, data: D) -> Result<ImageData> where
D: Into<Vec<u8>>,
[src]
pub fn from_rgba8<D>(width: i32, height: i32, data: D) -> Result<ImageData> where
D: Into<Vec<u8>>,
[src]Creates an ImageData
from raw RGBA8 data.
This function takes Into<Vec<u8>>
. If you pass a Vec<u8>
, that Vec
will
be reused for the created ImageData
without reallocating. Otherwise, the data
will be copied.
This function requires you to provide enough data to fill the image’s bounds. If you provide too little data, an error will be returned. If you provide too much data, it will be truncated.
Errors
TetraError::NotEnoughData
will be returned if not enough data is provided to fill the image.
pub fn from_rgba<D>(width: i32, height: i32, data: D) -> Result<ImageData> where
D: Into<Vec<u8>>,
[src]
D: Into<Vec<u8>>,
renamed to from_rgba8 for consistency
pub fn into_bytes(self) -> Vec<u8>
[src]
pub fn into_bytes(self) -> Vec<u8>
[src]Returns the image’s underlying buffer.
pub fn region(&self, region: Rectangle<i32>) -> ImageData
[src]
pub fn region(&self, region: Rectangle<i32>) -> ImageData
[src]Creates a new ImageData
from a region.
This will copy the data into a new buffer - as such, calling this function can be expensive!
pub fn to_texture(&self, ctx: &mut Context) -> Result<Texture>
[src]
pub fn to_texture(&self, ctx: &mut Context) -> Result<Texture>
[src]Creates a new Texture
from the stored data.
Errors
TetraError::PlatformError
will be returned if the underlying graphics API encounters an error.
pub fn get_pixel_color(&self, position: Vec2<i32>) -> Color
[src]
pub fn get_pixel_color(&self, position: Vec2<i32>) -> Color
[src]Gets the color of the pixel at the specified location.
Panics
Panics if the location is outside the bounds of the image.
pub fn set_pixel_color(&mut self, position: Vec2<i32>, color: Color)
[src]
pub fn set_pixel_color(&mut self, position: Vec2<i32>, color: Color)
[src]Sets the color of the pixel at the specified location.
Panics
Panics if the location is outside the bounds of the image.
pub fn transform<F>(&mut self, func: F) where
F: FnMut(Vec2<i32>, Color) -> Color,
[src]
pub fn transform<F>(&mut self, func: F) where
F: FnMut(Vec2<i32>, Color) -> Color,
[src]Transforms the image data by applying a function to each pixel.
pub fn premultiply(&mut self)
[src]
pub fn premultiply(&mut self)
[src]Multiplies the RGB components of each pixel by the alpha component.
This can be useful when working with premultiplied alpha blending.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for ImageData
impl Send for ImageData
impl Sync for ImageData
impl Unpin for ImageData
impl UnwindSafe for ImageData
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more