Update to 0.14.0 by ChristopherBiscardi · Pull Request #537 · StarArawn/bevy_ecs_tilemap

ChristopherBiscardi · 2024-06-07T06:22:19Z

I started updating to the 0.14 rc release. Each commit has a link to a PR that enacted the change.

12997: rename multi-threaded feature to multi_threaded
12827 RenderAssets<Image> is now RenderAssets<GpuImage>
12732 FloatOrd is now in bevy_math
12889 Gpu Frustum Culling removed the dynamic_offset of Transparent2d
12453 Render Phases are now binned and sorted.
9202 SubApp access has changed from Result to Option
11698 GpuImage now uses UVec2s
12791 the primitive_topology field on GpuMesh was removed.
12216 introduced an argument &mut MeshVertexBufferLayouts to get_mesh_vertex_buffer_layout, which bevy_ecs_tilemap calls in RenderChunk2d::prepare

12163 bevy_color was created and Color handling has changed. Specifically Color::as_linear_rgba_f32 has been removed and we have to go through LinearRgb using .linear().
12582 divided VisibleEntities into separate lists. Specify the entity type we want
9202 changed world access to functions. relevent line
- This also surfaced 12655 which removed Into<AssetId<T>> for Handle<T>. using a reference or .id() is the solution here.
12551 Removed World::cell()... but we don't need it or the replacement anyway.
12582 check_visibility must be implemented for the "renderable" tilemap entities
13289 introduced matrix naming changes for view.view_proj

Current Status

Code compiles. Examples error out with bevyengine/bevy#13728

old history

Once the fix in the above issue is added (the zstd + bevy_pbr features to the dev-dependencies bevy), the examples run but don't render

Basic example is now rendering

* [12997](bevyengine/bevy#12997): rename `multi-threaded` to `multi_threaded`

Implemented in [12827](bevyengine/bevy#12827)

implemented in [12732](bevyengine/bevy#12732)

[12889](bevyengine/bevy#12889) Gpu Frustum Culling removed the dynamic_offset of Transparent2d and it became `extra_index` with the special value `PhaseItemExtraIndex::NONE`, which indicates the `None` that was here previously

[12453](https://github.com/StarArawn/bevy_ecs_tilemap/pull/bevyengine/bevy#12453): Render phases are now binned or sorted. Following the changes in the `mesh2d_manual` [example](https://github.com/bevyengine/bevy/blob/ecdd1624f302c5f71aaed95b0984cbbecf8880b7/examples/2d/mesh2d_manual.rs#L357-L358): use the `ViewSortedRenderPhases` resource.

in [9202](https://github.com/StarArawn/bevy_ecs_tilemap/pull/bevyengine/bevy/pull/9202) SubApp access has changed

[11698](bevyengine/bevy#11698) changed `GpuImage::size` to `UVec2`. Right above this, `Extent3d` does the same thing, so I'm taking a small leap and assuming can `as`.

[12791](bevyengine/bevy#12791) the `primitive_topology` field on `GpuMesh` was removed in favor of `key_bits` which can be constructed using `BaseMeshPipeline::from_primitive_topology`

[12216](bevyengine/bevy#12216) introduced an argument `&mut MeshVertexBufferLayouts` to `get_mesh_vertex_buffer_layout`, which bevy_ecs_tilemap calls in `RenderChunk2d::prepare`

[12163](bevyengine/bevy#12163) bevy_color was created and Color handling has changed. Specifically Color::as_linear_rgba_f32 has been removed. LinearRgba is now its own type that can be accessed via [`linear()`](https://docs.rs/bevy/0.14.0-rc.2/bevy/color/enum.Color.html#method.linear) and then converted.

[12582](bevyengine/bevy#12582) divided `VisibleEntities` into separate lists. So now we have to specify which kind of entity we want. I think we want the Mesh here, and I think we can get rid of the `.index` calls on Entity since Entity [already compares bits](https://docs.rs/bevy_ecs/0.14.0-rc.2/src/bevy_ecs/entity/mod.rs.html#173) for optimized codegen purposes. Waiting to do that until the other changes are in though so as to not change functionality until post-upgrade.

- [9202](bevyengine/bevy#9202) changed world access to functions. [relevent line](https://github.com/bevyengine/bevy/pull/9202/files#diff-b2fba3a0c86e496085ce7f0e3f1de5960cb754c7d215ed0f087aa556e529f97fR640) - This also surfaced [12655](bevyengine/bevy#12655) which removed `Into<AssetId<T>>` for `Handle<T>`. using a reference or .id() is the solution here.

In [12551](bevyengine/bevy#12551) `WorldCell` was removed. ...but it turns out we don't need it or its replacement anyway.

…res being added bevyengine/bevy#13728

ChristopherBiscardi · 2024-06-07T08:35:31Z

Cargo.toml

 [package]
 name = "bevy_ecs_tilemap"
 description = "A tilemap rendering plugin for bevy which is more ECS friendly by having an entity per tile."
-version = "0.12.0"


bevy_ecs_tilemap 13 never released to crates.io, so I moved this to 14 because I think versions track bevy versions?

I think the pattern in recent releases is a coincidence.

I can change the version to anything relevant. It seems like the Bevy project is hoping people will release rc candidates, although I don't know if anyone with publish access has the time for that at the moment for this crate.

I think StarArawn generally handles release prep himself.

rparrett · 2024-06-07T14:22:23Z

I think the current migration for:

12582 divided VisibleEntities into separate lists. Specify the entity type we want

Is part of the problem at the moment. I suspect we need to add our own visibility type and check system: check_visibility::<WithTilemap> or whatever.

But there may be something else going on too.

As a result of [12582](bevyengine/bevy#12582) `check_visibility` must be implemented for the "renderable" tilemap entities. Doing this is trivial by taking advantage of the existing `check_visibility` type arguments, which accept a [`QF: QueryFilter + 'static`](https://docs.rs/bevy/0.14.0-rc.2/bevy/render/view/fn.check_visibility.html). The same `QueryFilter`` is used when checking `VisibleEntities`. I've chosen `With<TilemapRenderSettings` because presumably if the entity doesn't have a `TilemapRenderSettings` then it will not be rendering, but this could be as sophisticated or simple as we want. For example `WithLight` is currently implemented as ```rust pub type WithLight = Or<(With<PointLight>, With<SpotLight>, With<DirectionalLight>)>; ```

[13289](bevyengine/bevy#13489) introduced matrix naming changes, including `view_proj` which becomes `clip_from_world`

ChristopherBiscardi · 2024-06-07T18:49:23Z

@rparrett yeah, it was the check_visibility implementation that needed to be added. I checked a number of examples (but not all yet) and so far every one I've checked has rendered.

basic

3d_iso

ChristopherBiscardi · 2024-06-07T18:51:13Z

I've updated color usage in examples as minimally as possible to make the tests and examples run, but I'd like to come back after this merges to update all of the example's colors to the new palettes and make some of the contrast more readable in a future PR if that's ok.

rparrett · 2024-06-07T18:59:01Z

I'll run through this checklist tonight:

Check all examples on native (macos over here) (cargo-examples is nice)
Check all examples on native (with features=atlas)
Spot check basic, custom_shader, tiled, ldtk with --target=wasm32-unknown-unknown --features=atlas
Spot check basic, custom_shader, tiled, ldtk with --target=wasm32-unknown-unknown --features=bevy/webgpu

edit: Looking good

rparrett · 2024-06-07T19:01:15Z

I'd like to come back after this merges to update all of the example's colors to the new palettes and make some of the contrast more readable in a future PR if that's ok.

That would be nice. They have been in a particularly bad state since Bevy changed the default clear color.

ChristopherBiscardi · 2024-06-07T19:56:56Z

for windows, since you're doing mac later:

Check all examples on native (macos over here) (cargo-examples is nice)
Check all examples on native (with features=atlas)
- crashes on texture_container example, which seems to be the expected behavior as this combination is not supported
Spot check basic, custom_shader, tiled, ldtk with --target=wasm32-unknown-unknown --features=atlas

basic example has an issue in bevy_core_pipeline

error[E0432]: unresolved import `crate::core_3d::DEPTH_TEXTURE_SAMPLING_SUPPORTED`
  --> C:\Users\chris\.cargo\registry\src\index.crates.io-6f17d22bba15001f\bevy_core_pipeline-0.14.0-rc.2\src\dof\mod.rs:59:19
   |
59 |         Camera3d, DEPTH_TEXTURE_SAMPLING_SUPPORTED,
   |                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no `DEPTH_TEXTURE_SAMPLING_SUPPORTED` in `core_3d`
   |
note: found an item that was configured out
  --> C:\Users\chris\.cargo\registry\src\index.crates.io-6f17d22bba15001f\bevy_core_pipeline-0.14.0-rc.2\src\core_3d\mod.rs:53:11
   |
53 | pub const DEPTH_TEXTURE_SAMPLING_SUPPORTED: bool = false;
   |           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
note: found an item that was configured out
  --> C:\Users\chris\.cargo\registry\src\index.crates.io-6f17d22bba15001f\bevy_core_pipeline-0.14.0-rc.2\src\core_3d\mod.rs:63:11
   |
63 | pub const DEPTH_TEXTURE_SAMPLING_SUPPORTED: bool = true;
   |           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Spot check basic, custom_shader, tiled, ldtk with --target=wasm32-unknown-unknown --features=bevy/webgpu

all webgpu examples build. It doesn't look like we have a built-in setup to run them with cargo run so I did not run them.

also cargo-examples is amazing. very useful, thanks for the recommendation.

ChristopherBiscardi · 2024-06-07T20:04:23Z

wasm builds also require bevy/webgl2 because the const is also gated by bevy_core_pipeline/webgl. This was added in 13418

〉cargo build --example custom_shader --target wasm32-unknown-unknown --features=atlas --features=bevy/webgl2

rparrett · 2024-06-07T20:07:39Z

Ah, that's why I suggested adding back webgl2 to dev-dependencies above.

ChristopherBiscardi · 2024-06-07T20:09:30Z

oh you did? I must have missed that (and can't find it either)

Cargo.toml

rparrett · 2024-06-07T18:56:24Z

Cargo.toml

 [package]
 name = "bevy_ecs_tilemap"
 description = "A tilemap rendering plugin for bevy which is more ECS friendly by having an entity per tile."
-version = "0.12.0"


I think the pattern in recent releases is a coincidence.

rparrett · 2024-06-07T20:14:41Z

Oops, I had left my review pending.

Co-authored-by: Rob Parrett <robparrett@gmail.com>

ChristopherBiscardi · 2024-06-07T20:18:54Z

confirmed that fixed the build on my end after committing the review changes

ChristopherBiscardi · 2024-06-07T20:29:25Z

alright, I finished up the last of the clippy fixes too so this should be ready for you when you get to it later. Unless there's an issue I don't think there's anything left to do in this PR.

Cargo.toml

Co-authored-by: Rob Parrett <robparrett@gmail.com>

rparrett

Looks good to me! Awesome work.

See Bevy #12550

rparrett · 2024-06-10T12:50:08Z

Opened ChristopherBiscardi#1 for a minor touchup removing the lint-allow from the ldtk/tiled examples.

Simplify async loading in ldtk/tiled helpers

ChristopherBiscardi · 2024-06-11T03:19:32Z

merged it in. Committed the removal of the second allow lint as well.

ChristopherBiscardi · 2024-06-13T04:33:34Z

Color.linear changes to Color.to_linear when the next rc goes out: Adds back in way to convert color to u8 array, implemented for the two RGB color types, also renames Color::linear to Color::to_linear. bevyengine/bevy#13759

Cargo.toml

ChristopherBiscardi added 13 commits June 6, 2024 21:59

Update to 0.14.0-rc.2

cf3df98

* [12997](bevyengine/bevy#12997): rename `multi-threaded` to `multi_threaded`

RenderAssets<Image> is now RenderAssets<GpuImage>

2bdc9f1

Implemented in [12827](bevyengine/bevy#12827)

FloatOrd is now in bevy_math

a92a680

implemented in [12732](bevyengine/bevy#12732)

convert Transparent2d::dynamic_offset to extra_index

29f5818

[12889](bevyengine/bevy#12889) Gpu Frustum Culling removed the dynamic_offset of Transparent2d and it became `extra_index` with the special value `PhaseItemExtraIndex::NONE`, which indicates the `None` that was here previously

get_sub_app_mut is now an Option

b6fe345

in [9202](https://github.com/StarArawn/bevy_ecs_tilemap/pull/bevyengine/bevy/pull/9202) SubApp access has changed

GpuImage::size f32 -> u32 via UVec2

484e7c7

[11698](bevyengine/bevy#11698) changed `GpuImage::size` to `UVec2`. Right above this, `Extent3d` does the same thing, so I'm taking a small leap and assuming can `as`.

GpuMesh::primitive_topology -> key_bits/BaseMeshPipeline

684be42

[12791](bevyengine/bevy#12791) the `primitive_topology` field on `GpuMesh` was removed in favor of `key_bits` which can be constructed using `BaseMeshPipeline::from_primitive_topology`

RenderChunk2d::prepare requires &mut MeshVertexBufferLayouts now

31e330e

[12216](bevyengine/bevy#12216) introduced an argument `&mut MeshVertexBufferLayouts` to `get_mesh_vertex_buffer_layout`, which bevy_ecs_tilemap calls in `RenderChunk2d::prepare`

We don't need World::cell, and it doesn't exist anymore

b679927

In [12551](bevyengine/bevy#12551) `WorldCell` was removed. ...but it turns out we don't need it or its replacement anyway.

ChristopherBiscardi mentioned this pull request Jun 7, 2024

In 0.14.0-rc.2, minimal app with bevy_core_pipeline crashes without ktx2, zstd, and bevy_pbr bevyengine/bevy#13728

Closed

examples error out unless this bevy bug is addressed with these featu…

1386dc2

…res being added bevyengine/bevy#13728

ChristopherBiscardi commented Jun 7, 2024

View reviewed changes

ChristopherBiscardi marked this pull request as ready for review June 7, 2024 08:37

ChristopherBiscardi changed the title ~~[draft] Update to 0.14.0-rc.2~~ Update to 0.14.0-rc.2 Jun 7, 2024

ChristopherBiscardi added 3 commits June 7, 2024 11:18

view.view_proj -> view.clip_from_world

692d560

[13289](bevyengine/bevy#13489) introduced matrix naming changes, including `view_proj` which becomes `clip_from_world`

color changes to make tests runnable

5a58689

clippy fix

82d74cf

rparrett reviewed Jun 7, 2024

View reviewed changes

ChristopherBiscardi and others added 2 commits June 7, 2024 13:15

Update Cargo.toml

e1a2a55

Co-authored-by: Rob Parrett <robparrett@gmail.com>

Update Cargo.toml

2ba45da

Co-authored-by: Rob Parrett <robparrett@gmail.com>

final clippy fixes

ff87555

rparrett reviewed Jun 7, 2024

View reviewed changes

Cargo.toml Outdated Show resolved Hide resolved

Update Cargo.toml

2d22476

Co-authored-by: Rob Parrett <robparrett@gmail.com>

rparrett approved these changes Jun 7, 2024

View reviewed changes

Simplify async loading in ldtk/tiled helpers

03158fe

See Bevy #12550

ChristopherBiscardi added 2 commits June 10, 2024 20:18

remove second allow lint

d1d6438

Merge pull request #1 from rparrett/bevy-0.14-async-assets

0600b0b

Simplify async loading in ldtk/tiled helpers

rc.3 bump

92fca8f

rparrett mentioned this pull request Jun 23, 2024

0.14 Migration: Consolidate binned render phases changes bevyengine/bevy-website#1386

Closed

bump version for major release

9b26ae5

ChristopherBiscardi changed the title ~~Update to 0.14.0-rc.2~~ Update to 0.14.0 Jul 4, 2024

rparrett reviewed Jul 4, 2024

View reviewed changes

Cargo.toml Outdated Show resolved Hide resolved

remove unused features

ef20700

rparrett merged commit aee4779 into StarArawn:main Jul 5, 2024

Comments

Conversation

ChristopherBiscardi commented Jun 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Current Status

Uh oh!

ChristopherBiscardi Jun 7, 2024

Choose a reason for hiding this comment

Uh oh!

rparrett Jun 7, 2024

Choose a reason for hiding this comment

Uh oh!

ChristopherBiscardi Jun 7, 2024

Choose a reason for hiding this comment

Uh oh!

rparrett Jun 8, 2024

Choose a reason for hiding this comment

Uh oh!

rparrett commented Jun 7, 2024

Uh oh!

ChristopherBiscardi commented Jun 7, 2024

basic

3d_iso

Uh oh!

ChristopherBiscardi commented Jun 7, 2024

Uh oh!

rparrett commented Jun 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rparrett commented Jun 7, 2024

Uh oh!

ChristopherBiscardi commented Jun 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ChristopherBiscardi commented Jun 7, 2024

Uh oh!

rparrett commented Jun 7, 2024

Uh oh!

ChristopherBiscardi commented Jun 7, 2024

Uh oh!

Uh oh!

Uh oh!

rparrett Jun 7, 2024

Choose a reason for hiding this comment

Uh oh!

rparrett commented Jun 7, 2024

Uh oh!

ChristopherBiscardi commented Jun 7, 2024

Uh oh!

ChristopherBiscardi commented Jun 7, 2024

Uh oh!

Uh oh!

rparrett left a comment

Choose a reason for hiding this comment

Uh oh!

rparrett commented Jun 10, 2024

Uh oh!

ChristopherBiscardi commented Jun 11, 2024

Uh oh!

ChristopherBiscardi commented Jun 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ChristopherBiscardi commented Jun 7, 2024 •

edited

Loading

rparrett commented Jun 7, 2024 •

edited

Loading

ChristopherBiscardi commented Jun 7, 2024 •

edited

Loading

ChristopherBiscardi commented Jun 13, 2024 •

edited

Loading