Skip to content

🪄 Synchronize migration guide to 0.14.0-rc.4 #1471

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jun 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions release-content/0.14/migration-guides/13186_Wgpu_020.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Bevy now depends on `wgpu` 0.20, `naga` 0.20, and `naga_oil` 0.14. If you manually specify any of these crates in your `Cargo.toml`, make sure to update their versions to prevent them from being duplicated.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
`CameraOutputMode::Write` now stores a `ClearColorConfig` instead of a `LoadOp<Color>`. Use the following table to convert between the two enums:

|`LoadOp<Color>`|`ClearColorConfig`|
|-|-|
|`Clear(color)`|`Custom(color)`|
|`Load`|`None`|

`ClearColorConfig` has an additional variant, `Default`, which inherits the clear color from the `ClearColor` resource.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
`Mesh::merge()` now takes `&Mesh` instead of `Mesh`. Because of this, you can now share the same `Mesh` across multiple `merge()` calls without cloning it.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
`BackgroundColor` no longer tints the color of images in `ImageBundle` or `ButtonBundle`. Set `UiImage::color` to tint images instead. Furthermore, the new default texture for `UiImage` is now a transparent white square. Use `UiImage::solid_color` to quickly draw debug images. Finally, the default value for `BackgroundColor` and `BorderColor` is now transparent. Set the color to white manually to return to previous behavior.
99 changes: 61 additions & 38 deletions release-content/0.14/migration-guides/_guides.toml
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,16 @@ url = "https://github.com/bevyengine/bevy/pull/11707"
areas = ["Animation"]
file_name = "11707_Rework_animation_to_be_done_in_two_phases.md"

[[guides]]
title = "Implement the `AnimationGraph` to blend animations together"
url = "https://github.com/bevyengine/bevy/pull/11989"
areas = ["Animation"]
file_name = "11989_Implement_the_AnimationGraph_allowing_for_multiple_animati.md"

[[guides]]
title = "Multiplying `LinearRgba` by `f32` no longer ignores alpha channel"
url = "https://github.com/bevyengine/bevy/pull/12575"
areas = ["Animation","Color","Math","Rendering"]
areas = ["Animation", "Color", "Math", "Rendering"]
file_name = "12575_Color_maths_4.md"

[[guides]]
Expand All @@ -49,7 +55,7 @@ file_name = "13080_Deprecate_dynamic_plugins.md"
[[guides]]
title = "Move state initialization methods to `bevy::state`"
url = "https://github.com/bevyengine/bevy/pull/13637"
areas = ["App","ECS"]
areas = ["App", "ECS"]
file_name = "13637_Move_state_installation_methods_from_bevy_app_to_bevy_stat.md"

[[guides]]
Expand Down Expand Up @@ -103,13 +109,13 @@ file_name = "13465_Make_LoadContext_use_the_builder_pattern_for_loading_depen.md
[[guides]]
title = "Use `RenderAssetUsages` to configure gLTF meshes & materials during load"
url = "https://github.com/bevyengine/bevy/pull/12302"
areas = ["Assets","Rendering"]
areas = ["Assets", "Rendering"]
file_name = "12302_Allow_setting_RenderAssetUsages_for_gLTF_meshes__materials.md"

[[guides]]
title = "Consolidate `RenderMaterials` and similar into `RenderAssets`, implement `RenderAsset` for destination type"
url = "https://github.com/bevyengine/bevy/pull/12827"
areas = ["Assets","Rendering"]
areas = ["Assets", "Rendering"]
file_name = "12827_Consolidate_RenderUiMaterials2d_into_RenderAssets.md"

[[guides]]
Expand Down Expand Up @@ -178,12 +184,6 @@ url = "https://github.com/bevyengine/bevy/pull/12311"
areas = ["ECS"]
file_name = "12311_Remove_ComponentStorage_and_associated_types.md"

[[guides]]
title = "Clean up type registrations"
url = "https://github.com/bevyengine/bevy/pull/12314"
areas = ["ECS", "Reflection"]
file_name = "12314_Clean_up_type_registrations.md"

[[guides]]
title = "Don't store `Access<ArchetypeComponentId>` within `QueryState`"
url = "https://github.com/bevyengine/bevy/pull/12474"
Expand Down Expand Up @@ -259,39 +259,33 @@ file_name = "13626_Combine_transition_systems_of_Substates.md"
[[guides]]
title = "Replace `FromWorld` requirement with `FromReflect` on `ReflectResource`"
url = "https://github.com/bevyengine/bevy/pull/12136"
areas = ["ECS","Reflection"]
areas = ["ECS", "Reflection"]
file_name = "12136_Replace_FromWorld_requirement_on_ReflectResource_and_refle.md"

[[guides]]
title = "Make `ReflectComponentFns` and `ReflectBundleFns` methods work with `EntityMut`"
url = "https://github.com/bevyengine/bevy/pull/12895"
areas = ["ECS","Reflection"]
areas = ["ECS", "Reflection"]
file_name = "12895_Make_some_ReflectComponentReflectBundle_methods_work_with_.md"

[[guides]]
title = "Require `TypeRegistry` in `ReflectBundle::insert()`"
url = "https://github.com/bevyengine/bevy/pull/12499"
areas = ["ECS","Reflection"]
areas = ["ECS", "Reflection"]
file_name = "12499_Make_from_reflect_or_world_also_try_ReflectDefault_and_imp.md"

[[guides]]
title = "Rename `multi-threaded` feature to `multi_threaded`"
url = "https://github.com/bevyengine/bevy/pull/12997"
areas = ["ECS","Tasks"]
areas = ["ECS", "Tasks"]
file_name = "12997_multi_threaded_feature_rename.md"

[[guides]]
title = "Moves `intern` and `label` modules from `bevy::utils` to `bevy::ecs`"
url = "https://github.com/bevyengine/bevy/pull/12772"
areas = ["ECS","Utils"]
areas = ["ECS", "Utils"]
file_name = "12772_Moves_intern_and_label_modules_into_bevy_ecs.md"

[[guides]]
title = "Implement the `AnimationGraph` to blend animations together"
url = "https://github.com/bevyengine/bevy/pull/11989"
areas = ["Editor"]
file_name = "11989_Implement_the_AnimationGraph_allowing_for_multiple_animati.md"

[[guides]]
title = "Gizmo line joints"
url = "https://github.com/bevyengine/bevy/pull/12252"
Expand Down Expand Up @@ -331,13 +325,13 @@ file_name = "13660_rename_touchpad_to_gesture_and_add_new_gestures.md"
[[guides]]
title = "Deprecate `ReceivedCharacter`"
url = "https://github.com/bevyengine/bevy/pull/12868"
areas = ["Input","Windowing"]
areas = ["Input", "Windowing"]
file_name = "12868_Deprecate_ReceivedCharacter.md"

[[guides]]
title = "Add `WinitEvent::KeyboardFocusLost`"
url = "https://github.com/bevyengine/bevy/pull/13678"
areas = ["Input","Windowing"]
areas = ["Input", "Windowing"]
file_name = "13678_flush_key_input_cache_when_Bevy_loses_focus_Adopted.md"

[[guides]]
Expand Down Expand Up @@ -391,43 +385,43 @@ file_name = "12757_Update_glam_version_requirement_from_025_to_027.md"
[[guides]]
title = "Common `MeshBuilder` trait"
url = "https://github.com/bevyengine/bevy/pull/13411"
areas = ["Math","Rendering"]
areas = ["Math", "Rendering"]
file_name = "13411_Common_MeshBuilder_trait.md"

[[guides]]
title = "Additional options to mesh primitives"
url = "https://github.com/bevyengine/bevy/pull/13605"
areas = ["Math","Rendering"]
areas = ["Math", "Rendering"]
file_name = "13605_Additional_options_to_mesh_primitives.md"

[[guides]]
title = "Add subdivisions to PlaneMeshBuilder"
url = "https://github.com/bevyengine/bevy/pull/13580"
areas = ["Math","Rendering"]
areas = ["Math", "Rendering"]
file_name = "13580_Add_subdivisions_to_PlaneMeshBuilder.md"

[[guides]]
title = "Make `Transform::rotate_axis` and `Transform::rotate_local_axis` use `Dir3`"
url = "https://github.com/bevyengine/bevy/pull/12986"
areas = ["Math","Transform"]
areas = ["Math", "Transform"]
file_name = "12986_Make_Transformrotate_axis_and_Transformrotate_local_axis_u.md"

[[guides]]
title = "Use `Dir3` for local axis methods in `GlobalTransform`"
url = "https://github.com/bevyengine/bevy/pull/13264"
areas = ["Math","Transform"]
areas = ["Math", "Transform"]
file_name = "13264_Use_Dir3_for_local_axis_methods_in_GlobalTransform.md"

[[guides]]
title = "Fix `Ord` and `PartialOrd` differing for `FloatOrd` and optimize implementation"
url = "https://github.com/bevyengine/bevy/pull/12711"
areas = ["Math","Utils"]
areas = ["Math", "Utils"]
file_name = "12711_Fix_Ord_and_PartialOrd_differing_for_FloatOrd_and_optimize.md"

[[guides]]
title = "Move FloatOrd into bevy_math"
url = "https://github.com/bevyengine/bevy/pull/12732"
areas = ["Math","Utils"]
areas = ["Math", "Utils"]
file_name = "12732_Move_FloatOrd_into_bevy_math.md"

[[guides]]
Expand All @@ -442,6 +436,12 @@ url = "https://github.com/bevyengine/bevy/pull/5781"
areas = ["Reflection"]
file_name = "5781_bevy_reflect_Recursive_registration.md"

[[guides]]
title = "Clean up type registrations"
url = "https://github.com/bevyengine/bevy/pull/12314"
areas = ["Reflection"]
file_name = "12314_Clean_up_type_registrations.md"

[[guides]]
title = "bevy_reflect: Rename `UntypedReflectDeserializer` to `ReflectDeserializer`"
url = "https://github.com/bevyengine/bevy/pull/12721"
Expand All @@ -457,7 +457,7 @@ file_name = "13182_Implement_Reflect_for_ResultT_E_as_enum.md"
[[guides]]
title = "Fix TypeRegistry use in dynamic scene"
url = "https://github.com/bevyengine/bevy/pull/12715"
areas = ["Reflection","Scenes"]
areas = ["Reflection", "Scenes"]
file_name = "12715_Fix_TypeRegistry_use_in_dynamic_scene.md"

[[guides]]
Expand Down Expand Up @@ -676,40 +676,64 @@ url = "https://github.com/bevyengine/bevy/pull/13654"
areas = ["Rendering"]
file_name = "13654_Rename_point_light_to_clusterable_object_in_cluster_contex.md"

[[guides]]
title = "Make `Mesh::merge()` take a reference of `Mesh`"
url = "https://github.com/bevyengine/bevy/pull/13710"
areas = ["Rendering"]
file_name = "13710_Made_Meshmerge_take_a_reference_of_Mesh.md"

[[guides]]
title = "Store `ClearColorConfig` instead of `LoadOp<Color>` in `CameraOutputMode`"
url = "https://github.com/bevyengine/bevy/pull/13419"
areas = ["Rendering"]
file_name = "13419_Allow_mix_of_hdr_and_nonhdr_cameras_to_same_render_target.md"

[[guides]]
title = "`wgpu` 0.20"
url = "https://github.com/bevyengine/bevy/pull/13186"
areas = ["Rendering"]
file_name = "13186_Wgpu_020.md"

[[guides]]
title = "Deprecate `SpriteSheetBundle` and `AtlasImageBundle`"
url = "https://github.com/bevyengine/bevy/pull/12218"
areas = ["Rendering","UI"]
areas = ["Rendering", "UI"]
file_name = "12218_Deprecate_SpriteSheetBundle_and_AtlasImageBundle.md"

[[guides]]
title = "Decouple `BackgroundColor` from `UiImage`"
url = "https://github.com/bevyengine/bevy/pull/11165"
areas = ["Rendering","UI"]
areas = ["Rendering", "UI"]
file_name = "11165_Decouple_BackgroundColor_from_UiImage.md"

[[guides]]
title = "Fix UI elements randomly not appearing after #13277."
url = "https://github.com/bevyengine/bevy/pull/13462"
areas = ["Rendering","UI"]
areas = ["Rendering", "UI"]
file_name = "13462_Fix_UI_elements_randomly_not_appearing_after_13277.md"

[[guides]]
title = "Make default behavior for `BackgroundColor` and `BorderColor` more intuitive"
url = "https://github.com/bevyengine/bevy/pull/14017"
areas = ["Rendering", "UI"]
file_name = "14017_Make_default_behavior_for_BackgroundColor_and_BorderColor_.md"

[[guides]]
title = "FIX12527: Changes to make serde optional for bevy_color"
url = "https://github.com/bevyengine/bevy/pull/12666"
areas = ["Rendering","Utils"]
areas = ["Rendering", "Utils"]
file_name = "12666_FIX12527_Changes_to_make_serde_optional_for_bevy_color.md"

[[guides]]
title = "configure_surface needs to be on the main thread on iOS"
url = "https://github.com/bevyengine/bevy/pull/12055"
areas = ["Rendering","Windowing"]
areas = ["Rendering", "Windowing"]
file_name = "12055_configure_surface_needs_to_be_on_the_main_thread_on_iOS.md"

[[guides]]
title = "Introduce a `WindowWrapper` to extend the lifetime of the window when using pipelined rendering"
url = "https://github.com/bevyengine/bevy/pull/12978"
areas = ["Rendering","Windowing"]
areas = ["Rendering", "Windowing"]
file_name = "12978_Introduce_a_WindowWrapper_to_extend_the_lifetime_of_the_wi.md"

[[guides]]
Expand Down Expand Up @@ -765,4 +789,3 @@ title = "fix: upgrade to winit v0.30"
url = "https://github.com/bevyengine/bevy/pull/13366"
areas = ["Windowing"]
file_name = "13366_fix_upgrade_to_winit_v030.md"