mirror of
https://github.com/bevyengine/bevy
synced 2024-11-26 06:30:19 +00:00
Rename headless_defaults
example to no_renderer
for clarity (#5263)
# Objective - Reduce confusion as the example opens a window and isn't truly "headless" - Fixes https://github.com/bevyengine/bevy/issues/5260. ## Solution - Rename the example and add to the docs that the window is expected.
This commit is contained in:
parent
6c2f78f449
commit
2344ada89f
4 changed files with 10 additions and 7 deletions
10
Cargo.toml
10
Cargo.toml
|
@ -594,12 +594,12 @@ category = "Application"
|
||||||
wasm = false
|
wasm = false
|
||||||
|
|
||||||
[[example]]
|
[[example]]
|
||||||
name = "headless_defaults"
|
name = "no_renderer"
|
||||||
path = "examples/app/headless_defaults.rs"
|
path = "examples/app/no_renderer.rs"
|
||||||
|
|
||||||
[package.metadata.example.headless_defaults]
|
[package.metadata.example.no_renderer]
|
||||||
name = "Headless with Defaults"
|
name = "No Renderer"
|
||||||
description = "An application that runs with default plugins, but without an actual renderer"
|
description = "An application that runs with default plugins and displays an empty window, but without an actual renderer"
|
||||||
category = "Application"
|
category = "Application"
|
||||||
wasm = false
|
wasm = false
|
||||||
|
|
||||||
|
|
|
@ -143,8 +143,8 @@ Example | Description
|
||||||
[Empty](../examples/app/empty.rs) | An empty application (does nothing)
|
[Empty](../examples/app/empty.rs) | An empty application (does nothing)
|
||||||
[Empty with Defaults](../examples/app/empty_defaults.rs) | An empty application with default plugins
|
[Empty with Defaults](../examples/app/empty_defaults.rs) | An empty application with default plugins
|
||||||
[Headless](../examples/app/headless.rs) | An application that runs without default plugins
|
[Headless](../examples/app/headless.rs) | An application that runs without default plugins
|
||||||
[Headless with Defaults](../examples/app/headless_defaults.rs) | An application that runs with default plugins, but without an actual renderer
|
|
||||||
[Logs](../examples/app/logs.rs) | Illustrate how to use generate log output
|
[Logs](../examples/app/logs.rs) | Illustrate how to use generate log output
|
||||||
|
[No Renderer](../examples/app/no_renderer.rs) | An application that runs with default plugins and displays an empty window, but without an actual renderer
|
||||||
[Plugin](../examples/app/plugin.rs) | Demonstrates the creation and registration of a custom plugin
|
[Plugin](../examples/app/plugin.rs) | Demonstrates the creation and registration of a custom plugin
|
||||||
[Plugin Group](../examples/app/plugin_group.rs) | Demonstrates the creation and registration of a custom plugin group
|
[Plugin Group](../examples/app/plugin_group.rs) | Demonstrates the creation and registration of a custom plugin group
|
||||||
[Return after Run](../examples/app/return_after_run.rs) | Show how to return to main after the Bevy app has exited
|
[Return after Run](../examples/app/return_after_run.rs) | Show how to return to main after the Bevy app has exited
|
||||||
|
|
|
@ -1,5 +1,8 @@
|
||||||
//! An application that runs with default plugins, but without an actual renderer.
|
//! An application that runs with default plugins and displays an empty
|
||||||
|
//! window, but without an actual renderer.
|
||||||
//! This can be very useful for integration tests or CI.
|
//! This can be very useful for integration tests or CI.
|
||||||
|
//!
|
||||||
|
//! See also the `headless` example which does not display a window.
|
||||||
|
|
||||||
use bevy::{prelude::*, render::settings::WgpuSettings};
|
use bevy::{prelude::*, render::settings::WgpuSettings};
|
||||||
|
|
Loading…
Reference in a new issue