[Merged by Bors] - Array texture example by superdump · Pull Request #5077 · bevyengine/bevy

superdump · 2022-06-23T10:34:33Z

Objective

Make the reusable PBR shading functionality a little more reusable
- Add constructor functions for StandardMaterial and PbrInput structs to populate them with default values
- Document unclear PbrInput members
Demonstrate how to reuse the bevy PBR shading functionality
The final important piece from Reusable PBR shader types/bindings/functions #3969 as the initial shot at making the PBR shader code reusable in custom materials

Solution

Add back and rework the 'old' array_texture example from pre-0.6.
Create a custom shader material
- Use a single array texture binding and sampler for the material bind group
- Use a shader that calls pbr() from the bevy_pbr::pbr_functions import
Spawn a row of cubes using the custom material
In the shader, select the array texture layer to sample by using the world position x coordinate modulo the number of array texture layers

superdump · 2022-06-23T16:54:48Z

examples/shader/array_texture.rs

+
+    // Create a new array texture asset from the loaded texture.
+    let array_layers = 4;
+    image.reinterpret_stacked_2d_as_array(array_layers);


It's a shame this can't be done up-front when loading the image.

But I guess asset pipeline and metadata stuff will sort that out.

superdump · 2022-06-23T16:56:18Z

examples/shader/array_texture.rs

+    for x in -5..=5 {
+        commands.spawn_bundle(MaterialMeshBundle {
+            mesh: mesh_handle.clone(),
+            material: material_handle.clone(),
+            transform: Transform::from_xyz(x as f32 + 0.5, 0.0, 0.0),
+            ..Default::default()
+        });
+    }


I'm spawning these here so that they only exist when the asset has loaded. I think that was because otherwise a non-array-texture fallback image is attempted to be used for the binding due to how mesh_pipeline.get_image_texture() works.

This removes the dependency of pbr_functions.wgsl on the material binding.

…unction

…tionality

cart · 2022-06-28T00:49:27Z

assets/shaders/array_texture.wgsl

+
+    // Prepare a 'processed' StandardMaterial by sampling all textures to resolve
+    // the material members
+    var pbr_input: PbrInput = pbr_input_new();


Random thought (not necessary for this pr): maybe we should have a pbr_input_default() function that sets as much as possible "automatically". Hard to do for FragmentInput, given that it is defined per-shader. But we could at least auto-calculate is_orthographic. Maybe we could have a standardized struct for "normal" fragment inputs, which users pass in to pbr_input_default(standard_frag_input_here)? Again, definitely not something to do in this pr, but it feels like theres room for ux improvements here.

I agree and want to iterate some more on this when I have time.

cart

Looks good to me, barring one comment. Merging this before #5053 will break it, but adapting this to a manual AsBindGroup impl should be straightforward / im happy to pick that up.

cart · 2022-06-28T00:55:28Z

examples/shader/array_texture.rs

+}
+
+impl Material for ArrayTextureMaterial {
+    // fn vertex_shader(asset_server: &AssetServer) -> Option<Handle<Shader>> {


We should remove this comment. I don't like including "unnecessary" commented out code in examples.

cart · 2022-06-28T00:58:35Z

bors r+

# Objective - Make the reusable PBR shading functionality a little more reusable - Add constructor functions for `StandardMaterial` and `PbrInput` structs to populate them with default values - Document unclear `PbrInput` members - Demonstrate how to reuse the bevy PBR shading functionality - The final important piece from #3969 as the initial shot at making the PBR shader code reusable in custom materials ## Solution - Add back and rework the 'old' `array_texture` example from pre-0.6. - Create a custom shader material - Use a single array texture binding and sampler for the material bind group - Use a shader that calls `pbr()` from the `bevy_pbr::pbr_functions` import - Spawn a row of cubes using the custom material - In the shader, select the array texture layer to sample by using the world position x coordinate modulo the number of array texture layers <img width="1392" alt="Screenshot 2022-06-23 at 12 28 05" src="https://user-images.githubusercontent.com/302146/175278593-2296f519-f577-4ece-81c0-d842283784a1.png"> Co-authored-by: Carter Anderson <mcanders1@gmail.com>

bors · 2022-06-28T01:22:21Z

Pull request successfully merged into main.

Build succeeded:

# Objective - Make the reusable PBR shading functionality a little more reusable - Add constructor functions for `StandardMaterial` and `PbrInput` structs to populate them with default values - Document unclear `PbrInput` members - Demonstrate how to reuse the bevy PBR shading functionality - The final important piece from bevyengine#3969 as the initial shot at making the PBR shader code reusable in custom materials ## Solution - Add back and rework the 'old' `array_texture` example from pre-0.6. - Create a custom shader material - Use a single array texture binding and sampler for the material bind group - Use a shader that calls `pbr()` from the `bevy_pbr::pbr_functions` import - Spawn a row of cubes using the custom material - In the shader, select the array texture layer to sample by using the world position x coordinate modulo the number of array texture layers <img width="1392" alt="Screenshot 2022-06-23 at 12 28 05" src="https://user-images.githubusercontent.com/302146/175278593-2296f519-f577-4ece-81c0-d842283784a1.png"> Co-authored-by: Carter Anderson <mcanders1@gmail.com>

james7132 added A-Rendering Drawing game state to the screen C-Examples An addition or correction to our examples labels Jun 23, 2022

superdump added this to the Bevy 0.8 milestone Jun 23, 2022

superdump mentioned this pull request Jun 23, 2022

Reusable PBR shader types/bindings/functions #3969

Closed

superdump commented Jun 23, 2022

View reviewed changes

superdump added 4 commits June 26, 2022 00:12

bevy_pbr: Pass standard material flags as argument to prepare_normal()

923b307

This removes the dependency of pbr_functions.wgsl on the material binding.

bevy_pbr: Add PbrInput documentation and default constructor helper f…

18d03ab

…unction

Add array_texture example to demonstrate how to reuse PBR shader func…

936c4c6

…tionality

bevy_pbr: Separate out standard_material_new() helper function

26f8d1d

superdump force-pushed the array-texture-example branch from 3a2d2f2 to 26f8d1d Compare June 25, 2022 22:18

cart reviewed Jun 28, 2022

View reviewed changes

cart approved these changes Jun 28, 2022

View reviewed changes

remove commented out code

dba78e0

bors bot changed the title ~~Array texture example~~ [Merged by Bors] - Array texture example Jun 28, 2022

bors bot closed this Jun 28, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Merged by Bors] - Array texture example#5077

[Merged by Bors] - Array texture example#5077
superdump wants to merge 5 commits intobevyengine:mainfrom
superdump:array-texture-example

superdump commented Jun 23, 2022 •

edited

Loading

Uh oh!

superdump Jun 23, 2022

Uh oh!

superdump Jun 23, 2022

Uh oh!

superdump Jun 23, 2022

Uh oh!

cart Jun 28, 2022 •

edited

Loading

Uh oh!

superdump Jun 28, 2022

Uh oh!

cart left a comment

Uh oh!

cart Jun 28, 2022

Uh oh!

cart commented Jun 28, 2022

Uh oh!

bors bot commented Jun 28, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

superdump commented Jun 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Objective

Solution

Uh oh!

superdump Jun 23, 2022

Choose a reason for hiding this comment

Uh oh!

superdump Jun 23, 2022

Choose a reason for hiding this comment

Uh oh!

superdump Jun 23, 2022

Choose a reason for hiding this comment

Uh oh!

cart Jun 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

superdump Jun 28, 2022

Choose a reason for hiding this comment

Uh oh!

cart left a comment

Choose a reason for hiding this comment

Uh oh!

cart Jun 28, 2022

Choose a reason for hiding this comment

Uh oh!

cart commented Jun 28, 2022

Uh oh!

bors bot commented Jun 28, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

superdump commented Jun 23, 2022 •

edited

Loading

cart Jun 28, 2022 •

edited

Loading