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
//! [`PixState`] methods for the [`Engine`] and [`PixEngine`].
//!
//! `PixState` is the global engine state and API for any application using `pix-engine`. A mutable
//! reference is passed to most [`PixEngine`] methods and allows you to modify settings, query engine
//! and input state, as well as drawing to the current render target.
//!
//! The most common use of `PixState` is in the [`PixEngine::on_update`] method.
//!
//! See the [Getting Started](crate#getting-started) section and the [`PixState`] page for the list
//! of available methods.
//!
//! Provided [`PixState`] methods:
//!
//! - [`PixState::title`]: Current window title.
//! - [`PixState::set_title`]: Set new window title.
//! - [`PixState::mouse_pos`]: [Mouse] position this frame.
//! - [`PixState::pmouse_pos`]: [Mouse] position previous frame.
//! - [`PixState::mouse_pressed`]: Whether any [Mouse] button was pressed this frame.
//! - [`PixState::mouse_clicked`]: Whether a given [Mouse] button was clicked this frame.
//! - [`PixState::mouse_down`]: Whether a given [Mouse] button was pressed this frame.
//! - [`PixState::mouse_buttons`]: A [`HashSet`] of [Mouse] buttons pressed this frame.
//! - [`PixState::key_pressed`]: Whether a given [Key] was pressed this frame.
//! - [`PixState::key_down`]: Whether a given [Key] was pressed this frame.
//! - [`PixState::keys`]: Whether any [Key] was pressed this frame.
//! - [`PixState::keymod_down`]: Whether a given [key modifier][`KeyMod`] was pressed this frame.
//! - [`PixState::keymod`]: The [`KeyMod`]s pressed this frame.
//!
//! # Example
//!
//! ```
//! # use pix_engine::prelude::*;
//! # struct App { checkbox: bool, text_field: String };
//! # impl PixEngine for App {
//! fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
//! s.fill(s.theme().colors.primary);
//! s.rect([100, 0, 100, 100])?;
//! if s.button("Click me")? {
//! s.text("I was clicked!");
//! }
//! Ok(())
//! }
//! # }
//! ```
use crate::{
gui::state::UiState,
prelude::*,
renderer::{Renderer, RendererSettings, Rendering, WindowRenderer},
texture::TextureRenderer,
};
use environment::Environment;
use settings::Settings;
use std::{collections::HashSet, mem, time::Instant};
pub mod environment;
pub mod settings;
/// Represents all state and methods for updating and interacting with the [`Engine`].
#[non_exhaustive]
#[derive(Debug)]
pub struct PixState {
pub(crate) renderer: Renderer,
pub(crate) env: Environment,
pub(crate) ui: UiState,
pub(crate) settings: Settings,
pub(crate) setting_stack: Vec<Settings>,
pub(crate) theme: Theme,
}
impl PixState {
/// Get the current window title.
///
/// # Example
///
/// ```
/// # use pix_engine::prelude::*;
/// # struct App;
/// # impl PixEngine for App {
/// fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
/// s.text(format!("Window title: {}", s.title()))?;
/// Ok(())
/// }
/// # }
/// ```
#[inline]
#[must_use]
pub fn title(&self) -> &str {
self.renderer.title()
}
/// Set the current window title.
///
/// # Errors
///
/// If the current window target is closed or invalid or the string contains a `nul` byte, then
/// an error is returned.
///
/// # Example
///
/// ```
/// # use pix_engine::prelude::*;
/// # struct App;
/// # impl PixEngine for App {
/// fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
/// if s.button("Change title")? {
/// s.set_title("Title changed!")?;
/// }
/// Ok(())
/// }
/// # }
/// ```
#[inline]
pub fn set_title<S: AsRef<str>>(&mut self, title: S) -> PixResult<()> {
self.renderer.set_title(title.as_ref())
}
/// Returns the current mouse position coordinates this frame as `(x, y)`.
///
/// # Example
///
/// ```
/// # use pix_engine::prelude::*;
/// # struct App;
/// # impl PixEngine for App {
/// fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
/// // Draw 100x100 rectangle that follows the mouse
/// s.rect(rect![s.mouse_pos(), 100, 100])?;
/// Ok(())
/// }
/// # }
/// ```
#[inline]
pub fn mouse_pos(&self) -> Point<i32> {
self.ui.mouse_pos()
}
/// Returns the previous mouse position coordinates last frame as `(x, y)`.
///
/// # Example
///
/// ```
/// # use pix_engine::prelude::*;
/// # struct App;
/// # impl PixEngine for App {
/// fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
/// // Draw 100x100 rectangle that follows the mouse last frame
/// // Creates a yoyo-like effect
/// s.rect(rect![s.pmouse_pos(), 100, 100])?;
/// Ok(())
/// }
/// # }
/// ```
#[inline]
pub fn pmouse_pos(&self) -> Point<i32> {
self.ui.pmouse_pos()
}
/// Returns if any [Mouse] button was pressed this frame.
///
/// # Example
///
/// ```
/// # use pix_engine::prelude::*;
/// # struct App;
/// # impl PixEngine for App {
/// fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
/// if s.mouse_pressed() {
/// s.background(Color::random());
/// }
/// Ok(())
/// }
/// # }
/// ```
#[inline]
#[must_use]
pub fn mouse_pressed(&self) -> bool {
self.ui.mouse_pressed()
}
/// Returns if the [Mouse] was clicked (pressed and released) this frame.
///
/// # Example
///
/// ```
/// # use pix_engine::prelude::*;
/// # struct App;
/// # impl PixEngine for App {
/// fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
/// if s.mouse_clicked(Mouse::Left) {
/// s.background(Color::random());
/// }
/// Ok(())
/// }
/// # }
/// ```
#[inline]
#[must_use]
pub fn mouse_clicked(&self, btn: Mouse) -> bool {
self.ui.mouse_clicked(btn)
}
/// Returns if the [Mouse] was double clicked (pressed and released) this frame.
///
/// # Example
///
/// ```
/// # use pix_engine::prelude::*;
/// # struct App;
/// # impl PixEngine for App {
/// fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
/// if s.mouse_dbl_clicked(Mouse::Left) {
/// s.background(Color::random());
/// }
/// Ok(())
/// }
/// # }
/// ```
#[inline]
#[must_use]
pub fn mouse_dbl_clicked(&self, btn: Mouse) -> bool {
self.ui.mouse_dbl_clicked(btn)
}
/// Returns if a specific [Mouse] button was pressed this frame.
///
/// # Example
///
/// ```
/// # use pix_engine::prelude::*;
/// # struct App;
/// # impl PixEngine for App {
/// fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
/// if s.mouse_down(Mouse::Left) {
/// s.background(Color::random());
/// }
/// Ok(())
/// }
/// # }
/// ```
#[inline]
#[must_use]
pub fn mouse_down(&self, btn: Mouse) -> bool {
self.ui.mouse_down(btn)
}
/// Returns a list of the current mouse buttons pressed this frame.
///
/// # Example
///
/// ```
/// # use pix_engine::prelude::*;
/// # struct App;
/// # impl PixEngine for App {
/// fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
/// // Only trigger if both buttons are pressed
/// if s.mouse_buttons().contains(&Mouse::Left)
/// && s.mouse_buttons().contains(&Mouse::Right)
/// {
/// s.background(Color::random());
/// }
/// Ok(())
/// }
/// # }
/// ```
#[inline]
#[must_use]
pub const fn mouse_buttons(&self) -> &HashSet<Mouse> {
self.ui.mouse_buttons()
}
/// Returns if any [Key] was pressed this frame.
///
/// # Example
///
/// ```
/// # use pix_engine::prelude::*;
/// # struct App;
/// # impl PixEngine for App {
/// fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
/// if s.key_pressed() {
/// s.background(Color::random());
/// }
/// Ok(())
/// }
/// # }
/// ```
#[inline]
#[must_use]
pub fn key_pressed(&self) -> bool {
self.ui.key_pressed()
}
/// Returns if a specific [Key] was pressed this frame.
///
/// # Example
///
/// ```
/// # use pix_engine::prelude::*;
/// # struct App;
/// # impl PixEngine for App {
/// fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
/// if s.key_down(Key::Space) {
/// s.background(Color::random());
/// }
/// Ok(())
/// }
/// # }
/// ```
#[inline]
#[must_use]
pub fn key_down(&self, key: Key) -> bool {
self.ui.key_down(key)
}
/// Returns a list of the current keys pressed this frame.
///
/// # Example
///
/// ```
/// # use pix_engine::prelude::*;
/// # struct App;
/// # impl PixEngine for App {
/// fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
/// if s.keys().contains(&Key::Space) && s.keys().contains(&Key::Up) {
/// s.background(Color::random());
/// }
/// Ok(())
/// }
/// # }
/// ```
#[inline]
#[must_use]
pub const fn keys(&self) -> &HashSet<Key> {
self.ui.keys()
}
/// Returns if a specific [`KeyMod`] was pressed this frame.
///
/// # Example
///
/// ```
/// # use pix_engine::prelude::*;
/// # struct App;
/// # impl PixEngine for App {
/// fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
/// if s.keymod_down(KeyMod::CTRL) && s.key_down(Key::Space) {
/// s.background(Color::random());
/// }
/// Ok(())
/// }
/// # }
/// ```
#[inline]
#[must_use]
pub const fn keymod_down(&self, keymod: KeyMod) -> bool {
self.ui.keymod_down(keymod)
}
/// Returns a list of the current key modifiers pressed this frame.
///
/// # Example
///
/// ```
/// # use pix_engine::prelude::*;
/// # struct App;
/// # impl PixEngine for App {
/// fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
/// if s.keymod().intersects(KeyMod::SHIFT | KeyMod::CTRL)
/// && s.key_down(Key::Space)
/// {
/// s.background(Color::random());
/// }
/// Ok(())
/// }
/// # }
/// ```
#[inline]
pub const fn keymod(&self) -> &KeyMod {
self.ui.keymod()
}
}
impl PixState {
/// Constructs `PixState` with a given [Renderer].
#[inline]
pub(crate) fn new(settings: RendererSettings, theme: Theme) -> PixResult<Self> {
let show_frame_rate = settings.show_frame_rate;
let target_frame_rate = settings.target_frame_rate;
let renderer = Renderer::new(settings)?;
let mut state = Self {
renderer,
env: Environment::default(),
ui: UiState::default(),
settings: Settings::default(),
setting_stack: Vec::new(),
theme: theme.clone(),
};
state.background(theme.colors.background);
state.fill(theme.colors.on_background());
state.show_frame_rate(show_frame_rate);
state.frame_rate(target_frame_rate);
state.font_size(theme.font_size)?;
state.font_style(theme.styles.body);
state.font_family(theme.fonts.body)?;
Ok(state)
}
/// Handle state changes this frame prior to calling [`PixEngine::on_update`].
#[inline]
pub(crate) fn pre_update(&mut self) {
// Reset mouse cursor icon to the current setting
// Ignore any errors, as setting cursor in the first place should have succeeded.
let _ignore_result = self.renderer.cursor(self.settings.cursor.as_ref());
self.ui.pre_update(&self.theme);
}
/// Handle state updates for this frame.
#[inline]
pub(crate) fn on_update(&mut self) -> PixResult<()> {
for texture in self.ui.textures.iter_mut().filter(|t| t.visible) {
self.renderer
.texture(texture.id, texture.src, texture.dst, 0.0, None, None, None)?;
}
Ok(())
}
/// Handle state changes this frame after calling [`PixEngine::on_update`].
#[inline]
pub(crate) fn post_update(&mut self) {
self.ui.post_update();
}
/// Takes a [Rect] and returns a modified [Rect] based on the current [`RectMode`].
#[inline]
pub(crate) fn get_rect<R>(&self, rect: R) -> Rect<i32>
where
R: Into<Rect<i32>>,
{
let mut rect = rect.into();
if self.settings.rect_mode == RectMode::Center {
rect.center_on(rect.top_left());
}
rect
}
/// Takes an [Ellipse] and returns a modified [Ellipse] based on the current [`EllipseMode`].
#[inline]
pub(crate) fn get_ellipse<E>(&self, ellipse: E) -> Ellipse<i32>
where
E: Into<Ellipse<i32>>,
{
let mut ellipse = ellipse.into();
if self.settings.ellipse_mode == RectMode::Corner {
ellipse.center_on(ellipse.bottom_right());
}
ellipse
}
/// Updates the mouse position state this frame.
#[inline]
pub(crate) fn on_mouse_motion(&mut self, pos: Point<i32>) {
self.ui.pmouse.pos = self.ui.mouse.pos;
self.ui.mouse.pos = pos;
}
/// Updates the mouse click state this frame.
#[inline]
pub(crate) fn on_mouse_click(&mut self, btn: Mouse, time: Instant) {
self.ui.pmouse.clicked = mem::take(&mut self.ui.mouse.clicked);
self.ui.pmouse.last_clicked = mem::take(&mut self.ui.mouse.last_clicked);
self.ui.mouse.click(btn, time);
}
/// Updates the mouse double click state this frame.
#[inline]
pub(crate) fn on_mouse_dbl_click(&mut self, btn: Mouse, time: Instant) {
self.ui.pmouse.last_dbl_clicked = mem::take(&mut self.ui.mouse.last_dbl_clicked);
self.ui.mouse.dbl_click(btn, time);
}
/// Updates the mouse pressed state this frame.
#[inline]
pub(crate) fn on_mouse_pressed(&mut self, btn: Mouse) {
self.ui.pmouse.pressed = mem::take(&mut self.ui.mouse.pressed);
self.ui.mouse.press(btn);
}
/// Updates the mouse released state this frame.
#[inline]
pub(crate) fn on_mouse_released(&mut self, btn: Mouse) {
self.ui.pmouse.pressed = mem::take(&mut self.ui.mouse.pressed);
self.ui.mouse.release(btn);
}
/// Updates the mouse wheel state this frame.
#[inline]
pub(crate) fn on_mouse_wheel(&mut self, x: i32, y: i32) {
self.ui.pmouse.xrel = self.ui.mouse.xrel;
self.ui.pmouse.yrel = self.ui.mouse.yrel;
self.ui.mouse.wheel(x, y);
}
/// Polls for events from the underlying renderer.
#[inline]
pub fn poll_event(&mut self) -> Option<Event> {
self.renderer.poll_event()
}
/// Open a controller with a given ID to start handling events.
///
/// # Errors
///
/// If the `ControllerId` is invalid or the renderer fails to open the controller, then an
/// error is returned.
#[inline]
pub fn open_controller(&mut self, id: ControllerId) -> PixResult<()> {
self.renderer.open_controller(id)
}
/// Close a controller with a given ID to stop handling events.
#[inline]
pub fn close_controller(&mut self, id: ControllerId) {
self.renderer.close_controller(id);
}
}