Struct ImagePlugin

pub struct ImagePlugin {
    pub default_sampler: ImageSamplerDescriptor,
}

Adds the Image as an asset and makes sure that they are extracted and prepared for the GPU.

Fields

default_sampler: ImageSamplerDescriptor

The default image sampler to use when bevy_image::ImageSampler is set to Default.

Implementations

impl ImagePlugin

pub fn default_linear() -> ImagePlugin

Creates image settings with linear sampling by default.

pub fn default_nearest() -> ImagePlugin

Creates image settings with nearest sampling by default.

Examples found in repository

examples/2d/sprite_sheet.rs (line 8)

fn main() {
    App::new()
        .add_plugins(DefaultPlugins.set(ImagePlugin::default_nearest())) // prevents blurry sprites
        .add_systems(Startup, setup)
        .add_systems(Update, animate_sprite)
        .run();
}

examples/picking/sprite_picking.rs (line 9)

fn main() {
    App::new()
        .add_plugins(DefaultPlugins.set(ImagePlugin::default_nearest()))
        .add_systems(Startup, (setup, setup_atlas))
        .add_systems(Update, (move_sprite, animate_sprite))
        .run();
}

examples/2d/pixel_grid_snap.rs (line 31)

fn main() {
    App::new()
        .add_plugins(DefaultPlugins.set(ImagePlugin::default_nearest()))
        .add_systems(Startup, (setup_camera, setup_sprite, setup_mesh))
        .add_systems(Update, (rotate, fit_canvas))
        .run();
}

examples/shader/texture_binding_array.rs (line 27)

fn main() {
    let mut app = App::new();
    app.add_plugins((
        DefaultPlugins.set(ImagePlugin::default_nearest()),
        GpuFeatureSupportChecker,
        MaterialPlugin::<BindlessMaterial>::default(),
    ))
    .add_systems(Startup, setup)
    .run();
}

examples/2d/texture_atlas.rs (line 14)

fn main() {
    App::new()
        .add_plugins(DefaultPlugins.set(ImagePlugin::default_nearest())) // fallback to nearest sampling
        .init_state::<AppState>()
        .add_systems(OnEnter(AppState::Setup), load_textures)
        .add_systems(Update, check_textures.run_if(in_state(AppState::Setup)))
        .add_systems(OnEnter(AppState::Finished), setup)
        .run();
}

examples/3d/3d_shapes.rs (line 23)

fn main() {
    App::new()
        .add_plugins((
            DefaultPlugins.set(ImagePlugin::default_nearest()),
            #[cfg(not(target_arch = "wasm32"))]
            WireframePlugin::default(),
        ))
        .add_systems(Startup, setup)
        .add_systems(
            Update,
            (
                rotate,
                #[cfg(not(target_arch = "wasm32"))]
                toggle_wireframe,
            ),
        )
        .run();
}

Additional examples can be found in:

• examples/ui/ui_texture_atlas.rs
• examples/2d/sprite_animation.rs
• examples/shader/compute_shader_game_of_life.rs
• examples/app/headless_renderer.rs

Trait Implementations

impl Default for ImagePlugin

fn default() -> ImagePlugin

Returns the “default value” for a type.

impl Plugin for ImagePlugin

fn build(&self, app: &mut App)

Configures the App to which this plugin is added.

fn finish(&self, app: &mut App)

Finish adding this plugin to the App, once all plugins registered are ready. This can be useful for plugins that depends on another plugin asynchronous setup, like the renderer.

fn ready(&self, _app: &App) -> bool

Has the plugin finished its setup? This can be useful for plugins that need something asynchronous to happen before they can finish their setup, like the initialization of a renderer. Once the plugin is ready, finish should be called.

fn cleanup(&self, _app: &mut App)

Runs after all plugins are built and finished, but before the app schedule is executed. This can be useful if you have some resource that other plugins need during their build step, but after build you want to remove it and send it to another thread.

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for checking plugin uniqueness and debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.