bevyengine / bevyengine/bevy-website

FullscreenMaterial API Changes example is incorrect in migration guide 0.18 -> 0.19

Open Beginner friendly
#2,531 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
249
Forks
450
Avg merge
16h 20m
Merged PRs (30d)
6

Description

## Describe the issue

The `FullscreenMaterial` API Changes [example](https://bevy.org/learn/migration-guides/0-18-to-0-19/#fullscreenmaterial-api-changes) lists trait functions `run_in`, `run_after`, and `run_before`, which do no appear in the `bevy@0.18` `FullscreenMaterial` trait:

```rust
// 0.18
impl FullscreenMaterial for FullscreenEffect {
fn fragment_shader() -> ShaderRef {
"shaders/fullscreen_effect.wgsl".into()
}
fn run_in() -> impl SystemSet {
Core3dSystems::PostProcess
}
fn run_after() -> Option {
None
}
fn run_before() -> Option {
None
}
}
```

I am not entirely sure where these functions came from, as this feature was first implemented in 0.18, and neither the 0.18 or 0.19 docs reference these functions anywhere, to my knowledge.

## Proposed Solution

Replace the 0.18 section of the example with something like:

```rust
// 0.18
impl FullscreenMaterial for FullscreenEffect {
fn fragment_shader() -> ShaderRef {
"shaders/fullscreen_effect.wgsl".into()
}
fn node_edges() -> Vec {
vec![
Node3d::Tonemapping.intern(),
Self::node_label().intern(),
Node3d::EndMainPassPostProcessing.intern(),
]
}
}
```

Contributor guide

Open the contributing guide

Research direction

Start at the FullscreenMaterial API Changes example in the linked 0.18-to-0.19 migration guide and compare its 0.18 snippet with the 0.18 FullscreenMaterial API described in the issue. Update the example so it uses the documented 0.18 methods, then verify the migration guide renders correctly and no longer lists the incorrect functions.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.