assets should be kept on CPU by default (#11212)

mockersf · web-flow · commit 425570aa752b · 2024-01-05T05:53:47.000Z
# Objective - Since #10520, assets are unloaded from RAM by default. This breaks a number of scenario: - using `load_folder` - loading a gltf, then going through its mesh to transform them / compute a collider / ... - any assets/subassets scenario should be `Keep` as you can't know what the user will do with the assets - android suspension, where GPU memory is unloaded - Alternative to #11202 ## Solution - Keep assets on CPU memory by default
diff --git a/crates/bevy_gltf/src/loader.rs b/crates/bevy_gltf/src/loader.rs
@@ -390,7 +390,7 @@ async fn load_gltf<'a, 'b, 'c>(
             let primitive_label = primitive_label(&gltf_mesh, &primitive);
             let primitive_topology = get_primitive_topology(primitive.mode())?;
 
-            let mut mesh = Mesh::new(primitive_topology, RenderAssetPersistencePolicy::Unload);
+            let mut mesh = Mesh::new(primitive_topology, RenderAssetPersistencePolicy::Keep);
 
             // Read vertex attributes
             for (semantic, accessor) in primitive.attributes() {
@@ -434,7 +434,7 @@ async fn load_gltf<'a, 'b, 'c>(
                     let morph_target_image = MorphTargetImage::new(
                         morph_target_reader.map(PrimitiveMorphAttributesIter),
                         mesh.count_vertices(),
-                        RenderAssetPersistencePolicy::Unload,
+                        RenderAssetPersistencePolicy::Keep,
                     )?;
                     let handle =
                         load_context.add_labeled_asset(morph_targets_label, morph_target_image.0);
@@ -726,7 +726,7 @@ async fn load_image<'a, 'b>(
                 supported_compressed_formats,
                 is_srgb,
                 ImageSampler::Descriptor(sampler_descriptor),
-                RenderAssetPersistencePolicy::Unload,
+                RenderAssetPersistencePolicy::Keep,
             )?;
             Ok(ImageOrPath::Image {
                 image,
@@ -748,7 +748,7 @@ async fn load_image<'a, 'b>(
                         supported_compressed_formats,
                         is_srgb,
                         ImageSampler::Descriptor(sampler_descriptor),
-                        RenderAssetPersistencePolicy::Unload,
+                        RenderAssetPersistencePolicy::Keep,
                     )?,
                     label: texture_label(&gltf_texture),
                 })
diff --git a/crates/bevy_render/src/mesh/shape/capsule.rs b/crates/bevy_render/src/mesh/shape/capsule.rs
@@ -369,7 +369,7 @@ impl From<Capsule> for Mesh {
 
         Mesh::new(
             PrimitiveTopology::TriangleList,
-            RenderAssetPersistencePolicy::Unload,
+            RenderAssetPersistencePolicy::Keep,
         )
         .with_inserted_attribute(Mesh::ATTRIBUTE_POSITION, vs)
         .with_inserted_attribute(Mesh::ATTRIBUTE_NORMAL, vns)
diff --git a/crates/bevy_render/src/mesh/shape/cylinder.rs b/crates/bevy_render/src/mesh/shape/cylinder.rs
@@ -123,7 +123,7 @@ impl From<Cylinder> for Mesh {
 
         Mesh::new(
             PrimitiveTopology::TriangleList,
-            RenderAssetPersistencePolicy::Unload,
+            RenderAssetPersistencePolicy::Keep,
         )
         .with_indices(Some(Indices::U32(indices)))
         .with_inserted_attribute(Mesh::ATTRIBUTE_POSITION, positions)
diff --git a/crates/bevy_render/src/mesh/shape/icosphere.rs b/crates/bevy_render/src/mesh/shape/icosphere.rs
@@ -108,7 +108,7 @@ impl TryFrom<Icosphere> for Mesh {
 
         Ok(Mesh::new(
             PrimitiveTopology::TriangleList,
-            RenderAssetPersistencePolicy::Unload,
+            RenderAssetPersistencePolicy::Keep,
         )
         .with_indices(Some(indices))
         .with_inserted_attribute(Mesh::ATTRIBUTE_POSITION, points)
diff --git a/crates/bevy_render/src/mesh/shape/mod.rs b/crates/bevy_render/src/mesh/shape/mod.rs
@@ -124,7 +124,7 @@ impl From<Box> for Mesh {
 
         Mesh::new(
             PrimitiveTopology::TriangleList,
-            RenderAssetPersistencePolicy::Unload,
+            RenderAssetPersistencePolicy::Keep,
         )
         .with_inserted_attribute(Mesh::ATTRIBUTE_POSITION, positions)
         .with_inserted_attribute(Mesh::ATTRIBUTE_NORMAL, normals)
@@ -179,7 +179,7 @@ impl From<Quad> for Mesh {
 
         Mesh::new(
             PrimitiveTopology::TriangleList,
-            RenderAssetPersistencePolicy::Unload,
+            RenderAssetPersistencePolicy::Keep,
         )
         .with_indices(Some(indices))
         .with_inserted_attribute(Mesh::ATTRIBUTE_POSITION, positions)
@@ -263,7 +263,7 @@ impl From<Plane> for Mesh {
 
         Mesh::new(
             PrimitiveTopology::TriangleList,
-            RenderAssetPersistencePolicy::Unload,
+            RenderAssetPersistencePolicy::Keep,
         )
         .with_indices(Some(Indices::U32(indices)))
         .with_inserted_attribute(Mesh::ATTRIBUTE_POSITION, positions)
diff --git a/crates/bevy_render/src/mesh/shape/regular_polygon.rs b/crates/bevy_render/src/mesh/shape/regular_polygon.rs
@@ -60,7 +60,7 @@ impl From<RegularPolygon> for Mesh {
 
         Mesh::new(
             PrimitiveTopology::TriangleList,
-            RenderAssetPersistencePolicy::Unload,
+            RenderAssetPersistencePolicy::Keep,
         )
         .with_inserted_attribute(Mesh::ATTRIBUTE_POSITION, positions)
         .with_inserted_attribute(Mesh::ATTRIBUTE_NORMAL, normals)
diff --git a/crates/bevy_render/src/mesh/shape/torus.rs b/crates/bevy_render/src/mesh/shape/torus.rs
@@ -89,7 +89,7 @@ impl From<Torus> for Mesh {
 
         Mesh::new(
             PrimitiveTopology::TriangleList,
-            RenderAssetPersistencePolicy::Unload,
+            RenderAssetPersistencePolicy::Keep,
         )
         .with_indices(Some(Indices::U32(indices)))
         .with_inserted_attribute(Mesh::ATTRIBUTE_POSITION, positions)
diff --git a/crates/bevy_render/src/mesh/shape/uvsphere.rs b/crates/bevy_render/src/mesh/shape/uvsphere.rs
@@ -85,7 +85,7 @@ impl From<UVSphere> for Mesh {
 
         Mesh::new(
             PrimitiveTopology::TriangleList,
-            RenderAssetPersistencePolicy::Unload,
+            RenderAssetPersistencePolicy::Keep,
         )
         .with_indices(Some(Indices::U32(indices)))
         .with_inserted_attribute(Mesh::ATTRIBUTE_POSITION, vertices)
diff --git a/crates/bevy_render/src/render_asset.rs b/crates/bevy_render/src/render_asset.rs
@@ -55,8 +55,8 @@ pub trait RenderAsset: Asset + Clone {
 /// or only need very infrequent access, then set this to Unload. Otherwise, set this to Keep.
 #[derive(Reflect, Serialize, Deserialize, Clone, Copy, PartialEq, Eq, Default, Debug)]
 pub enum RenderAssetPersistencePolicy {
-    #[default]
     Unload,
+    #[default]
     Keep,
 }
 
diff --git a/crates/bevy_render/src/texture/image.rs b/crates/bevy_render/src/texture/image.rs
@@ -467,7 +467,7 @@ impl Default for Image {
             },
             sampler: ImageSampler::Default,
             texture_view_descriptor: None,
-            cpu_persistent_access: RenderAssetPersistencePolicy::Unload,
+            cpu_persistent_access: RenderAssetPersistencePolicy::Keep,
         }
     }
 }
diff --git a/crates/bevy_render/src/texture/image_loader.rs b/crates/bevy_render/src/texture/image_loader.rs
@@ -67,7 +67,7 @@ impl Default for ImageLoaderSettings {
             format: ImageFormatSetting::default(),
             is_srgb: true,
             sampler: ImageSampler::Default,
-            cpu_persistent_access: RenderAssetPersistencePolicy::Unload,
+            cpu_persistent_access: RenderAssetPersistencePolicy::Keep,
         }
     }
 }
diff --git a/crates/bevy_sprite/src/texture_atlas_builder.rs b/crates/bevy_sprite/src/texture_atlas_builder.rs
@@ -209,7 +209,7 @@ impl TextureAtlasBuilder {
                             self.format.pixel_size() * (current_width * current_height) as usize
                         ],
                         self.format,
-                        RenderAssetPersistencePolicy::Unload,
+                        RenderAssetPersistencePolicy::Keep,
                     );
                     Some(rect_placements)
                 }

Original file line number	Diff line number	Diff line change
`@@ -369,7 +369,7 @@ impl From<Capsule> for Mesh {`
`369`	`369`
`370`	`370`	`Mesh::new(`
`371`	`371`	`PrimitiveTopology::TriangleList,`
`372`		`- RenderAssetPersistencePolicy::Unload,`
	`372`	`+ RenderAssetPersistencePolicy::Keep,`
`373`	`373`	`)`
`374`	`374`	`.with_inserted_attribute(Mesh::ATTRIBUTE_POSITION, vs)`
`375`	`375`	`.with_inserted_attribute(Mesh::ATTRIBUTE_NORMAL, vns)`
Original file line number	Diff line number	Diff line change
`@@ -123,7 +123,7 @@ impl From<Cylinder> for Mesh {`
`123`	`123`
`124`	`124`	`Mesh::new(`
`125`	`125`	`PrimitiveTopology::TriangleList,`
`126`		`- RenderAssetPersistencePolicy::Unload,`
	`126`	`+ RenderAssetPersistencePolicy::Keep,`
`127`	`127`	`)`
`128`	`128`	`.with_indices(Some(Indices::U32(indices)))`
`129`	`129`	`.with_inserted_attribute(Mesh::ATTRIBUTE_POSITION, positions)`
Original file line number	Diff line number	Diff line change
`@@ -108,7 +108,7 @@ impl TryFrom<Icosphere> for Mesh {`
`108`	`108`
`109`	`109`	`Ok(Mesh::new(`
`110`	`110`	`PrimitiveTopology::TriangleList,`
`111`		`- RenderAssetPersistencePolicy::Unload,`
	`111`	`+ RenderAssetPersistencePolicy::Keep,`
`112`	`112`	`)`
`113`	`113`	`.with_indices(Some(indices))`
`114`	`114`	`.with_inserted_attribute(Mesh::ATTRIBUTE_POSITION, points)`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ impl From<RegularPolygon> for Mesh {`
`60`	`60`
`61`	`61`	`Mesh::new(`
`62`	`62`	`PrimitiveTopology::TriangleList,`
`63`		`- RenderAssetPersistencePolicy::Unload,`
	`63`	`+ RenderAssetPersistencePolicy::Keep,`
`64`	`64`	`)`
`65`	`65`	`.with_inserted_attribute(Mesh::ATTRIBUTE_POSITION, positions)`
`66`	`66`	`.with_inserted_attribute(Mesh::ATTRIBUTE_NORMAL, normals)`
Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@ impl From<Torus> for Mesh {`
`89`	`89`
`90`	`90`	`Mesh::new(`
`91`	`91`	`PrimitiveTopology::TriangleList,`
`92`		`- RenderAssetPersistencePolicy::Unload,`
	`92`	`+ RenderAssetPersistencePolicy::Keep,`
`93`	`93`	`)`
`94`	`94`	`.with_indices(Some(Indices::U32(indices)))`
`95`	`95`	`.with_inserted_attribute(Mesh::ATTRIBUTE_POSITION, positions)`
Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ impl From<UVSphere> for Mesh {`
`85`	`85`
`86`	`86`	`Mesh::new(`
`87`	`87`	`PrimitiveTopology::TriangleList,`
`88`		`- RenderAssetPersistencePolicy::Unload,`
	`88`	`+ RenderAssetPersistencePolicy::Keep,`
`89`	`89`	`)`
`90`	`90`	`.with_indices(Some(Indices::U32(indices)))`
`91`	`91`	`.with_inserted_attribute(Mesh::ATTRIBUTE_POSITION, vertices)`
Original file line number	Diff line number	Diff line change
`@@ -55,8 +55,8 @@ pub trait RenderAsset: Asset + Clone {`
`55`	`55`	`/// or only need very infrequent access, then set this to Unload. Otherwise, set this to Keep.`
`56`	`56`	`#[derive(Reflect, Serialize, Deserialize, Clone, Copy, PartialEq, Eq, Default, Debug)]`
`57`	`57`	`pub enum RenderAssetPersistencePolicy {`
`58`		`- #[default]`
`59`	`58`	`Unload,`
	`59`	`+ #[default]`
`60`	`60`	`Keep,`
`61`	`61`	`}`
`62`	`62`
Original file line number	Diff line number	Diff line change
`@@ -467,7 +467,7 @@ impl Default for Image {`
`467`	`467`	`},`
`468`	`468`	`sampler: ImageSampler::Default,`
`469`	`469`	`texture_view_descriptor: None,`
`470`		`- cpu_persistent_access: RenderAssetPersistencePolicy::Unload,`
	`470`	`+ cpu_persistent_access: RenderAssetPersistencePolicy::Keep,`
`471`	`471`	`}`
`472`	`472`	`}`
`473`	`473`	`}`