astrelis 0.2.0

A modular 2D/3D game engine framework
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
91
92
93
94
95
96
97
98

//! Default plugins for the Astrelis engine.
//!
//! This module contains the built-in plugins that provide common
//! game engine functionality.

mod asset_plugin;
mod async_runtime_plugin;

#[cfg(all(feature = "render", feature = "winit"))]
mod render_plugin;

#[cfg(feature = "input")]
mod input_plugin;

#[cfg(feature = "text")]
mod text_plugin;

mod time_plugin;

pub use asset_plugin::AssetPlugin;
pub use async_runtime_plugin::AsyncRuntimePlugin;

pub use time_plugin::TimePlugin;

#[cfg(all(feature = "render", feature = "winit"))]
pub use render_plugin::RenderPlugin;

#[cfg(all(feature = "render", feature = "winit"))]
pub use render_plugin::RenderContexts;

#[cfg(feature = "input")]
pub use input_plugin::InputPlugin;

#[cfg(feature = "text")]
pub use text_plugin::TextPlugin;

use crate::plugin::{PluginDyn, PluginGroup};

/// Default plugins for a minimal game setup.
///
/// Includes:
/// - `AssetPlugin` - Asset loading and management
///
/// # Example
///
/// ```ignore
/// use astrelis::{Engine, DefaultPlugins};
///
/// let engine = Engine::builder()
///     .add_plugins(DefaultPlugins)
///     .build();
/// ```
pub struct MinimalPlugins;

impl PluginGroup for MinimalPlugins {
    fn plugins(&self) -> Vec<Box<dyn PluginDyn>> {
        vec![Box::new(AssetPlugin::default())]
    }

    fn name(&self) -> &'static str {
        "MinimalPlugins"
    }
}

/// Default plugins for a typical game.
///
/// Includes:
/// - `AssetPlugin` - Asset loading and management
/// - `InputPlugin` - Input state management
///
/// # Example
///
/// ```ignore
/// use astrelis::{Engine, DefaultPlugins};
///
/// let engine = Engine::builder()
///     .add_plugins(DefaultPlugins)
///     .build();
/// ```
pub struct DefaultPlugins;

impl PluginGroup for DefaultPlugins {
    fn plugins(&self) -> Vec<Box<dyn PluginDyn>> {
        let mut plugins: Vec<Box<dyn PluginDyn>> = vec![
            Box::new(AssetPlugin::default()),
            Box::new(TimePlugin),
        ];

        #[cfg(feature = "input")]
        plugins.push(Box::new(InputPlugin));

        plugins
    }

    fn name(&self) -> &'static str {
        "DefaultPlugins"
    }
}