Add support for flat shading with indiced meshes

Cargo.toml

@@ -181,6 +181,10 @@ path = "examples/3d/wireframe.rs"
 name = "z_sort_debug"
 path = "examples/3d/z_sort_debug.rs"
 
+[[example]]
+name = "flat_shading"
+path = "examples/3d/flat_shading.rs"
+
 # Application
 [[example]]
 name = "custom_loop"

crates/bevy_pbr/src/material.rs

@@ -42,6 +42,14 @@ pub struct StandardMaterial {
     #[render_resources(ignore)]
     #[shader_def]
     pub unlit: bool,
+    /// Flat shading makes the shader generate normals per face instead of per vertex.
+    /// This means that you get a uniform color over the whole triangle (think Virtua Racing).
+    /// The method uses fragment shader derivatives which can cause some artifacts in some cases.
+    /// An alternative is using `Mesh::duplicate_vertices()` and `Mesh::compute_flat_normals()`
+    /// and setting this setting to false, this will make sure no artifacts occur.
+    #[render_resources(ignore)]
+    #[shader_def]
+    pub flat_shading: bool,
 }
 
 impl Default for StandardMaterial {
@@ -69,6 +77,7 @@ impl Default for StandardMaterial {
             emissive: Color::BLACK,
             emissive_texture: None,
             unlit: false,
+            flat_shading: false,
         }
     }
 }

crates/bevy_pbr/src/render_graph/pbr_pipeline/pbr.frag

@@ -43,14 +43,17 @@ struct PointLight {
     vec4 color;
     vec4 lightParams;
 };
- 
+
 struct DirectionalLight {
     vec4 direction;
     vec4 color;
 };
 
 layout(location = 0) in vec3 v_WorldPosition;
+
+#ifndef STANDARDMATERIAL_FLAT_SHADING
 layout(location = 1) in vec3 v_WorldNormal;
+#endif
 layout(location = 2) in vec2 v_Uv;
 
 #ifdef STANDARDMATERIAL_NORMAL_MAP
@@ -368,7 +371,11 @@ void main() {
 
     float roughness = perceptualRoughnessToRoughness(perceptual_roughness);
 
+#    ifdef STANDARDMATERIAL_FLAT_SHADING
+    vec3 N = normalize(cross(dFdy(v_WorldPosition), dFdx(v_WorldPosition)));
+#    else
     vec3 N = normalize(v_WorldNormal);
+#    endif
 
 #    ifdef STANDARDMATERIAL_NORMAL_MAP
     vec3 T = normalize(v_WorldTangent.xyz);

crates/bevy_pbr/src/render_graph/pbr_pipeline/pbr.vert

@@ -1,15 +1,19 @@
 #version 450
 
 layout(location = 0) in vec3 Vertex_Position;
+#ifndef STANDARDMATERIAL_FLAT_SHADING
 layout(location = 1) in vec3 Vertex_Normal;
+#endif
 layout(location = 2) in vec2 Vertex_Uv;
 
 #ifdef STANDARDMATERIAL_NORMAL_MAP
 layout(location = 3) in vec4 Vertex_Tangent;
 #endif
 
 layout(location = 0) out vec3 v_WorldPosition;
+#ifndef STANDARDMATERIAL_FLAT_SHADING
 layout(location = 1) out vec3 v_WorldNormal;
+#endif
 layout(location = 2) out vec2 v_Uv;
 
 layout(set = 0, binding = 0) uniform CameraViewProj {
@@ -27,7 +31,9 @@ layout(set = 2, binding = 0) uniform Transform {
 void main() {
     vec4 world_position = Model * vec4(Vertex_Position, 1.0);
     v_WorldPosition = world_position.xyz;
+#ifndef STANDARDMATERIAL_FLAT_SHADING
     v_WorldNormal = mat3(Model) * Vertex_Normal;
+#endif
     v_Uv = Vertex_Uv;
 #ifdef STANDARDMATERIAL_NORMAL_MAP
     v_WorldTangent = vec4(mat3(Model) * Vertex_Tangent.xyz, Vertex_Tangent.w);

examples/3d/flat_shading.rs

@@ -0,0 +1,61 @@
+use bevy::prelude::*;
+
+/// This example shows the difference between flat shading
+/// and smooth shading (default) in `StandardMaterial`.
+/// Flat shading gives a much more "Polygonal" or "Retro" look to meshes.
+fn main() {
+    App::new()
+        .insert_resource(Msaa { samples: 4 })
+        .add_plugins(DefaultPlugins)
+        .add_startup_system(setup)
+        .run();
+}
+
+/// set up a simple 3D scene
+fn setup(
+    mut commands: Commands,
+    mut meshes: ResMut<Assets<Mesh>>,
+    mut materials: ResMut<Assets<StandardMaterial>>,
+) {
+    // Flat shaded icosphere (ORANGE)
+    commands.spawn_bundle(PbrBundle {
+        mesh: meshes.add(Mesh::from(shape::Icosphere {
+            radius: 0.5,
+            subdivisions: 4,
+        })),
+        material: materials.add(StandardMaterial {
+            base_color: Color::ORANGE,
+            flat_shading: true,
+            ..Default::default()
+        }),
+        transform: Transform::from_xyz(-0.55, 0.5, 0.0),
+        ..Default::default()
+    });
+    // Smooth shaded icosphere (BLUE)
+    commands.spawn_bundle(PbrBundle {
+        mesh: meshes.add(Mesh::from(shape::Icosphere {
+            radius: 0.5,
+            subdivisions: 4,
+        })),
+        material: materials.add(Color::BLUE.into()),
+        transform: Transform::from_xyz(0.55, 0.5, 0.0),
+        ..Default::default()
+    });
+
+    // plane
+    commands.spawn_bundle(PbrBundle {
+        mesh: meshes.add(Mesh::from(shape::Plane { size: 5.0 })),
+        material: materials.add(Color::rgb(0.3, 0.5, 0.3).into()),
+        ..Default::default()
+    });
+    // light
+    commands.spawn_bundle(PointLightBundle {
+        transform: Transform::from_xyz(5.0, 5.0, 5.0),
+        ..Default::default()
+    });
+    // camera
+    commands.spawn_bundle(PerspectiveCameraBundle {
+        transform: Transform::from_xyz(1.0, 3.0, 4.0).looking_at(Vec3::ZERO, Vec3::Y),
+        ..Default::default()
+    });
+}

examples/README.md

@@ -107,6 +107,7 @@ Example | File | Description
 `update_gltf_scene` | [`3d/update_gltf_scene.rs`](./3d/update_gltf_scene.rs) | Update a scene from a gltf file, either by spawning the scene as a child of another entity, or by accessing the entities of the scene
 `wireframe` | [`3d/wireframe.rs`](./3d/wireframe.rs) | Showcases wireframe rendering
 `z_sort_debug` | [`3d/z_sort_debug.rs`](./3d/z_sort_debug.rs) | Visualizes camera Z-ordering
+`flat_shading` | [`3d/flat_shading.rs`](./3d/flat_shading.rs) | Simple 3D scene showing flat and smooth (default) shading
 
 ## Application