Struct bones_bevy_renderer::BonesBevyRenderer

pub struct BonesBevyRenderer {
    pub preload: bool,
    pub custom_load_progress: Option<Box<dyn FnMut(&AssetServer, &Context) + Sync + Send + 'static>>,
    pub pixel_art: bool,
    pub game: Game,
    pub game_version: Version,
    pub app_namespace: (String, String, String),
    pub asset_dir: PathBuf,
    pub packs_dir: PathBuf,
}

Renderer for [bones_framework] [Game][bones::Game]s using Bevy.

Fields

preload: bool

Whether or not to load all assets on startup with a loading screen, or skip straight to running the bones game immedietally.

custom_load_progress: Option<Box<dyn FnMut(&AssetServer, &Context) + Sync + Send + 'static>>

Optional field to implement your own loading screen. Does nothing if Self::preload = false

pixel_art: bool

Whether or not to use nearest-neighbor sampling for textures.

game: Game

The bones game to run.

game_version: Version

The version of the game, used for the asset loader.

app_namespace: (String, String, String)

The (qualifier, organization, application) that will be used to pick a persistent storage location for the game.

For example: ("org", "fishfolk", "jumpy")

asset_dir: PathBuf

The path to load assets from.

packs_dir: PathBuf

The path to load asset packs from.

Implementations

impl BonesBevyRenderer

pub fn new(game: Game) -> Self

Create a new BonesBevyRenderer for the provided game.

pub fn preload(self, preload: bool) -> Self

Whether or not to load all assets on startup with a loading screen, or skip straight to running the bones game immedietally.

pub fn loading_screen( self, function: Box<dyn FnMut(&AssetServer, &Context) + Sync + Send + 'static>, ) -> Self

Insert a custom loading screen function that will be used in place of the default

pub fn pixel_art(self, pixel_art: bool) -> Self

Whether or not to use nearest-neighbor sampling for textures.

pub fn namespace( self, (qualifier, organization, application): (&str, &str, &str), ) -> Self

The (qualifier, organization, application) that will be used to pick a persistent storage location for the game.

For example: ("org", "fishfolk", "jumpy")

pub fn asset_dir(self, asset_dir: PathBuf) -> Self

The path to load assets from.

pub fn packs_dir(self, packs_dir: PathBuf) -> Self

The path to load asset packs from.

pub fn version(self, game_version: Version) -> Self

Set the version of the game, used for the asset loader.

pub fn app(self) -> App

Return a bevy [App] configured to run the bones game.