framealloc 0.11.1

Intent-aware, thread-smart memory allocation for Rust game engines
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

//! Bevy plugin for framealloc.

use bevy_app::{App, First, Last, Plugin};

use crate::api::config::AllocConfig;
use crate::api::alloc::SmartAlloc;
use crate::bevy::resource::AllocResource;
use crate::bevy::systems::{begin_frame_system, end_frame_system};

/// Bevy plugin that integrates framealloc into your game.
///
/// # Example
///
/// ```rust,ignore
/// use bevy::prelude::*;
/// use framealloc::bevy::SmartAllocPlugin;
///
/// App::new()
///     .add_plugins(DefaultPlugins)
///     .add_plugins(SmartAllocPlugin::default())
///     .run();
/// ```
pub struct SmartAllocPlugin {
    config: AllocConfig,
}

impl SmartAllocPlugin {
    /// Create a new plugin with the given configuration.
    pub fn new(config: AllocConfig) -> Self {
        Self { config }
    }

    /// Create a plugin with high-performance settings.
    pub fn high_performance() -> Self {
        Self {
            config: AllocConfig::high_performance(),
        }
    }

    /// Create a plugin with minimal settings (for testing).
    pub fn minimal() -> Self {
        Self {
            config: AllocConfig::minimal(),
        }
    }
}

impl Default for SmartAllocPlugin {
    fn default() -> Self {
        Self {
            config: AllocConfig::default(),
        }
    }
}

impl Plugin for SmartAllocPlugin {
    fn build(&self, app: &mut App) {
        let alloc = SmartAlloc::new(self.config.clone());

        app.insert_resource(AllocResource(alloc))
            .add_systems(First, begin_frame_system)
            .add_systems(Last, end_frame_system);
    }
}