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
//! Rust Graphics Lib
//!
//! This is a simple wrapper around [`Pixels`](https://github.com/parasyte/pixels), it provides basic shape, image and text rendering.
//!
//! This boilerplate code is needed to use it:
//!
//! ```
//! # use std::error::Error;
//! # use winit::event::{Event, VirtualKeyCode};
//! # use pixels_graphics_lib::{WindowScaling, setup};
//! # use winit_input_helper::WinitInputHelper;
//! # use winit::event_loop::{ControlFlow, EventLoop};
//!
//! # fn main() -> Result<(), Box<dyn Error>> {
//! let event_loop = EventLoop::new();
//! let mut input = WinitInputHelper::new();
//! let (mut window, mut graphics) = setup((240, 160), WindowScaling::Auto, "Doc Example", &event_loop)?;
//!
//! # let mut loop_count = 0;
//!
//! event_loop.run(move |event, _, control_flow| {
//! if let Event::RedrawRequested(_) = event {
//! if graphics.pixels
//! .render()
//! .map_err(|e| eprintln ! ("pixels.render() failed: {:?}", e))
//! .is_err()
//! {
//! *control_flow = ControlFlow::Exit;
//! return;
//! }
//! }
//!
//! //put your rendering code here
//!
//! if input.update(&event) {
//! if input.key_pressed(VirtualKeyCode::Escape) || input.quit() {
//! *control_flow = ControlFlow::Exit;
//! return;
//! }
//!
//! if let Some(size) = input.window_resized() {
//! graphics.pixels.resize_surface(size.width, size.height);
//! }
//!
//! //put your update/input handling code here
//!
//! window.request_redraw();
//! }
//! # loop_count += 1;
//! # if loop_count > 3 {
//! # *control_flow = ControlFlow::Exit;
//! # }
//! });
//!
//! # Ok(())
//! # }
//!```
//!
//! Using the library is as simple as:
//!```
//! # use std::error::Error;
//! # use pixels_graphics_lib::drawing::PixelWrapper;
//! # use pixels_graphics_lib::{WindowScaling, setup};
//! # use pixels_graphics_lib::color::{BLUE, BLACK};
//! # use winit::event_loop::EventLoop;
//! # use pixels_graphics_lib::text::TextSize;
//! # fn main() -> Result<(), Box<dyn Error>> {
//! # let event_loop = EventLoop::new();
//! # let (window, mut graphics) = setup((240, 160), WindowScaling::Auto, "Example", &event_loop)?;
//! graphics.draw_text("Some text", 9, 1, 1, TextSize::Normal, BLACK);
//! graphics.draw_line(30, 30, 100, 120, BLUE);
//! # Ok(()) }
//! ```
#![deny(clippy::all)]
pub mod color;
pub mod drawing;
pub mod image;
pub mod math;
pub mod scaling;
pub mod text;
#[cfg(feature = "image_loading")]
pub mod image_loading;
#[cfg(feature = "window_prefs")]
pub mod prefs;
use crate::drawing::PixelWrapper;
use pixels::{Pixels, SurfaceTexture};
use thiserror::Error;
use winit::dpi::LogicalSize;
use winit::event_loop::EventLoop;
use winit::window::{Window, WindowBuilder};
#[derive(Error, Debug)]
pub enum GraphicsError {
#[error("Creating a window: {0}")]
WindowInit(String),
#[error("Initialising Pixels: {0}")]
PixelsInit(#[source] pixels::Error),
#[error("Saving window pref: {0}")]
SavingWindowPref(String),
#[error("Loading window pref: {0}")]
LoadingWindowPref(String),
#[error("Invalid pixel array length, expected: {0}, found: {1}")]
ImageInitSize(usize, usize),
#[error("Both images must be the same size, expected: {0}x{1}, found: {2}x{3}")]
ImageBlendSize(usize, usize, usize, usize),
}
/// Creates the window and pixels wrapper
///
/// The inner size mentioned in the arguments refers to the size of the area available to draw in, it doesn't include the window frame, etc
///
/// This uses logical pixels, where on a low DPI screen each library pixel is one display pixel but on higher DPI screens (and if
/// `scale` != `None`) then a library pixel will be represented by multiple display pixels
///
/// # Arguments
///
/// * `canvas_size` - Inner width and height of window in logical pixels
/// * `scale` - Type of scaling the window should use, see [WindowScaling]
/// * `title` - Title for window
/// * `event_loop` - Provided by `EventLoop::new()`, this allows the window to receive events from the OS
///
/// # Example
///
/// This creates a 160x160 window:
///
/// `let (mut window, graphics) = setup(160, 160, "Example", true, &event_loop)?;`
///
/// # Returns
///
/// A result with a pair of Window and PixelsWrapper
///
/// # Errors
///
/// * `WindowInit` - If the window can not be created
pub fn setup(
canvas_size: (usize, usize),
window_scaling: WindowScaling,
title: &str,
event_loop: &EventLoop<()>,
) -> Result<(Window, PixelWrapper), GraphicsError> {
let win = create_window(canvas_size, title, window_scaling, event_loop)?;
let surface = SurfaceTexture::new(win.inner_size().width, win.inner_size().height, &win);
let pixels = Pixels::new(canvas_size.0 as u32, canvas_size.1 as u32, surface).map_err(GraphicsError::PixelsInit)?;
Ok((
win,
PixelWrapper::new(pixels, canvas_size.0, canvas_size.1),
))
}
pub enum WindowScaling {
/// Make the canvas and window be the same of numbers, this ignores DPI
None,
/// Scale the window to account for DPI
Auto,
/// Scale the window by a fixed amount, ignoring DPI
Fixed(usize),
/// Scale the window by a fixed amount and by DPI
/// So, if the monitor DPI is 2x and 2x is passed then the result will be 4x
AutoFixed(usize),
}
fn create_window(
size: (usize, usize),
title: &str,
scale: WindowScaling,
event_loop: &EventLoop<()>,
) -> Result<Window, GraphicsError> {
let window = WindowBuilder::new()
.with_visible(false)
.with_title(title)
.build(event_loop)
.map_err(|err| GraphicsError::WindowInit(format!("{:?}", err)))?;
let factor = match scale {
WindowScaling::None => 1.,
WindowScaling::Auto => window.scale_factor().ceil(),
WindowScaling::Fixed(amount) => {
if amount == 0 {
return Err(GraphicsError::WindowInit(String::from("Fixed window scaling must be at least 1")));
}
amount as f64
},
WindowScaling::AutoFixed(amount) => {
if amount == 0 {
return Err(GraphicsError::WindowInit(String::from("AutoFixed window scaling must be at least 1")));
}
amount as f64 + window.scale_factor().ceil()
}
};
let px_size = LogicalSize::new(size.0 as f64 * factor, size.1 as f64 * factor);
window.set_inner_size(px_size);
window.set_min_inner_size(Some(px_size));
window.set_visible(true);
Ok(window)
}
pub trait Tint {
/// Add to the RGBA channels by the amounts specified
///
/// Channels are clamped to 0..=255
fn tint_add(&mut self, r_diff: isize, g_diff: isize, b_diff: isize, a_diff: isize);
/// Multiple the RGBA channels by the amounts specified
///
/// Channels are clamped to 0..=255
fn tint_mul(&mut self, r_diff: f32, g_diff: f32, b_diff: f32, a_diff: f32);
}