mirror of
https://github.com/bevyengine/bevy
synced 2024-11-10 07:04:33 +00:00
afbbbd7335
# Objective The names of numerous rendering components in Bevy are inconsistent and a bit confusing. Relevant names include: - `AutoExposureSettings` - `AutoExposureSettingsUniform` - `BloomSettings` - `BloomUniform` (no `Settings`) - `BloomPrefilterSettings` - `ChromaticAberration` (no `Settings`) - `ContrastAdaptiveSharpeningSettings` - `DepthOfFieldSettings` - `DepthOfFieldUniform` (no `Settings`) - `FogSettings` - `SmaaSettings`, `Fxaa`, `TemporalAntiAliasSettings` (really inconsistent??) - `ScreenSpaceAmbientOcclusionSettings` - `ScreenSpaceReflectionsSettings` - `VolumetricFogSettings` Firstly, there's a lot of inconsistency between `Foo`/`FooSettings` and `FooUniform`/`FooSettingsUniform` and whether names are abbreviated or not. Secondly, the `Settings` post-fix seems unnecessary and a bit confusing semantically, since it makes it seem like the component is mostly just auxiliary configuration instead of the core *thing* that actually enables the feature. This will be an even bigger problem once bundles like `TemporalAntiAliasBundle` are deprecated in favor of required components, as users will expect a component named `TemporalAntiAlias` (or similar), not `TemporalAntiAliasSettings`. ## Solution Drop the `Settings` post-fix from the component names, and change some names to be more consistent. - `AutoExposure` - `AutoExposureUniform` - `Bloom` - `BloomUniform` - `BloomPrefilter` - `ChromaticAberration` - `ContrastAdaptiveSharpening` - `DepthOfField` - `DepthOfFieldUniform` - `DistanceFog` - `Smaa`, `Fxaa`, `TemporalAntiAliasing` (note: we might want to change to `Taa`, see "Discussion") - `ScreenSpaceAmbientOcclusion` - `ScreenSpaceReflections` - `VolumetricFog` I kept the old names as deprecated type aliases to make migration a bit less painful for users. We should remove them after the next release. (And let me know if I should just... not add them at all) I also added some very basic docs for a few types where they were missing, like on `Fxaa` and `DepthOfField`. ## Discussion - `TemporalAntiAliasing` is still inconsistent with `Smaa` and `Fxaa`. Consensus [on Discord](https://discord.com/channels/691052431525675048/743663924229963868/1280601167209955431) seemed to be that renaming to `Taa` would probably be fine, but I think it's a bit more controversial, and it would've required renaming a lot of related types like `TemporalAntiAliasNode`, `TemporalAntiAliasBundle`, and `TemporalAntiAliasPlugin`, so I think it's better to leave to a follow-up. - I think `Fog` should probably have a more specific name like `DistanceFog` considering it seems to be distinct from `VolumetricFog`. ~~This should probably be done in a follow-up though, so I just removed the `Settings` post-fix for now.~~ (done) --- ## Migration Guide Many rendering components have been renamed for improved consistency and clarity. - `AutoExposureSettings` → `AutoExposure` - `BloomSettings` → `Bloom` - `BloomPrefilterSettings` → `BloomPrefilter` - `ContrastAdaptiveSharpeningSettings` → `ContrastAdaptiveSharpening` - `DepthOfFieldSettings` → `DepthOfField` - `FogSettings` → `DistanceFog` - `SmaaSettings` → `Smaa` - `TemporalAntiAliasSettings` → `TemporalAntiAliasing` - `ScreenSpaceAmbientOcclusionSettings` → `ScreenSpaceAmbientOcclusion` - `ScreenSpaceReflectionsSettings` → `ScreenSpaceReflections` - `VolumetricFogSettings` → `VolumetricFog` --------- Co-authored-by: Carter Anderson <mcanders1@gmail.com> |
||
|---|---|---|
| .. | ||
| 3d_scene.rs | ||
| 3d_shapes.rs | ||
| 3d_viewport_to_world.rs | ||
| animated_material.rs | ||
| anisotropy.rs | ||
| anti_aliasing.rs | ||
| atmospheric_fog.rs | ||
| auto_exposure.rs | ||
| blend_modes.rs | ||
| bloom_3d.rs | ||
| clearcoat.rs | ||
| color_grading.rs | ||
| deferred_rendering.rs | ||
| depth_of_field.rs | ||
| fog.rs | ||
| fog_volumes.rs | ||
| generate_custom_mesh.rs | ||
| irradiance_volumes.rs | ||
| lighting.rs | ||
| lightmaps.rs | ||
| lines.rs | ||
| load_gltf.rs | ||
| load_gltf_extras.rs | ||
| meshlet.rs | ||
| motion_blur.rs | ||
| orthographic.rs | ||
| parallax_mapping.rs | ||
| parenting.rs | ||
| pbr.rs | ||
| post_processing.rs | ||
| reflection_probes.rs | ||
| render_to_texture.rs | ||
| rotate_environment_map.rs | ||
| scrolling_fog.rs | ||
| shadow_biases.rs | ||
| shadow_caster_receiver.rs | ||
| skybox.rs | ||
| spherical_area_lights.rs | ||
| split_screen.rs | ||
| spotlight.rs | ||
| ssao.rs | ||
| ssr.rs | ||
| texture.rs | ||
| tonemapping.rs | ||
| transmission.rs | ||
| transparency_3d.rs | ||
| two_passes.rs | ||
| update_gltf_scene.rs | ||
| vertex_colors.rs | ||
| visibility_range.rs | ||
| volumetric_fog.rs | ||
| wireframe.rs | ||