1ba7429371
# Objective Provide a starting point for #3951, or a partial solution. Providing a few comment blocks to discuss, and hopefully find better one in the process. ## Solution Since I am pretty new to pretty much anything in this context, I figured I'd just start with a draft for some file level doc blocks. For some of them I found more relevant details (or at least things I considered interessting), for some others there is less. ## Changelog - Moved some existing comments from main() functions in the 2d examples to the file header level - Wrote some more comment blocks for most other 2d examples TODO: - [x] 2d/sprite_sheet, wasnt able to come up with something good yet - [x] all other example groups... Also: Please let me know if the commit style is okay, or to verbose. I could certainly squash these things, or add more details if needed. I also hope its okay to raise this PR this early, with just a few files changed. Took me long enough and I dont wanted to let it go to waste because I lost motivation to do the whole thing. Additionally I am somewhat uncertain over the style and contents of the commets. So let me know what you thing please.
58 lines
1.8 KiB
Rust
58 lines
1.8 KiB
Rust
//! This example shows how to configure Multi-Sample Anti-Aliasing. Setting the sample count higher
|
|
//! will result in smoother edges, but it will also increase the cost to render those edges. The
|
|
//! range should generally be somewhere between 1 (no multi sampling, but cheap) to 8 (crisp but
|
|
//! expensive).
|
|
//! Note that WGPU currently only supports 1 or 4 samples.
|
|
//! Ultimately we plan on supporting whatever is natively supported on a given device.
|
|
//! Check out [this issue](https://github.com/gfx-rs/wgpu/issues/1832) for more info.
|
|
|
|
use bevy::prelude::*;
|
|
|
|
fn main() {
|
|
App::new()
|
|
.insert_resource(Msaa { samples: 4 })
|
|
.add_plugins(DefaultPlugins)
|
|
.add_startup_system(setup)
|
|
.add_system(cycle_msaa)
|
|
.run();
|
|
}
|
|
|
|
/// set up a simple 3D scene
|
|
fn setup(
|
|
mut commands: Commands,
|
|
mut meshes: ResMut<Assets<Mesh>>,
|
|
mut materials: ResMut<Assets<StandardMaterial>>,
|
|
) {
|
|
info!("Press 'm' to toggle MSAA");
|
|
info!("Using 4x MSAA");
|
|
|
|
// cube
|
|
commands.spawn_bundle(PbrBundle {
|
|
mesh: meshes.add(Mesh::from(shape::Cube { size: 2.0 })),
|
|
material: materials.add(Color::rgb(0.8, 0.7, 0.6).into()),
|
|
..default()
|
|
});
|
|
// light
|
|
commands.spawn_bundle(PointLightBundle {
|
|
transform: Transform::from_xyz(4.0, 8.0, 4.0),
|
|
..default()
|
|
});
|
|
// camera
|
|
commands.spawn_bundle(PerspectiveCameraBundle {
|
|
transform: Transform::from_xyz(-3.0, 3.0, 5.0).looking_at(Vec3::ZERO, Vec3::Y),
|
|
..default()
|
|
});
|
|
}
|
|
|
|
fn cycle_msaa(input: Res<Input<KeyCode>>, mut msaa: ResMut<Msaa>) {
|
|
if input.just_pressed(KeyCode::M) {
|
|
if msaa.samples == 4 {
|
|
info!("Not using MSAA");
|
|
msaa.samples = 1;
|
|
} else {
|
|
info!("Using 4x MSAA");
|
|
msaa.samples = 4;
|
|
}
|
|
}
|
|
}
|