Add `name` to `bevy::window::Window` #7650

VitalyAnkh · 2023-02-13T04:56:31Z

Objective

Fixes Expose .with_class() in WindowDescriptor after new winit release to allow setting window class on X11 and app_id on Wayland. #4188, make users could set application ID for bevy apps.

Solution

Add name field to bevy::window::Window. Specifying this field adds different properties to the window: application ID on Wayland, WM_CLASS on X11, or window class name on Windows. It has no effect on other platforms.

Changelog

Added

Add name to bevy::window::Window.

Migration Guide

Set the bevy_window::Window's name field when needed:

App::new()
        .add_plugins(DefaultPlugins.set(WindowPlugin {
            primary_window: Some(Window {
                title: "I am a window!".into(),
                name: Some("SpaceGameCompany.SpaceShooter".into()),
                ..default()
            }),
            ..default()
        }))
        .run();

crates/bevy_winit/src/winit_windows.rs

crates/bevy_window/src/window.rs

mockersf · 2023-02-23T15:46:11Z

crates/bevy_window/src/window.rs

@@ -191,6 +193,7 @@ impl Default for Window {
    fn default() -> Self {
        Self {
            title: "Bevy App".to_owned(),
+            app_id: "bevy.app".to_owned(),


is it an issue if several apps running at the same time have the same app_id? Would it be better as an option, and only set it when the user actually put a value?

drive-by comment: It's not semantically invalid, but it's not useful to have a bunch of unrelated programs with the same app_id. So I'd say that it should be an Option.

I made this an Option<String> type and None by default now.

mockersf · 2023-02-23T15:49:52Z

crates/bevy_winit/src/winit_windows.rs

+            winit_window_builder = winit::platform::wayland::WindowBuilderExtWayland::with_name(
+                winit_window_builder,
+                window.app_id.clone(),
+                "",


this value should be explained

mockersf · 2023-02-23T15:49:57Z

crates/bevy_winit/src/winit_windows.rs

+            winit_window_builder = winit::platform::x11::WindowBuilderExtX11::with_name(
+                winit_window_builder,
+                window.app_id.clone(),
+                "",


this value should be explained

Should the docs on the field be already enough?

crates/bevy_window/src/window.rs

mockersf · 2023-02-23T16:16:44Z

is it an issue to have both x11 and wayland features enabled, and have both methods called?

deifactor · 2023-02-25T02:04:25Z

is it an issue to have both x11 and wayland features enabled, and have both methods called?

From looking at the winit code, no: both of them set platform_specific.name in the same way.

VitalyAnkh · 2024-01-31T11:44:51Z

I'm very sorry for such a long delay! After almost a year, I finally remembered this PR. I've rebased it onto the latest bevy and updated some documentation. The concept of application ID or wm_class is only applicable to UNIX platforms, and currently, winit does not provide a way to modify it after the app has started. This feature is quite for many window managers to manage windows. Please review the current code again, thank you very much!

musjj · 2024-01-31T12:01:56Z

The concept of application ID or wm_class is only applicable to UNIX platforms

The equivalent of this on Windows is window class names, which winit also supports:

with_class_name

VitalyAnkh · 2024-01-31T12:09:38Z

@musjj Thanks! Didn't find this before. I will update this patch ASAP.

crates/bevy_window/src/window.rs

Co-authored-by: François <mockersf@gmail.com>

mockersf

unable to test, but code looks good

crates/bevy_winit/src/winit_windows.rs

atornity · 2024-02-04T14:27:41Z

crates/bevy_window/src/window.rs

+    /// - **`macOS`**, **`iOS`**, **`Android`**, and **`Web`**: not applicable.
+    ///
+    /// Notes: Changing this field during runtime will have no effect for now.
+    pub name: Option<String>,


Could this be a &'static str instead? Given that it's not supposed to be changed?

Sure! Done in the following commit.

Oh it failed to build after turning the type of name into Option<&'static str>:

error: implementation of `cursor::_::_serde::Deserialize` is not general enough --> crates/bevy_window/src/window.rs:121:35 | 121 | #[derive(Component, Debug, Clone, Reflect)] | ^^^^^^^ implementation of `cursor::_::_serde::Deserialize` is not general enough | = note: `window::Window` must implement `cursor::_::_serde::Deserialize<'0>`, for any lifetime `'0`... = note: ...but it actually implements `cursor::_::_serde::Deserialize<'static>` = note: this error originates in the derive macro `Reflect` (in Nightly builds, run with -Z macro-backtrace for more info) error: could not compile `bevy_window` (lib) due to previous error

How to #[derive(Reflect)] a type with a component whose type is Option<&'static str>? 🤔

bevy_reflect supports type with 'static lifetimes, but the situation here seems more complex. Reverted it because I'm not familiar with the mechanism of bevy_reflect. Maybe add this optimization later.

oh I see, no worries. It seems like Reflect was implemented for &'static str in #11686 so it's a bit strange that it still won't work.

This reverts commit 45eebc1.

# Objective - Fixes bevyengine#4188, make users could set application ID for bevy apps. ## Solution - Add `name` field to `bevy::window::Window`. Specifying this field adds different properties to the window: application ID on `Wayland`, `WM_CLASS` on `X11`, or window class name on Windows. It has no effect on other platforms. --- ## Changelog ### Added - Add `name` to `bevy::window::Window`. ## Migration Guide - Set the `bevy_window::Window`'s `name` field when needed: ```rust App::new() .add_plugins(DefaultPlugins.set(WindowPlugin { primary_window: Some(Window { title: "I am a window!".into(), name: Some("SpaceGameCompany.SpaceShooter".into()), ..default() }), ..default() })) .run(); ``` --------- Co-authored-by: François <mockersf@gmail.com>

VitalyAnkh force-pushed the add_wm_class branch 2 times, most recently from 8569e8a to 80d04b6 Compare February 13, 2023 05:03

VitalyAnkh added O-Linux Specific to the Linux desktop operating system A-Windowing Platform-agnostic interface layer to run your app in labels Feb 13, 2023

VitalyAnkh requested a review from mockersf February 23, 2023 09:04

Aceeri suggested changes Feb 23, 2023

View reviewed changes

crates/bevy_winit/src/winit_windows.rs Outdated Show resolved Hide resolved

Aceeri approved these changes Feb 23, 2023

View reviewed changes

mockersf requested changes Feb 23, 2023

View reviewed changes

mockersf reviewed Feb 23, 2023

View reviewed changes

crates/bevy_window/src/window.rs Outdated Show resolved Hide resolved

james7132 added the M-Needs-Migration-Guide A breaking change to Bevy's public API that needs to be noted in a migration guide label Mar 5, 2023

james7132 added this to the 0.11 milestone Mar 5, 2023

VitalyAnkh force-pushed the add_wm_class branch from fbc96f2 to 8ddc712 Compare May 31, 2023 03:44

mockersf removed this from the 0.11 milestone Jun 29, 2023

VitalyAnkh force-pushed the add_wm_class branch from 8ddc712 to 8e7f1e3 Compare July 12, 2023 03:21

VitalyAnkh added 6 commits January 31, 2024 18:17

add app_id to bevy_window::Window

437b91c

fix conditional compilation

beeb367

add target_os, update window_settings example

38e9074

fix mistake

cddd3d7

fix naming

b4285a2

rebase, add docs, use the type Option<String> for app_id

c7fc907

VitalyAnkh force-pushed the add_wm_class branch from 8e7f1e3 to c7fc907 Compare January 31, 2024 11:33

refine docs

33b000a

fix macos ci

7a630c8

VitalyAnkh requested review from deifactor and Aceeri January 31, 2024 11:51

fix spelling

2ccb717

mockersf reviewed Jan 31, 2024

View reviewed changes

crates/bevy_window/src/window.rs Outdated Show resolved Hide resolved

mockersf reviewed Jan 31, 2024

View reviewed changes

crates/bevy_window/src/window.rs Outdated Show resolved Hide resolved

mockersf reviewed Jan 31, 2024

View reviewed changes

crates/bevy_window/src/window.rs Outdated Show resolved Hide resolved

VitalyAnkh and others added 3 commits January 31, 2024 23:26

Update crates/bevy_window/src/window.rs

92eab34

Co-authored-by: François <mockersf@gmail.com>

Update crates/bevy_window/src/window.rs

f252828

Co-authored-by: François <mockersf@gmail.com>

rename to name

af7f9f1

VitalyAnkh changed the title ~~Add app_id to bevy::window::Window~~ Add name to bevy::window::Window Jan 31, 2024

VitalyAnkh requested a review from mockersf January 31, 2024 16:57

mockersf approved these changes Jan 31, 2024

View reviewed changes

VitalyAnkh added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Feb 1, 2024

VitalyAnkh removed the request for review from deifactor February 2, 2024 16:18

NthTensor approved these changes Feb 4, 2024

View reviewed changes

AlexAegis reviewed Feb 4, 2024

View reviewed changes

crates/bevy_winit/src/winit_windows.rs Outdated Show resolved Hide resolved

atornity approved these changes Feb 4, 2024

View reviewed changes

VitalyAnkh added 2 commits February 5, 2024 00:28

Merge branch 'main' into add_wm_class

cc4c347

Use type Option<&'static str> for name

45eebc1

matiqo15 approved these changes Feb 4, 2024

View reviewed changes

VitalyAnkh added 5 commits February 5, 2024 01:29

Revert "Use type Option<&'static str> for name"

8ed2e6a

This reverts commit 45eebc1.

use if let

1e30d32

make conditional compilation and unused variable warning live together

4fd709d

add cfg for conditional compilation

ea0ee3b

Merge branch 'main' into add_wm_class

5745c61

alice-i-cecile mentioned this pull request Feb 5, 2024

Use a &'static str inside of Window::name #11718

Closed

alice-i-cecile added this pull request to the merge queue Feb 5, 2024

Merged via the queue into bevyengine:main with commit 7705c1d Feb 5, 2024
23 checks passed

mockersf mentioned this pull request Feb 27, 2024

Allow linux users manipulate wm_class and wm_instance of windows #4609

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `name` to `bevy::window::Window` #7650

Add `name` to `bevy::window::Window` #7650

VitalyAnkh commented Feb 13, 2023 •

edited

Loading

mockersf Feb 23, 2023

deifactor Feb 25, 2023

VitalyAnkh Jan 31, 2024

mockersf Feb 23, 2023

mockersf Feb 23, 2023

VitalyAnkh Jan 31, 2024

mockersf commented Feb 23, 2023

deifactor commented Feb 25, 2023

VitalyAnkh commented Jan 31, 2024

musjj commented Jan 31, 2024

VitalyAnkh commented Jan 31, 2024 •

edited

Loading

mockersf left a comment

atornity Feb 4, 2024

VitalyAnkh Feb 4, 2024

VitalyAnkh Feb 4, 2024

VitalyAnkh Feb 4, 2024

atornity Feb 4, 2024

Add name to bevy::window::Window #7650

Add name to bevy::window::Window #7650

Conversation

VitalyAnkh commented Feb 13, 2023 • edited Loading

Objective

Solution

Changelog

Added

Migration Guide

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mockersf commented Feb 23, 2023

deifactor commented Feb 25, 2023

VitalyAnkh commented Jan 31, 2024

musjj commented Jan 31, 2024

VitalyAnkh commented Jan 31, 2024 • edited Loading

mockersf left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Add `name` to `bevy::window::Window` #7650

Add `name` to `bevy::window::Window` #7650

VitalyAnkh commented Feb 13, 2023 •

edited

Loading

VitalyAnkh commented Jan 31, 2024 •

edited

Loading