[Merged by Bors] - add globals to mesh view bind group #5409

IceSentry · 2022-07-21T04:33:37Z

Objective

It's often really useful to have access to the time when writing shaders.

Solution

Add a UnifformBuffer in the mesh view bind group
This buffer contains the time, delta time and a wrapping frame count

shader_material_SH7SH4AvgA.mp4

Changelog

Added a GlobalsUniform at position 9 of the mesh view bind group

Notes

The implementation is currently split between bevy_render and bevy_pbr because I was basing my implementation on the ViewPlugin. I'm not sure if that's the right way to structure it.

I named this globals instead of just time because we could potentially add more things to it.

References in other engines

Godot: https://docs.godotengine.org/en/stable/tutorials/shaders/shader_reference/canvas_item_shader.html#global-built-ins
- Global time since startup, in seconds, by default resets to 0 after 3600 seconds
- Doesn't seem to have anything else
Unreal: https://docs.unrealengine.com/4.26/en-US/RenderingAndGraphics/Materials/ExpressionReference/Constant/
- Generic time value that updates every frame. Can be paused or scaled.
- Frame count node, doesn't seem to be an equivalent for shaders: https://docs.unrealengine.com/4.26/en-US/BlueprintAPI/Utilities/GetFrameCount/
Unity: https://docs.unity3d.com/Manual/SL-UnityShaderVariables.html
- time since startup in seconds. No mention of time wrapping. Stored as a vec4(t/20, t, t*2, t*3) where t is the value in seconds
- Also has delta time, sin time and cos time
ShaderToy: https://www.shadertoy.com/howto
- iTime is the time since startup in seconds.
- iFrameRate
- iTimeDelta
- iFrame frame counter

crates/bevy_pbr/src/render/mesh_view_types.wgsl

crates/bevy_render/src/globals.rs

assets/shaders/custom_material.wgsl

crates/bevy_render/src/globals.rs

HackerFoo · 2022-08-07T01:23:56Z

I used this PR for my animated shader: https://youtu.be/BanMIX3_GiU

wilk10 · 2022-08-31T08:48:22Z

I'm very much in favour of this, i know at least Unity offers this out of the box, I would imagine other engines do too, but I haven't checked.

I think the percentage of users that would need this in a shader is higher than the percentage of users that can easily understand how to implement it themselves, since it requires getting to work at a lower level than deriving AsBindGroup for a custom material (and the very few other requirements since 0.8).

On thing I would consider:
How does this interact with the animate_shader example? On one hand it kind of makes it redundant, because extracting time is the aspect of that example that is the most needed by the average user, on the other hand the example shows how to manually set the bind group in a custom draw command, which is the most interesting bit, but for more advanced users.

Maybe the solution is to have a different example that shows setting the bing group for a different functionality, and adapt animate_shader to use the solution from this PR? (I guess only the latter is needed for this PR). Otherwise I think it might be confusing, but I'm not sure what you people think.

IceSentry · 2022-08-31T15:19:23Z

I'll update the animate_shader example soon to reflect the changes and after some quick discussion with @superdump we agreed that we indeed need lower level examples instead of relying on examples showcasing multiple things. These will be added in a separate PR. See #5843

assets/shaders/custom_material.wgsl

IceSentry · 2022-09-12T20:58:13Z

I added the frame count as a wrapping u32. Unfotunately, I can't rely on the FrameTimeDiagnosticsPlugin to be present, since it's not part of DefaultPlugins, so I just used a Local that I increment with wrapping_add(1) in the prepare system

superdump

I'm not sure what I think of the name Globals. I wanted to say GlobalUniforms but then we'd need GlobalUniformsUniform. :)

crates/bevy_pbr/src/render/mesh_view_types.wgsl

crates/bevy_render/src/globals.rs

examples/shader/animate_shader.rs

IceSentry · 2022-09-13T22:45:52Z

I'm not sure what I think of the name Globals. I wanted to say GlobalUniforms but then we'd need GlobalUniformsUniform. :)

Yeah, I was hoping somebody would have proposed a better name. I guess since this is only for time stuff this could just be a TimeUniform. Most engine do seem to treat time as something separate.

mockersf · 2022-09-13T22:53:57Z

something around frame metadata rather than globals?

IceSentry · 2022-09-13T23:00:43Z

The time since startup value isn't really related to the frame though, since it's just the time since startup (or at least, the time since the last wrap period). Godot, unreal and unity all seem to put this under Time.

mockersf · 2022-09-13T23:04:39Z

The time since startup value isn't really related to the frame though

Oh you mean the frame start time 😄

# Objective - Sometimes, like when using shaders, you can only use a time value in `f32`. Unfortunately this suffers from floating precision issues pretty quickly. The standard approach to this problem is to wrap the time after a given period - This is necessary for #5409 ## Solution - Add a `seconds_since_last_wrapping_period` method on `Time` that returns a `f32` that is the `seconds_since_startup` modulo the `max_wrapping_period` --- ## Changelog Added `seconds_since_last_wrapping_period` to `Time` ## Additional info I'm very opened to hearing better names. I don't really like the current naming, I just went with something descriptive. Co-authored-by: Charles <IceSentry@users.noreply.github.com>

IceSentry · 2022-09-24T01:04:15Z

I rebased and used the now merged wrapping time api. This should be ready for a final review pass I think.

wilk10

Thanks a lot for this! This is going to be a huge time saver for users, imo. It's also great to see the animate_shader example be way more accessible.

I have a comment about 2d, that I don't necessarily think has to be addressed in this PR, but maybe it's worth tracking with an issue afterwards..? Not sure what you people think.

wilk10 · 2022-09-27T07:29:00Z

assets/shaders/animate_shader.wgsl

+// The time since startup data is in the globals binding which is part of the mesh_view_bindings import
 #import bevy_pbr::mesh_view_bindings


What about 2d users? They may not depend on bevy_pbr, but it's possible they still want to access the globals binding.

Possible solutions (imo):

make the globals binding available also in bevy_sprite::mesh2d_view_bindings

have an example with sprites that shows importing mesh_view_bindings from bevy_pbr

Good point, I'll address this in a follow up PR. I honestly didn't think of that. I'll probably add the bindings to mesh2d_view_bindings. Although, I wonder if we could have some sort of "core" bindings that are shared between both.

superdump

LGTM. Just one small nit. :)

crates/bevy_render/src/globals.rs

Co-authored-by: Robert Swain <robert.swain@gmail.com>

superdump

bors r+

# Objective - It's often really useful to have access to the time when writing shaders. ## Solution - Add a UnifformBuffer in the mesh view bind group - This buffer contains the time, delta time and a wrapping frame count https://user-images.githubusercontent.com/8348954/180130314-97948c2a-2d11-423d-a9c4-fb5c9d1892c7.mp4 --- ## Changelog - Added a `GlobalsUniform` at position 9 of the mesh view bind group ## Notes The implementation is currently split between bevy_render and bevy_pbr because I was basing my implementation on the `ViewPlugin`. I'm not sure if that's the right way to structure it. I named this `globals` instead of just time because we could potentially add more things to it. ## References in other engines - Godot: <https://docs.godotengine.org/en/stable/tutorials/shaders/shader_reference/canvas_item_shader.html#global-built-ins> - Global time since startup, in seconds, by default resets to 0 after 3600 seconds - Doesn't seem to have anything else - Unreal: <https://docs.unrealengine.com/4.26/en-US/RenderingAndGraphics/Materials/ExpressionReference/Constant/> - Generic time value that updates every frame. Can be paused or scaled. - Frame count node, doesn't seem to be an equivalent for shaders: <https://docs.unrealengine.com/4.26/en-US/BlueprintAPI/Utilities/GetFrameCount/> - Unity: <https://docs.unity3d.com/Manual/SL-UnityShaderVariables.html> - time since startup in seconds. No mention of time wrapping. Stored as a `vec4(t/20, t, t*2, t*3)` where `t` is the value in seconds - Also has delta time, sin time and cos time - ShaderToy: <https://www.shadertoy.com/howto> - iTime is the time since startup in seconds. - iFrameRate - iTimeDelta - iFrame frame counter Co-authored-by: Charles <IceSentry@users.noreply.github.com>

bors · 2022-09-28T04:38:09Z

Pull request successfully merged into main.

Build succeeded:

# Objective - Sometimes, like when using shaders, you can only use a time value in `f32`. Unfortunately this suffers from floating precision issues pretty quickly. The standard approach to this problem is to wrap the time after a given period - This is necessary for bevyengine#5409 ## Solution - Add a `seconds_since_last_wrapping_period` method on `Time` that returns a `f32` that is the `seconds_since_startup` modulo the `max_wrapping_period` --- ## Changelog Added `seconds_since_last_wrapping_period` to `Time` ## Additional info I'm very opened to hearing better names. I don't really like the current naming, I just went with something descriptive. Co-authored-by: Charles <IceSentry@users.noreply.github.com>

# Objective - It's often really useful to have access to the time when writing shaders. ## Solution - Add a UnifformBuffer in the mesh view bind group - This buffer contains the time, delta time and a wrapping frame count https://user-images.githubusercontent.com/8348954/180130314-97948c2a-2d11-423d-a9c4-fb5c9d1892c7.mp4 --- ## Changelog - Added a `GlobalsUniform` at position 9 of the mesh view bind group ## Notes The implementation is currently split between bevy_render and bevy_pbr because I was basing my implementation on the `ViewPlugin`. I'm not sure if that's the right way to structure it. I named this `globals` instead of just time because we could potentially add more things to it. ## References in other engines - Godot: <https://docs.godotengine.org/en/stable/tutorials/shaders/shader_reference/canvas_item_shader.html#global-built-ins> - Global time since startup, in seconds, by default resets to 0 after 3600 seconds - Doesn't seem to have anything else - Unreal: <https://docs.unrealengine.com/4.26/en-US/RenderingAndGraphics/Materials/ExpressionReference/Constant/> - Generic time value that updates every frame. Can be paused or scaled. - Frame count node, doesn't seem to be an equivalent for shaders: <https://docs.unrealengine.com/4.26/en-US/BlueprintAPI/Utilities/GetFrameCount/> - Unity: <https://docs.unity3d.com/Manual/SL-UnityShaderVariables.html> - time since startup in seconds. No mention of time wrapping. Stored as a `vec4(t/20, t, t*2, t*3)` where `t` is the value in seconds - Also has delta time, sin time and cos time - ShaderToy: <https://www.shadertoy.com/howto> - iTime is the time since startup in seconds. - iFrameRate - iTimeDelta - iFrame frame counter Co-authored-by: Charles <IceSentry@users.noreply.github.com>

# Objective - Sometimes, like when using shaders, you can only use a time value in `f32`. Unfortunately this suffers from floating precision issues pretty quickly. The standard approach to this problem is to wrap the time after a given period - This is necessary for bevyengine#5409 ## Solution - Add a `seconds_since_last_wrapping_period` method on `Time` that returns a `f32` that is the `seconds_since_startup` modulo the `max_wrapping_period` --- ## Changelog Added `seconds_since_last_wrapping_period` to `Time` ## Additional info I'm very opened to hearing better names. I don't really like the current naming, I just went with something descriptive. Co-authored-by: Charles <IceSentry@users.noreply.github.com>

# Objective - It's often really useful to have access to the time when writing shaders. ## Solution - Add a UnifformBuffer in the mesh view bind group - This buffer contains the time, delta time and a wrapping frame count https://user-images.githubusercontent.com/8348954/180130314-97948c2a-2d11-423d-a9c4-fb5c9d1892c7.mp4 --- ## Changelog - Added a `GlobalsUniform` at position 9 of the mesh view bind group ## Notes The implementation is currently split between bevy_render and bevy_pbr because I was basing my implementation on the `ViewPlugin`. I'm not sure if that's the right way to structure it. I named this `globals` instead of just time because we could potentially add more things to it. ## References in other engines - Godot: <https://docs.godotengine.org/en/stable/tutorials/shaders/shader_reference/canvas_item_shader.html#global-built-ins> - Global time since startup, in seconds, by default resets to 0 after 3600 seconds - Doesn't seem to have anything else - Unreal: <https://docs.unrealengine.com/4.26/en-US/RenderingAndGraphics/Materials/ExpressionReference/Constant/> - Generic time value that updates every frame. Can be paused or scaled. - Frame count node, doesn't seem to be an equivalent for shaders: <https://docs.unrealengine.com/4.26/en-US/BlueprintAPI/Utilities/GetFrameCount/> - Unity: <https://docs.unity3d.com/Manual/SL-UnityShaderVariables.html> - time since startup in seconds. No mention of time wrapping. Stored as a `vec4(t/20, t, t*2, t*3)` where `t` is the value in seconds - Also has delta time, sin time and cos time - ShaderToy: <https://www.shadertoy.com/howto> - iTime is the time since startup in seconds. - iFrameRate - iTimeDelta - iFrame frame counter Co-authored-by: Charles <IceSentry@users.noreply.github.com>

# Objective - Sometimes, like when using shaders, you can only use a time value in `f32`. Unfortunately this suffers from floating precision issues pretty quickly. The standard approach to this problem is to wrap the time after a given period - This is necessary for bevyengine#5409 ## Solution - Add a `seconds_since_last_wrapping_period` method on `Time` that returns a `f32` that is the `seconds_since_startup` modulo the `max_wrapping_period` --- ## Changelog Added `seconds_since_last_wrapping_period` to `Time` ## Additional info I'm very opened to hearing better names. I don't really like the current naming, I just went with something descriptive. Co-authored-by: Charles <IceSentry@users.noreply.github.com>

# Objective - It's often really useful to have access to the time when writing shaders. ## Solution - Add a UnifformBuffer in the mesh view bind group - This buffer contains the time, delta time and a wrapping frame count https://user-images.githubusercontent.com/8348954/180130314-97948c2a-2d11-423d-a9c4-fb5c9d1892c7.mp4 --- ## Changelog - Added a `GlobalsUniform` at position 9 of the mesh view bind group ## Notes The implementation is currently split between bevy_render and bevy_pbr because I was basing my implementation on the `ViewPlugin`. I'm not sure if that's the right way to structure it. I named this `globals` instead of just time because we could potentially add more things to it. ## References in other engines - Godot: <https://docs.godotengine.org/en/stable/tutorials/shaders/shader_reference/canvas_item_shader.html#global-built-ins> - Global time since startup, in seconds, by default resets to 0 after 3600 seconds - Doesn't seem to have anything else - Unreal: <https://docs.unrealengine.com/4.26/en-US/RenderingAndGraphics/Materials/ExpressionReference/Constant/> - Generic time value that updates every frame. Can be paused or scaled. - Frame count node, doesn't seem to be an equivalent for shaders: <https://docs.unrealengine.com/4.26/en-US/BlueprintAPI/Utilities/GetFrameCount/> - Unity: <https://docs.unity3d.com/Manual/SL-UnityShaderVariables.html> - time since startup in seconds. No mention of time wrapping. Stored as a `vec4(t/20, t, t*2, t*3)` where `t` is the value in seconds - Also has delta time, sin time and cos time - ShaderToy: <https://www.shadertoy.com/howto> - iTime is the time since startup in seconds. - iFrameRate - iTimeDelta - iFrame frame counter Co-authored-by: Charles <IceSentry@users.noreply.github.com>

IceSentry added the A-Rendering Drawing game state to the screen label Jul 21, 2022

superdump reviewed Jul 21, 2022

View reviewed changes

crates/bevy_pbr/src/render/mesh_view_types.wgsl Outdated Show resolved Hide resolved

crates/bevy_render/src/globals.rs Outdated Show resolved Hide resolved

superdump requested changes Jul 26, 2022

View reviewed changes

assets/shaders/custom_material.wgsl Outdated Show resolved Hide resolved

crates/bevy_render/src/globals.rs Show resolved Hide resolved

HackerFoo added a commit to HackerFoo/bevy that referenced this pull request Aug 7, 2022

bevyengine#5409

521a9b7

HackerFoo added a commit to HackerFoo/bevy that referenced this pull request Aug 10, 2022

bevyengine#5409

1769b81

HackerFoo added a commit to HackerFoo/bevy that referenced this pull request Aug 13, 2022

bevyengine#5409

cce9bb9

HackerFoo added a commit to HackerFoo/bevy that referenced this pull request Aug 14, 2022

bevyengine#5409

c6d6874

IceSentry force-pushed the global-binding branch from 6719d22 to 5ec6a7b Compare August 16, 2022 20:42

IceSentry force-pushed the global-binding branch from 5ec6a7b to ab821cb Compare August 31, 2022 15:45

irate-devil approved these changes Sep 3, 2022

View reviewed changes

assets/shaders/custom_material.wgsl Outdated Show resolved Hide resolved

HackerFoo added a commit to HackerFoo/bevy that referenced this pull request Sep 6, 2022

bevyengine#5409

1d9dcde

HackerFoo added a commit to HackerFoo/bevy that referenced this pull request Sep 8, 2022

bevyengine#5409

240a0da

marlyx mentioned this pull request Sep 12, 2022

Add optional shared bind group to custom materials #5962

Closed

IceSentry force-pushed the global-binding branch from 5217250 to 648075a Compare September 12, 2022 20:54

superdump requested changes Sep 13, 2022

View reviewed changes

IceSentry mentioned this pull request Sep 14, 2022

[Merged by Bors] - add time wrapping to Time #5982

Closed

alice-i-cecile added C-Usability A simple quality-of-life change that makes Bevy easier to use A-Time Involves time keeping and reporting labels Sep 14, 2022

add globals value to mesh view bind group

3e1f0ab

IceSentry force-pushed the global-binding branch from b0020e5 to 3e1f0ab Compare September 24, 2022 00:57

wilk10 approved these changes Sep 27, 2022

View reviewed changes

superdump requested changes Sep 27, 2022

View reviewed changes

crates/bevy_render/src/globals.rs Outdated Show resolved Hide resolved

Update crates/bevy_render/src/globals.rs

17c33eb

Co-authored-by: Robert Swain <robert.swain@gmail.com>

superdump approved these changes Sep 28, 2022

View reviewed changes

bors bot changed the title ~~add globals to mesh view bind group~~ [Merged by Bors] - add globals to mesh view bind group Sep 28, 2022

bors bot closed this Sep 28, 2022

IceSentry deleted the global-binding branch September 28, 2022 05:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Merged by Bors] - add globals to mesh view bind group #5409

[Merged by Bors] - add globals to mesh view bind group #5409

IceSentry commented Jul 21, 2022 •

edited

HackerFoo commented Aug 7, 2022

wilk10 commented Aug 31, 2022

IceSentry commented Aug 31, 2022

IceSentry commented Sep 12, 2022

superdump left a comment

IceSentry commented Sep 13, 2022

mockersf commented Sep 13, 2022

IceSentry commented Sep 13, 2022

mockersf commented Sep 13, 2022

IceSentry commented Sep 24, 2022

wilk10 left a comment

wilk10 Sep 27, 2022

IceSentry Sep 27, 2022

superdump left a comment

superdump left a comment

bors bot commented Sep 28, 2022

		// The time since startup data is in the globals binding which is part of the mesh_view_bindings import
		#import bevy_pbr::mesh_view_bindings

[Merged by Bors] - add globals to mesh view bind group #5409

[Merged by Bors] - add globals to mesh view bind group #5409

Conversation

IceSentry commented Jul 21, 2022 • edited

Objective

Solution

Changelog

Notes

References in other engines

HackerFoo commented Aug 7, 2022

wilk10 commented Aug 31, 2022

IceSentry commented Aug 31, 2022

IceSentry commented Sep 12, 2022

superdump left a comment

Choose a reason for hiding this comment

IceSentry commented Sep 13, 2022

mockersf commented Sep 13, 2022

IceSentry commented Sep 13, 2022

mockersf commented Sep 13, 2022

IceSentry commented Sep 24, 2022

wilk10 left a comment

Choose a reason for hiding this comment

wilk10 Sep 27, 2022

Choose a reason for hiding this comment

IceSentry Sep 27, 2022

Choose a reason for hiding this comment

superdump left a comment

Choose a reason for hiding this comment

superdump left a comment

Choose a reason for hiding this comment

bors bot commented Sep 28, 2022

IceSentry commented Jul 21, 2022 •

edited