hui 0.1.0-alpha.6

Simple UI library for games and other interactive applications
Documentation 
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

//! modular procedural background system

use crate::{draw::UiDrawCommandList, rect::Rect};

pub mod point;
mod rect;
pub mod stack;
pub mod nine_patch;
mod impls;

pub use rect::RectFrame;

/// Trait for a drawable frame
pub trait Frame {
  /// Draw the frame at the given rect's position and size
  fn draw(&self, draw: &mut UiDrawCommandList, rect: Rect);

  /// Check if the frame is guaranteed to be fully opaque and fully cover the parent frame regardless of it's size
  ///
  /// Returns true if the frame:
  /// - Is fully opaque (i.e. `alpha >= 1.0`)
  /// - Completely covers (or exceeds the size of) the frame
  ///
  /// False negatives are acceptable, but false positives ***are not***.\
  /// May be used for optimization purposes
  fn covers_opaque(&self) -> bool { false }
}