1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
//! [Image] and [`PixelFormat`] functions.
use crate::{ops::clamp_dimensions, prelude::*, renderer::Rendering};
#[cfg(not(target_arch = "wasm32"))]
use anyhow::Context;
#[cfg(not(target_arch = "wasm32"))]
use png::{BitDepth, ColorType, Decoder};
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};
#[cfg(not(target_arch = "wasm32"))]
use std::{
ffi::OsStr,
fs::File,
io::{self, BufReader, BufWriter},
path::{Path, PathBuf},
};
use std::{fmt, iter::Copied, slice};
/// Format for interpreting image data.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
#[non_exhaustive]
#[must_use]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum PixelFormat {
/// 8-bit Red, Green, and Blue
Rgb,
/// 8-bit Red, Green, Blue, and Alpha
Rgba,
}
impl PixelFormat {
/// Returns the number of channels associated with the format.
#[inline]
#[must_use]
pub const fn channels(&self) -> usize {
match self {
PixelFormat::Rgb => 3,
PixelFormat::Rgba => 4,
}
}
}
/// The error type returned when a checked conversion from [png::ColorType] fails.
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[doc(hidden)]
pub struct TryFromColorTypeError(pub(crate) ());
#[doc(hidden)]
impl TryFrom<png::ColorType> for PixelFormat {
type Error = TryFromColorTypeError;
fn try_from(color_type: png::ColorType) -> std::result::Result<Self, Self::Error> {
match color_type {
png::ColorType::Rgb => Ok(Self::Rgb),
png::ColorType::Rgba => Ok(Self::Rgba),
_ => Err(TryFromColorTypeError(())),
}
}
}
#[doc(hidden)]
impl From<PixelFormat> for png::ColorType {
fn from(format: PixelFormat) -> Self {
match format {
PixelFormat::Rgb => Self::Rgb,
PixelFormat::Rgba => Self::Rgba,
}
}
}
impl Default for PixelFormat {
fn default() -> Self {
Self::Rgba
}
}
/// An `Image` representing a buffer of pixel color values.
#[derive(Default, Clone)]
#[must_use]
pub struct Image {
/// `Image` width.
width: u32,
/// `Image` height.
height: u32,
/// Raw pixel data.
data: Vec<u8>,
/// Pixel Format.
format: PixelFormat,
}
impl Image {
/// Constructs an empty RGBA `Image` with given `width` and `height`.
#[inline]
pub fn new(width: u32, height: u32) -> Self {
Self::rgba(width, height)
}
/// Constructs an empty RGBA `Image` with given `width` and `height`.
///
/// Alias for [Image::new].
#[doc(alias = "new")]
#[inline]
pub fn rgba(width: u32, height: u32) -> Self {
let format = PixelFormat::Rgba;
let data = vec![0x00; format.channels() * (width * height) as usize];
Self::from_vec(width, height, data, format)
}
/// Constructs an empty RGB `Image` with given `width` and `height`.
#[inline]
pub fn rgb(width: u32, height: u32) -> Self {
let format = PixelFormat::Rgb;
let data = vec![0x00; format.channels() * (width * height) as usize];
Self::from_vec(width, height, data, format)
}
/// Constructs an `Image` from a [u8] [prim@slice] representing RGB/A values.
///
/// # Errors
///
/// If the bytes length doesn't match the image dimensions and [`PixelFormat`] provided, then
/// an error is returned.
#[inline]
pub fn from_bytes<B: AsRef<[u8]>>(
width: u32,
height: u32,
bytes: B,
format: PixelFormat,
) -> PixResult<Self> {
let bytes = bytes.as_ref();
if bytes.len() != (format.channels() * width as usize * height as usize) {
return Err(PixError::InvalidImage {
width,
height,
size: bytes.len(),
format,
}
.into());
}
Ok(Self::from_vec(width, height, bytes.to_vec(), format))
}
/// Constructs an `Image` from a [Color] [prim@slice] representing RGBA values.
///
/// # Errors
///
/// If the pixels length doesn't match the image dimensions and [`PixelFormat`] provided, then
/// an error is returned.
#[inline]
pub fn from_pixels<P: AsRef<[Color]>>(
width: u32,
height: u32,
pixels: P,
format: PixelFormat,
) -> PixResult<Self> {
let pixels = pixels.as_ref();
if pixels.len() != (width as usize * height as usize) {
return Err(PixError::InvalidImage {
width,
height,
size: pixels.len() * format.channels(),
format,
}
.into());
}
let bytes: Vec<u8> = match format {
PixelFormat::Rgb => pixels
.iter()
.flat_map(|p| [p.red(), p.green(), p.blue()])
.collect(),
PixelFormat::Rgba => pixels.iter().flat_map(Color::channels).collect(),
};
Ok(Self::from_vec(width, height, bytes, format))
}
/// Constructs an `Image` from a [`Vec<u8>`] representing RGB/A values.
#[inline]
pub fn from_vec(width: u32, height: u32, data: Vec<u8>, format: PixelFormat) -> Self {
Self {
width,
height,
data,
format,
}
}
/// Constructs an `Image` from a [png] file.
///
/// # Errors
///
/// If the file format is not supported or extension is not `.png`, then an error is returned.
#[cfg(not(target_arch = "wasm32"))]
pub fn from_file<P: AsRef<Path>>(path: P) -> PixResult<Self> {
let path = path.as_ref();
let ext = path.extension();
if ext != Some(OsStr::new("png")) {
return Err(PixError::UnsupportedFileType(ext.map(OsStr::to_os_string)).into());
}
Self::from_read(File::open(path)?)
}
/// Constructs an `Image` from a [png] reader.
///
/// # Errors
///
/// If the file format is not supported or there is an [`io::Error`] reading the file then an
/// error is returned.
#[cfg(not(target_arch = "wasm32"))]
pub fn from_read<R: io::Read>(read: R) -> PixResult<Self> {
let png_file = BufReader::new(read);
let png = Decoder::new(png_file);
// TODO: Make this machine-dependent to best match display capabilities for performance
// EXPL: Switch RGBA32 (RGBA8888) format to ARGB8888 by swapping alpha
// EXPL: Expand paletted to RGB and non-8-bit grayscale to 8-bits
// png.set_transformations(Transformations::SWAP_ALPHA | Transformations::EXPAND);
let mut reader = png.read_info().context("failed to read png data")?;
let mut buf = vec![0x00; reader.output_buffer_size()];
let info = reader
.next_frame(&mut buf)
.context("failed to read png data frame")?;
let bit_depth = info.bit_depth;
let color_type = info.color_type;
if bit_depth != BitDepth::Eight || !matches!(color_type, ColorType::Rgb | ColorType::Rgba) {
return Err(PixError::UnsupportedImageFormat {
bit_depth,
color_type,
}
.into());
}
let data = &buf[..info.buffer_size()];
let format = info
.color_type
.try_into()
.map_err(|_| PixError::UnsupportedImageFormat {
bit_depth,
color_type,
})?;
Self::from_bytes(info.width, info.height, data, format)
}
/// Returns the `Image` width.
#[inline]
#[must_use]
pub const fn width(&self) -> u32 {
self.width
}
/// Returns the `Image` height.
#[inline]
#[must_use]
pub const fn height(&self) -> u32 {
self.height
}
/// Returns the `Image` dimensions as `(width, height)`.
#[inline]
#[must_use]
pub const fn dimensions(&self) -> (u32, u32) {
(self.width, self.height)
}
/// Returns the `pitch` of the image data which is the number of bytes in a row of pixel data,
/// including padding between lines.
#[inline]
#[must_use]
pub const fn pitch(&self) -> usize {
self.width() as usize * self.format.channels()
}
/// Returns the `Image` bounding [Rect] positioned at `(0, 0)`.
///
/// The width and height of the returned rectangle are clamped to ensure that size does not
/// exceed [`i32::MAX`]. This could result in unexpected behavior with drawing routines if the
/// image size is larger than this.
#[inline]
pub fn bounding_rect(&self) -> Rect<i32> {
let (width, height) = clamp_dimensions(self.width, self.height);
rect![0, 0, width, height]
}
/// Returns the `Image` bounding [Rect] positioned at `offset`.
#[inline]
pub fn bounding_rect_offset<P>(&self, offset: P) -> Rect<i32>
where
P: Into<Point<i32>>,
{
let (width, height) = clamp_dimensions(self.width, self.height);
rect![offset.into(), width, height]
}
/// Returns the center position as [Point].
#[inline]
pub fn center(&self) -> Point<i32> {
let (width, height) = clamp_dimensions(self.width, self.height);
point!(width / 2, height / 2)
}
/// Returns the `Image` pixel data as an iterator of [u8].
#[inline]
pub fn bytes(&self) -> Bytes<'_> {
Bytes(self.as_bytes().iter().copied())
}
/// Returns the `Image` pixel data as a [u8] [prim@slice].
#[inline]
#[must_use]
pub fn as_bytes(&self) -> &[u8] {
&self.data
}
/// Returns the `Image` pixel data as a mutable [u8] [prim@slice].
#[inline]
#[must_use]
pub fn as_mut_bytes(&mut self) -> &mut [u8] {
&mut self.data
}
/// Returns the `Image` pixel data as a [`Vec<u8>`].
///
/// This consumes the `Image`, so we do not need to copy its contents.
#[inline]
#[must_use]
// FIXME: https://github.com/rust-lang/rust-clippy/issues/4979
#[allow(clippy::missing_const_for_fn)]
pub fn into_bytes(self) -> Vec<u8> {
self.data
}
/// Returns the `Image` pixel data as an iterator of [Color]s.
#[inline]
pub fn pixels(&self) -> Pixels<'_> {
Pixels(self.format.channels(), self.as_bytes().iter().copied())
}
/// Returns the `Image` pixel data as a [`Vec<Color>`].
///
/// # Panics
///
/// Panics if the image has an invalid sequence of bytes given it's [`PixelFormat`].
#[inline]
#[must_use]
pub fn into_pixels(self) -> Vec<Color> {
self.data
.chunks(self.format.channels())
.map(|slice| match *slice {
[red, green, blue] => Color::rgb(red, green, blue),
[red, green, blue, alpha] => Color::rgba(red, green, blue, alpha),
_ => Color::TRANSPARENT,
})
.collect()
}
/// Returns the color value at the given `(x, y)` position.
///
/// # Panics
///
/// Panics if the image has an invalid sequence of bytes given it's [`PixelFormat`], or the `(x,
/// y`) index is out of range.
#[inline]
pub fn get_pixel(&self, x: u32, y: u32) -> Color {
let idx = self.idx(x, y);
let channels = self.format.channels();
match self.data.get(idx..idx + channels) {
Some([red, green, blue]) => Color::rgb(*red, *green, *blue),
Some([red, green, blue, alpha]) => Color::rgba(*red, *green, *blue, *alpha),
_ => Color::TRANSPARENT,
}
}
/// Sets the color value at the given `(x, y)` position.
#[inline]
pub fn set_pixel<C: Into<Color>>(&mut self, x: u32, y: u32, color: C) {
let color = color.into();
let idx = self.idx(x, y);
let channels = self.format.channels();
self.data[idx..(idx + channels)].clone_from_slice(&color.channels()[..channels]);
}
/// Update the `Image` with a [u8] [prim@slice] representing RGB/A values.
#[inline]
pub fn update_bytes<B: AsRef<[u8]>>(&mut self, bytes: B) {
self.data.clone_from_slice(bytes.as_ref());
}
/// Returns the `Image` pixel format.
#[inline]
pub const fn format(&self) -> PixelFormat {
self.format
}
/// Save the `Image` to a [png] file.
///
/// # Errors
///
/// Returns an error for any of the following:
/// - An [`io::Error`] occurs attempting to create the [png] file.
/// - A [`png::EncodingError`] occurs attempting to write image bytes.
///
/// # Example
///
/// ```
/// # use pix_engine::prelude::*;
/// # struct App { image: Image };
/// # impl PixEngine for App {
/// # fn on_update(&mut self, s: &mut PixState) -> PixResult<()> { Ok(()) }
/// fn on_key_pressed(&mut self, s: &mut PixState, event: KeyEvent) -> PixResult<bool> {
/// if let Key::S = event.key {
/// self.image.save("test_image.png")?;
/// }
/// Ok(false)
/// }
/// # }
/// ```
#[cfg(not(target_arch = "wasm32"))]
pub fn save<P>(&self, path: P) -> PixResult<()>
where
P: AsRef<Path>,
{
let path = path.as_ref();
let png_file = BufWriter::new(File::create(path)?);
let mut png = png::Encoder::new(png_file, self.width, self.height);
png.set_color(self.format.into());
png.set_depth(png::BitDepth::Eight);
let mut writer = png
.write_header()
.with_context(|| format!("failed to write png header: {path:?}"))?;
writer
.write_image_data(self.as_bytes())
.with_context(|| format!("failed to write png data: {path:?}"))
}
}
impl Image {
/// Helper function to get the byte array index based on `(x, y)`.
#[inline]
const fn idx(&self, x: u32, y: u32) -> usize {
self.format.channels() * (x + y * self.width) as usize
}
}
impl PixState {
/// Draw an [Image] to the current canvas.
///
/// # Errors
///
/// If the renderer fails to draw to the current render target, then an error is returned.
///
/// # Example
///
/// ```
/// # use pix_engine::prelude::*;
/// # struct App { text_field: String, text_area: String};
/// # impl PixEngine for App {
/// fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
/// let image = Image::from_file("./some_image.png")?;
/// s.image(&image, [10, 10])?;
/// Ok(())
/// }
/// # }
/// ```
pub fn image<P>(&mut self, img: &Image, position: P) -> PixResult<()>
where
P: Into<Point<i32>>,
{
let pos = position.into();
let dst = img.bounding_rect_offset(pos);
self.image_transformed(img, None, dst, 0.0, None, None)
}
/// Draw a transformed [Image] to the current canvas resized to the target `rect`, optionally
/// rotated by an `angle` about the `center` point or `flipped`. `angle` can be in either
/// radians or degrees based on [`AngleMode`]. [`PixState::image_tint`] can optionally add a tint
/// color to the rendered image.
///
/// # Errors
///
/// If the renderer fails to draw to the current render target, then an error is returned.
///
/// # Example
///
/// ```
/// # use pix_engine::prelude::*;
/// # struct App { text_field: String, text_area: String};
/// # impl PixEngine for App {
/// fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
/// s.angle_mode(AngleMode::Degrees);
/// let image = Image::from_file("./some_image.png")?;
/// let src = None; // Draw entire image instead of a sub-image
/// let dst = image.bounding_rect_offset([10, 10]); // Draw image at `(10, 10)`.
/// let angle = 10.0;
/// let center = point!(10, 10);
/// s.image_transformed(&image, src, dst, angle, center, Flipped::Horizontal)?;
/// Ok(())
/// }
/// # }
/// ```
pub fn image_transformed<R1, R2, A, C, F>(
&mut self,
img: &Image,
src: R1,
dst: R2,
angle: A,
center: C,
flipped: F,
) -> PixResult<()>
where
R1: Into<Option<Rect<i32>>>,
R2: Into<Option<Rect<i32>>>,
A: Into<Option<f64>>,
C: Into<Option<Point<i32>>>,
F: Into<Option<Flipped>>,
{
let s = &self.settings;
let mut dst = dst.into();
if s.image_mode == ImageMode::Center {
dst = dst.map(|dst| Rect::from_center(dst.top_left(), dst.width(), dst.height()));
};
let mut angle = angle.into().unwrap_or(0.0);
if s.angle_mode == AngleMode::Radians {
angle = angle.to_degrees();
};
self.renderer.image(
img,
src.into(),
dst,
angle,
center.into(),
flipped.into(),
s.image_tint,
)
}
}
impl fmt::Debug for Image {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("Image")
.field("width", &self.width)
.field("height", &self.height)
.field("size", &self.data.len())
.field("format", &self.format)
.finish()
}
}
/// An iterator over the bytes of an [Image].
///
/// This struct is created by the [`Image::bytes`] method.
/// See its documentation for more.
#[derive(Debug, Clone)]
#[must_use]
pub struct Bytes<'a>(Copied<slice::Iter<'a, u8>>);
impl Iterator for Bytes<'_> {
type Item = u8;
#[inline]
fn next(&mut self) -> Option<Self::Item> {
self.0.next()
}
}
/// An iterator over the [Color] pixels of an [Image].
///
/// This struct is created by the [`Image::pixels`] method.
/// See its documentation for more.
#[derive(Debug, Clone)]
#[must_use]
pub struct Pixels<'a>(usize, Copied<slice::Iter<'a, u8>>);
impl Iterator for Pixels<'_> {
type Item = Color;
#[inline]
fn next(&mut self) -> Option<Self::Item> {
let r = self.1.next()?;
let g = self.1.next()?;
let b = self.1.next()?;
let channels = self.0;
match channels {
3 => Some(Color::rgb(r, g, b)),
4 => {
let a = self.1.next()?;
Some(Color::rgba(r, g, b, a))
}
_ => Some(Color::TRANSPARENT),
}
}
}
/// Represents an image icon source.
#[derive(Debug, Clone)]
pub enum Icon {
/// An icon image.
Image(Image),
#[cfg(not(target_arch = "wasm32"))]
/// A path to an icon image.
Path(PathBuf),
}
#[cfg(not(target_arch = "wasm32"))]
impl<T: Into<PathBuf>> From<T> for Icon {
fn from(value: T) -> Self {
Self::Path(value.into())
}
}
impl From<Image> for Icon {
fn from(img: Image) -> Self {
Self::Image(img)
}
}