Skip to content

Commit 2344ada

Browse files
committed
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 #5260. ## Solution - Rename the example and add to the docs that the window is expected.
1 parent 6c2f78f commit 2344ada

File tree

4 files changed

+10
-7
lines changed

4 files changed

+10
-7
lines changed

Cargo.toml

+5-5
Original file line numberDiff line numberDiff line change
@@ -594,12 +594,12 @@ category = "Application"
594594
wasm = false
595595

596596
[[example]]
597-
name = "headless_defaults"
598-
path = "examples/app/headless_defaults.rs"
597+
name = "no_renderer"
598+
path = "examples/app/no_renderer.rs"
599599

600-
[package.metadata.example.headless_defaults]
601-
name = "Headless with Defaults"
602-
description = "An application that runs with default plugins, but without an actual renderer"
600+
[package.metadata.example.no_renderer]
601+
name = "No Renderer"
602+
description = "An application that runs with default plugins and displays an empty window, but without an actual renderer"
603603
category = "Application"
604604
wasm = false
605605

examples/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -143,8 +143,8 @@ Example | Description
143143
[Empty](../examples/app/empty.rs) | An empty application (does nothing)
144144
[Empty with Defaults](../examples/app/empty_defaults.rs) | An empty application with default plugins
145145
[Headless](../examples/app/headless.rs) | An application that runs without default plugins
146-
[Headless with Defaults](../examples/app/headless_defaults.rs) | An application that runs with default plugins, but without an actual renderer
147146
[Logs](../examples/app/logs.rs) | Illustrate how to use generate log output
147+
[No Renderer](../examples/app/no_renderer.rs) | An application that runs with default plugins and displays an empty window, but without an actual renderer
148148
[Plugin](../examples/app/plugin.rs) | Demonstrates the creation and registration of a custom plugin
149149
[Plugin Group](../examples/app/plugin_group.rs) | Demonstrates the creation and registration of a custom plugin group
150150
[Return after Run](../examples/app/return_after_run.rs) | Show how to return to main after the Bevy app has exited

examples/app/headless_defaults.rs renamed to examples/app/no_renderer.rs

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
//! An application that runs with default plugins, but without an actual renderer.
1+
//! An application that runs with default plugins and displays an empty
2+
//! window, but without an actual renderer.
23
//! This can be very useful for integration tests or CI.
4+
//!
5+
//! See also the `headless` example which does not display a window.
36
47
use bevy::{prelude::*, render::settings::WgpuSettings};
58

0 commit comments

Comments
 (0)