rust-pushrod 0.4.27

Pushrod UI Library
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
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

// Pushrod Rendering Library
// Core Rendering Module
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use sdl2::pixels::Color;

/// This is a type that defines two points: X and Y coordinates.
pub type Points = Vec<i32>;

/// Quick reference in `Points` `Vec` for X position.
pub const POINT_X: usize = 0;

/// Quick reference in `Points` `Vec` for Y position.
pub const POINT_Y: usize = 1;

/// This is a type that defines two size: width and height.
pub type Size = Vec<u32>;

/// Quick reference in `Size` `Vec` for width.
pub const SIZE_WIDTH: usize = 0;

/// Quick reference in `Size` `Vec` for height.
pub const SIZE_HEIGHT: usize = 1;

/// Convenience method to create a `Points` type.
pub fn make_points(x: i32, y: i32) -> Points {
    vec![x, y]
}

/// Convenience method to create a `Points` type at origin coordinates (0, 0)
pub fn make_points_origin() -> Points {
    vec![0, 0]
}

/// Convenience method to create a `Size` type.
pub fn make_size(w: u32, h: u32) -> Size {
    vec![w, h]
}

/// Calculates the inverse of a color.
pub fn inverse_color(color: Color) -> Color {
    Color::RGBA(255 - color.r, 255 - color.g, 255 - color.b, color.a)
}

/// This is a store used by `Widget`s for drawing against.  Once the drawing is complete, the
/// `Texture` stored within is used for blitting to the screen.
pub mod texture_store;

/// This is the `Engine` that is used to dispatch events from the screen to a corresponding list
/// of `Widget`s in a `Window`.  This is the main event loop.
pub mod engine;

/// This is the `CanvasHelper` trait that is used to help draw against a `Canvas`.
pub mod canvas_helper;

/// This is the `Callbacks` mechanism for each `Widget`, providing a way to perform a function when
/// an action is intercepted (ie. mouse enter, exit, move, etc.)
pub mod callbacks;

/// This is the `Widget` and `BaseWidget` definitions for `Widget` objects to be defined by the
/// `pushrod` project, and other crates that may define or create their own `Widget`s.
pub mod widget;

/// This is a configuration object that stores information about `Widget`s.
pub mod widget_config;

/// This is the caching object that stores a list of `Widget`s that the Pushrod engine manages.
pub mod widget_cache;

/// This is a layout manager description module, describing rules for `Layout` managers to be used
/// in the system, and having `Widget`s added to them.
pub mod layout;

/// This is a caching object that stores a container of `Layout` objects, managed by the Pushrod
/// engine.
pub mod layout_cache;

/// This is a caching object that stores Textures for fonts and images.
pub mod texture_cache;