[Merged by Bors] - Derive AsBindGroup Improvements: Better errors, more options, update examples #5364

wrapperup · 2022-07-18T06:07:37Z

Objective

Builds on #5053

Provide better compile-time errors and diagnostics.
Add more options to allow more textures types and sampler types.
Update array_texture example to use upgraded AsBindGroup derive macro.

Solution

Split out the parsing of the inner struct/field attributes (the inside part of a #[foo(...)] attribute) for better clarity

Parse the binding index for all inner attributes, as it is part of all attributes (#[foo(0, ...)), then allow each attribute implementer to parse the rest of the attribute metadata as needed. This should make it very trivial to extend/change if needed in the future.

Replaced invocations of panic! with the syn::Error type, providing fine-grained errors that retains span information. This provides much nicer compile-time errors, and even better IDE errors.

Updated the array_texture example to demonstrate the new changes.

New AsBindGroup attribute options

`#[texture(u32, ...)]`

Where ... is an optional list of arguments.

Arguments	Values	Default
dimension = "..."	`"1d"`, `"2d"`, `"2d_array"`, `"3d"`, `"cube"`, `"cube_array"`	`"2d"`
sample_type = "..."	`"float"`, `"depth"`, `"s_int"` or `"u_int"`	`"float"`
filterable = ...	`true`, `false`	`true`
multisampled = ...	`true`, `false`	`false`
visibility(...)	`all`, `none`, or a list-combination of `vertex`, `fragment`, `compute`	`vertex`, `fragment`

Example: #[texture(0, dimension = "2d_array", visibility(vertex, fragment))]

`#[sampler(u32, ...)]`

Where ... is an optional list of arguments.

Arguments	Values	Default
sampler_type = "..."	`"filtering"`, `"non_filtering"`, `"comparison"`.	`"filtering"`
visibility(...)	`all`, `none`, or a list-combination of `vertex`, `fragment`, `compute`	`vertex`, `fragment`

Example: #[sampler(0, sampler_type = "filtering", visibility(vertex, fragment)]

Changelog

Added more options to #[texture(...)] and #[sampler(...)] attributes, supporting more kinds of materials. See above for details.
Upgraded IDE and compile-time error messages.
Updated array_texture example using the new options.

…nd sampler attributes.

IceSentry · 2022-07-18T06:12:14Z

I know it's still a draft, but I would suggest splitting this in 2 PRs. One for the better parsing and one that adds the new options. This will make it easier to review and increases how fast something can get merged.

wrapperup · 2022-07-18T08:44:54Z

I know it's still a draft, but I would suggest splitting this in 2 PRs. One for the better parsing and one that adds the new options. This will make it easier to review and increases how fast something can get merged.

Yep, I may actually split it into 3, one for the syn errors, one for the reorganized parsing, and one for the new options.

superdump · 2022-07-18T10:24:22Z

Looks like you need to run cargo fmt.

superdump · 2022-07-18T10:25:06Z

I'm adding this to the 0.8 milestone as it makes for a big improvement to the new AsBindGroup feature.

superdump

I think the mostly looks OK. I'm not strong with macros in Rust though so I'd suggest someone else take a look, like @cart as he wrote this. I haven't closely double-checked all the rendering bits are covered but it looks correct to me.

crates/bevy_render/macros/src/as_bind_group.rs

crates/bevy_render/macros/src/lib.rs

examples/shader/array_texture.rs

superdump

And now I have double-checked the rendering bits. What has been added is correct. There's still some more to go, but that is fine for this PR. :)

superdump · 2022-07-18T13:14:17Z

I know it's still a draft, but I would suggest splitting this in 2 PRs. One for the better parsing and one that adds the new options. This will make it easier to review and increases how fast something can get merged.

Yep, I may actually split it into 3, one for the syn errors, one for the reorganized parsing, and one for the new options.

Normally I would definitely agree with @IceSentry . In this case, as it's a key feature for the release, in my opinion, I suspect @cart may want to review it as-is.

superdump · 2022-07-18T13:47:08Z

I just had a thought for a future PR: it would be nice to automatically label the bindings.

superdump · 2022-07-18T20:33:30Z

If you want to iterate more quickly on getting this to pass CI checks, you can run cargo run -p ci locally.

…the main derive

wrapperup · 2022-07-18T22:29:42Z

Did a bit of clean-up, pretty happy with this PR now. Also now supports visibility flags

#[derive(AsBindGroup, Debug, Clone, TypeUuid)]
#[uuid = "9c5a0ddf-1eaf-41b4-9832-ed736fd26af3"]
struct ArrayTextureMaterial {
    #[texture(0, dimension = "2d_array", visibility(fragment))]
    #[sampler(1)]
    array_texture: Handle<Image>,
}

impl Material for ArrayTextureMaterial {
    fn fragment_shader() -> ShaderRef {
        "shaders/array_texture.wgsl".into()
    }
}

The syntax I think is pretty solid, but feel free to suggest any changes.

superdump · 2022-07-19T10:57:39Z

crates/bevy_render/macros/src/as_bind_group.rs

+#[derive(Default)]
+enum ShaderStageVisibility {
+    #[default]
+    All,


I think the default should probably be vertex|fragment. If someone wants compute then they can set it, and if someone wants to restrict to vertex or fragment they can set it.

The default previously was to have all visibility, but no material uses compute so this sounds reasonable.

@cart any opinions on what should be the default here?

It would mean that "by default" AsBindGroup won't work with compute shaders, which is a scenario we probably want to support (and increasingly so as the renderer progresses).

Its hard to have this conversation without knowing the performance tradeoffs. When I ran benchmarks of All vs Fragment (for the pbr shader), I couldn't identify any differences. But that doesn't necessarily mean that this is true for all platforms / scenarios.

Best I could find was kvark responding with "could be, yes" to this question:

When choosing bind group visibility, is there any performance implications of choosing something more specific like ShaderStages::VERTEX over just all?

Short term, I'm cool with limiting this to vertex|fragment given that compute is still pretty niche. But we should revisit this decision when it becomes more relevant.

I was also thinking that aside from performance, enabling a resource for compute usage could change something about some validation/usage constraints as well. I don't know.

crates/bevy_render/macros/src/as_bind_group.rs

cart · 2022-07-19T20:38:17Z

Yup lets leave this as-is. Splitting out would definitely help with reviews, but I'm comfortable reviewing this as a unit in the interest of time / including this in 0.8.

cart

Looks great to me. Love the improvements to the derive internals!

crates/bevy_render/macros/src/as_bind_group.rs

cart

I think this is ready to go. We can discuss "bind group visibility defaults" post-merge.

cart · 2022-07-19T22:05:28Z

bors r+

…examples (#5364) # Objective - Provide better compile-time errors and diagnostics. - Add more options to allow more textures types and sampler types. - Update array_texture example to use upgraded AsBindGroup derive macro. ## Solution Split out the parsing of the inner struct/field attributes (the inside part of a `#[foo(...)]` attribute) for better clarity Parse the binding index for all inner attributes, as it is part of all attributes (`#[foo(0, ...)`), then allow each attribute implementer to parse the rest of the attribute metadata as needed. This should make it very trivial to extend/change if needed in the future. Replaced invocations of `panic!` with the `syn::Error` type, providing fine-grained errors that retains span information. This provides much nicer compile-time errors, and even better IDE errors. ![image](https://user-images.githubusercontent.com/7478134/179452241-6d85d440-4b67-44da-80a7-9d47e8c88b8a.png) Updated the array_texture example to demonstrate the new changes. ## New AsBindGroup attribute options ### `#[texture(u32, ...)]` Where `...` is an optional list of arguments. | Arguments | Values | Default | |-------------- |---------------------------------------------------------------- | ----------- | | dimension = "..." | `"1d"`, `"2d"`, `"2d_array"`, `"3d"`, `"cube"`, `"cube_array"` | `"2d"` | | sample_type = "..." | `"float"`, `"depth"`, `"s_int"` or `"u_int"` | `"float"` | | filterable = ... | `true`, `false` | `true` | | multisampled = ... | `true`, `false` | `false` | | visibility(...) | `all`, `none`, or a list-combination of `vertex`, `fragment`, `compute` | `vertex`, `fragment` | Example: `#[texture(0, dimension = "2d_array", visibility(vertex, fragment))]` ### `#[sampler(u32, ...)]` Where `...` is an optional list of arguments. | Arguments | Values | Default | |----------- |--------------------------------------------------- | ----------- | | sampler_type = "..." | `"filtering"`, `"non_filtering"`, `"comparison"`. | `"filtering"` | | visibility(...) | `all`, `none`, or a list-combination of `vertex`, `fragment`, `compute` | `vertex`, `fragment` | Example: `#[sampler(0, sampler_type = "filtering", visibility(vertex, fragment)]` ## Changelog - Added more options to `#[texture(...)]` and `#[sampler(...)]` attributes, supporting more kinds of materials. See above for details. - Upgraded IDE and compile-time error messages. - Updated array_texture example using the new options.

bors · 2022-07-19T22:27:58Z

Pull request successfully merged into main.

Build succeeded:

…examples (bevyengine#5364) # Objective - Provide better compile-time errors and diagnostics. - Add more options to allow more textures types and sampler types. - Update array_texture example to use upgraded AsBindGroup derive macro. ## Solution Split out the parsing of the inner struct/field attributes (the inside part of a `#[foo(...)]` attribute) for better clarity Parse the binding index for all inner attributes, as it is part of all attributes (`#[foo(0, ...)`), then allow each attribute implementer to parse the rest of the attribute metadata as needed. This should make it very trivial to extend/change if needed in the future. Replaced invocations of `panic!` with the `syn::Error` type, providing fine-grained errors that retains span information. This provides much nicer compile-time errors, and even better IDE errors. ![image](https://user-images.githubusercontent.com/7478134/179452241-6d85d440-4b67-44da-80a7-9d47e8c88b8a.png) Updated the array_texture example to demonstrate the new changes. ## New AsBindGroup attribute options ### `#[texture(u32, ...)]` Where `...` is an optional list of arguments. | Arguments | Values | Default | |-------------- |---------------------------------------------------------------- | ----------- | | dimension = "..." | `"1d"`, `"2d"`, `"2d_array"`, `"3d"`, `"cube"`, `"cube_array"` | `"2d"` | | sample_type = "..." | `"float"`, `"depth"`, `"s_int"` or `"u_int"` | `"float"` | | filterable = ... | `true`, `false` | `true` | | multisampled = ... | `true`, `false` | `false` | | visibility(...) | `all`, `none`, or a list-combination of `vertex`, `fragment`, `compute` | `vertex`, `fragment` | Example: `#[texture(0, dimension = "2d_array", visibility(vertex, fragment))]` ### `#[sampler(u32, ...)]` Where `...` is an optional list of arguments. | Arguments | Values | Default | |----------- |--------------------------------------------------- | ----------- | | sampler_type = "..." | `"filtering"`, `"non_filtering"`, `"comparison"`. | `"filtering"` | | visibility(...) | `all`, `none`, or a list-combination of `vertex`, `fragment`, `compute` | `vertex`, `fragment` | Example: `#[sampler(0, sampler_type = "filtering", visibility(vertex, fragment)]` ## Changelog - Added more options to `#[texture(...)]` and `#[sampler(...)]` attributes, supporting more kinds of materials. See above for details. - Upgraded IDE and compile-time error messages. - Updated array_texture example using the new options.

# Objective - #5364 Added a few features to the AsBindGroup derive, but if you don't know they exist they aren't documented anywhere. ## Solution - Document the new arguments in the doc block for the derive.

# Objective - bevyengine#5364 Added a few features to the AsBindGroup derive, but if you don't know they exist they aren't documented anywhere. ## Solution - Document the new arguments in the doc block for the derive.

…examples (bevyengine#5364) # Objective - Provide better compile-time errors and diagnostics. - Add more options to allow more textures types and sampler types. - Update array_texture example to use upgraded AsBindGroup derive macro. ## Solution Split out the parsing of the inner struct/field attributes (the inside part of a `#[foo(...)]` attribute) for better clarity Parse the binding index for all inner attributes, as it is part of all attributes (`#[foo(0, ...)`), then allow each attribute implementer to parse the rest of the attribute metadata as needed. This should make it very trivial to extend/change if needed in the future. Replaced invocations of `panic!` with the `syn::Error` type, providing fine-grained errors that retains span information. This provides much nicer compile-time errors, and even better IDE errors. ![image](https://user-images.githubusercontent.com/7478134/179452241-6d85d440-4b67-44da-80a7-9d47e8c88b8a.png) Updated the array_texture example to demonstrate the new changes. ## New AsBindGroup attribute options ### `#[texture(u32, ...)]` Where `...` is an optional list of arguments. | Arguments | Values | Default | |-------------- |---------------------------------------------------------------- | ----------- | | dimension = "..." | `"1d"`, `"2d"`, `"2d_array"`, `"3d"`, `"cube"`, `"cube_array"` | `"2d"` | | sample_type = "..." | `"float"`, `"depth"`, `"s_int"` or `"u_int"` | `"float"` | | filterable = ... | `true`, `false` | `true` | | multisampled = ... | `true`, `false` | `false` | | visibility(...) | `all`, `none`, or a list-combination of `vertex`, `fragment`, `compute` | `vertex`, `fragment` | Example: `#[texture(0, dimension = "2d_array", visibility(vertex, fragment))]` ### `#[sampler(u32, ...)]` Where `...` is an optional list of arguments. | Arguments | Values | Default | |----------- |--------------------------------------------------- | ----------- | | sampler_type = "..." | `"filtering"`, `"non_filtering"`, `"comparison"`. | `"filtering"` | | visibility(...) | `all`, `none`, or a list-combination of `vertex`, `fragment`, `compute` | `vertex`, `fragment` | Example: `#[sampler(0, sampler_type = "filtering", visibility(vertex, fragment)]` ## Changelog - Added more options to `#[texture(...)]` and `#[sampler(...)]` attributes, supporting more kinds of materials. See above for details. - Upgraded IDE and compile-time error messages. - Updated array_texture example using the new options.

# Objective - bevyengine#5364 Added a few features to the AsBindGroup derive, but if you don't know they exist they aren't documented anywhere. ## Solution - Document the new arguments in the doc block for the derive.

wrapperup added 2 commits July 18, 2022 01:20

better errors, support more options via name-value pairs in texture a…

e9a961d

…nd sampler attributes.

update array_texture example to use AsBindGroup derive macro

38fdaf9

IceSentry added A-Rendering Drawing game state to the screen C-Usability A targeted quality-of-life change that makes Bevy easier to use labels Jul 18, 2022

superdump added this to the Bevy 0.8 milestone Jul 18, 2022

superdump reviewed Jul 18, 2022

View reviewed changes

wrapperup added 2 commits July 18, 2022 14:39

run cargo fmt

5ef96c5

remove unused binding constant and imports

57c0e6a

wrapperup added 3 commits July 18, 2022 17:04

organize code, split out parsing, use Parse trait

72d6cb4

support visibility, use ToTokens for attr args instead of quoting in …

8501230

…the main derive

fix wrong symbol name for visibility

042077b

wrapperup marked this pull request as ready for review July 18, 2022 22:49

superdump requested changes Jul 19, 2022

View reviewed changes

proper hygiene for visibility flag, lowercased flags

f65f88d

cart reviewed Jul 19, 2022

View reviewed changes

crates/bevy_render/macros/src/as_bind_group.rs Outdated Show resolved Hide resolved

don't error on non-ident attribute paths

2fadaaf

cart approved these changes Jul 19, 2022

View reviewed changes

bors bot changed the title ~~Derive AsBindGroup Improvements: Better errors, more options, update examples~~ [Merged by Bors] - Derive AsBindGroup Improvements: Better errors, more options, update examples Jul 19, 2022

bors bot closed this Jul 19, 2022

wrapperup deleted the bindgroup-macro-additions branch July 22, 2022 15:36

wrapperup restored the bindgroup-macro-additions branch July 22, 2022 15:36

wrapperup mentioned this pull request Jul 23, 2022

Document new options for AsBindGroup derive #5441

Closed

alice-i-cecile added the A-Diagnostics Logging, crash handling, error reporting and performance analysis label Jul 27, 2022

IceSentry mentioned this pull request Sep 29, 2022

[Merged by Bors] - Support storage buffers in derive AsBindGroup #6129

Closed

IceSentry mentioned this pull request Dec 10, 2022

[Merged by Bors] - Document undocumented features of AsBindGroup derive #6910

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Merged by Bors] - Derive AsBindGroup Improvements: Better errors, more options, update examples #5364

[Merged by Bors] - Derive AsBindGroup Improvements: Better errors, more options, update examples #5364

wrapperup commented Jul 18, 2022 •

edited

Loading

IceSentry commented Jul 18, 2022

wrapperup commented Jul 18, 2022

superdump commented Jul 18, 2022

superdump commented Jul 18, 2022

superdump left a comment

superdump left a comment

superdump commented Jul 18, 2022

superdump commented Jul 18, 2022

superdump commented Jul 18, 2022

wrapperup commented Jul 18, 2022 •

edited

Loading

superdump Jul 19, 2022 •

edited

Loading

wrapperup Jul 19, 2022

superdump Jul 19, 2022

cart Jul 19, 2022

cart Jul 19, 2022

cart Jul 19, 2022

superdump Jul 19, 2022

cart commented Jul 19, 2022

cart left a comment

cart left a comment

cart commented Jul 19, 2022

bors bot commented Jul 19, 2022

[Merged by Bors] - Derive AsBindGroup Improvements: Better errors, more options, update examples #5364

[Merged by Bors] - Derive AsBindGroup Improvements: Better errors, more options, update examples #5364

Conversation

wrapperup commented Jul 18, 2022 • edited Loading

Objective

Solution

New AsBindGroup attribute options

#[texture(u32, ...)]

#[sampler(u32, ...)]

Changelog

IceSentry commented Jul 18, 2022

wrapperup commented Jul 18, 2022

superdump commented Jul 18, 2022

superdump commented Jul 18, 2022

superdump left a comment

Choose a reason for hiding this comment

superdump left a comment

Choose a reason for hiding this comment

superdump commented Jul 18, 2022

superdump commented Jul 18, 2022

superdump commented Jul 18, 2022

wrapperup commented Jul 18, 2022 • edited Loading

superdump Jul 19, 2022 • edited Loading

Choose a reason for hiding this comment

wrapperup Jul 19, 2022

Choose a reason for hiding this comment

superdump Jul 19, 2022

Choose a reason for hiding this comment

cart Jul 19, 2022

Choose a reason for hiding this comment

cart Jul 19, 2022

Choose a reason for hiding this comment

cart Jul 19, 2022

Choose a reason for hiding this comment

superdump Jul 19, 2022

Choose a reason for hiding this comment

cart commented Jul 19, 2022

cart left a comment

Choose a reason for hiding this comment

cart left a comment

Choose a reason for hiding this comment

cart commented Jul 19, 2022

bors bot commented Jul 19, 2022

wrapperup commented Jul 18, 2022 •

edited

Loading

`#[texture(u32, ...)]`

`#[sampler(u32, ...)]`

wrapperup commented Jul 18, 2022 •

edited

Loading

superdump Jul 19, 2022 •

edited

Loading