Struct bevy_internal::window::prelude::Window

pub struct Window {

    pub cursor: Cursor,
    pub present_mode: PresentMode,
    pub mode: WindowMode,
    pub position: WindowPosition,
    pub resolution: WindowResolution,
    pub title: String,
    pub name: Option<String>,
    pub composite_alpha_mode: CompositeAlphaMode,
    pub resize_constraints: WindowResizeConstraints,
    pub resizable: bool,
    pub enabled_buttons: EnabledButtons,
    pub decorations: bool,
    pub transparent: bool,
    pub focused: bool,
    pub window_level: WindowLevel,
    pub canvas: Option<String>,
    pub prevent_default_event_handling: bool,
    pub internal: InternalWindowState,
    pub ime_enabled: bool,
    pub ime_position: Vec2,
    pub window_theme: Option<WindowTheme>,
    pub visible: bool,
}

The defining Component for window entities, storing information about how it should appear and behave.

Each window corresponds to an entity, and is uniquely identified by the value of their Entity. When the Window component is added to an entity, a new window will be opened. When it is removed or the entity is despawned, the window will close.

The primary window entity (and the corresponding window) is spawned by default by WindowPlugin and is marked with the PrimaryWindow component.

This component is synchronized with winit through bevy_winit: it will reflect the current state of the window and can be modified to change this state.

Example

Because this component is synchronized with winit, it can be used to perform OS-integrated windowing operations. For example, here’s a simple system to change the cursor type:

fn change_cursor(mut windows: Query<&mut Window, With<PrimaryWindow>>) {
    // Query returns one window typically.
    for mut window in windows.iter_mut() {
        window.cursor.icon = CursorIcon::Wait;
    }
}

Fields

cursor: Cursor

The cursor of this window.

present_mode: PresentMode

What presentation mode to give the window.

mode: WindowMode

Which fullscreen or windowing mode should be used.

position: WindowPosition

Where the window should be placed.

resolution: WindowResolution

What resolution the window should have.

title: String

Stores the title of the window.

name: Option<String>

Stores the application ID (on Wayland), WM_CLASS (on X11) or window class name (on Windows) of the window.

For details about application ID conventions, see the Desktop Entry Spec. For details about WM_CLASS, see the X11 Manual Pages. For details about Windows’s window class names, see About Window Classes.

Platform-specific

• Windows: Can only be set while building the window, setting the window’s window class name.
• Wayland: Can only be set while building the window, setting the window’s application ID.
• X11: Can only be set while building the window, setting the window’s WM_CLASS.
• macOS, iOS, Android, and Web: not applicable.

Notes: Changing this field during runtime will have no effect for now.

composite_alpha_mode: CompositeAlphaMode

How the alpha channel of textures should be handled while compositing.

resize_constraints: WindowResizeConstraints

The limits of the window’s logical size (found in its resolution) when resizing.

resizable: bool

Should the window be resizable?

Note: This does not stop the program from fullscreening/setting the size programmatically.

enabled_buttons: EnabledButtons

Specifies which window control buttons should be enabled.

Platform-specific

iOS, Android, and the Web do not have window control buttons.

On some Linux environments these values have no effect.

decorations: bool

Should the window have decorations enabled?

(Decorations are the minimize, maximize, and close buttons on desktop apps)

Platform-specific

iOS, Android, and the Web do not have decorations.

transparent: bool

Should the window be transparent?

Defines whether the background of the window should be transparent.

Platform-specific

• iOS / Android / Web: Unsupported.
• macOS: Not working as expected.

macOS transparent works with winit out of the box, so this issue might be related to: https://github.com/gfx-rs/wgpu/issues/687. You should also set the window composite_alpha_mode to CompositeAlphaMode::PostMultiplied.

focused: bool

Get/set whether the window is focused.

window_level: WindowLevel

Where should the window appear relative to other overlapping window.

Platform-specific

• iOS / Android / Web / Wayland: Unsupported.

canvas: Option<String>

The “html canvas” element selector.

If set, this selector will be used to find a matching html canvas element, rather than creating a new one. Uses the CSS selector format.

This value has no effect on non-web platforms.

prevent_default_event_handling: bool

Whether or not to stop events from propagating out of the canvas element

When true, this will prevent common browser hotkeys like F5, F12, Ctrl+R, tab, etc. from performing their default behavior while the bevy app has focus.

This value has no effect on non-web platforms.

internal: InternalWindowState

Stores internal state that isn’t directly accessible.

ime_enabled: bool

Should the window use Input Method Editor?

If enabled, the window will receive Ime events instead of ReceivedCharacter or KeyboardInput.

IME should be enabled during text input, but not when you expect to get the exact key pressed.

Platform-specific

• iOS / Android / Web: Unsupported.

ime_position: Vec2

Sets location of IME candidate box in client area coordinates relative to the top left.

Platform-specific

• iOS / Android / Web: Unsupported.

window_theme: Option<WindowTheme>

Sets a specific theme for the window.

If None is provided, the window will use the system theme.

Platform-specific

• iOS / Android / Web: Unsupported.

visible: bool

Sets the window’s visibility.

If false, this will hide the window the window completely, it won’t appear on the screen or in the task bar. If true, this will show the window. Note that this doesn’t change its focused or minimized state.

Platform-specific

• Android / Wayland / Web: Unsupported.

Implementations

impl Window

pub fn set_maximized(&mut self, maximized: bool)

Setting to true will attempt to maximize the window.

Setting to false will attempt to un-maximize the window.

pub fn set_minimized(&mut self, minimized: bool)

Setting to true will attempt to minimize the window.

Setting to false will attempt to un-minimize the window.

pub fn width(&self) -> f32

The window’s client area width in logical pixels.

See WindowResolution for an explanation about logical/physical sizes.

pub fn height(&self) -> f32

The window’s client area height in logical pixels.

See WindowResolution for an explanation about logical/physical sizes.

pub fn physical_width(&self) -> u32

The window’s client area width in physical pixels.

See WindowResolution for an explanation about logical/physical sizes.

pub fn physical_height(&self) -> u32

The window’s client area height in physical pixels.

See WindowResolution for an explanation about logical/physical sizes.

pub fn scale_factor(&self) -> f32

The window’s scale factor.

Ratio of physical size to logical size, see WindowResolution.

pub fn cursor_position(&self) -> Option<Vec2>

The cursor position in this window in logical pixels.

Returns None if the cursor is outside the window area.

See WindowResolution for an explanation about logical/physical sizes.

pub fn physical_cursor_position(&self) -> Option<Vec2>

The cursor position in this window in physical pixels.

Returns None if the cursor is outside the window area.

See WindowResolution for an explanation about logical/physical sizes.

pub fn set_cursor_position(&mut self, position: Option<Vec2>)

Set the cursor position in this window in logical pixels.

See WindowResolution for an explanation about logical/physical sizes.

pub fn set_physical_cursor_position(&mut self, position: Option<DVec2>)

Set the cursor position in this window in physical pixels.

See WindowResolution for an explanation about logical/physical sizes.

Trait Implementations

impl Clone for Window

fn clone(&self) -> Window

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for Window

where Window: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either TableStorage or SparseStorage.

impl Debug for Window

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Window

fn default() -> Window

Returns the “default value” for a type.

impl FromReflect for Window

where Window: Any + Send + Sync, Cursor: FromReflect + TypePath, PresentMode: FromReflect + TypePath, WindowMode: FromReflect + TypePath, WindowPosition: FromReflect + TypePath, WindowResolution: FromReflect + TypePath, String: FromReflect + TypePath, Option<String>: FromReflect + TypePath, CompositeAlphaMode: FromReflect + TypePath, WindowResizeConstraints: FromReflect + TypePath, bool: FromReflect + TypePath, EnabledButtons: FromReflect + TypePath, WindowLevel: FromReflect + TypePath, InternalWindowState: FromReflect + TypePath, Vec2: FromReflect + TypePath, Option<WindowTheme>: FromReflect + TypePath,

fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<Window>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for Window

where Window: Any + Send + Sync, Cursor: FromReflect + TypePath, PresentMode: FromReflect + TypePath, WindowMode: FromReflect + TypePath, WindowPosition: FromReflect + TypePath, WindowResolution: FromReflect + TypePath, String: FromReflect + TypePath, Option<String>: FromReflect + TypePath, CompositeAlphaMode: FromReflect + TypePath, WindowResizeConstraints: FromReflect + TypePath, bool: FromReflect + TypePath, EnabledButtons: FromReflect + TypePath, WindowLevel: FromReflect + TypePath, InternalWindowState: FromReflect + TypePath, Vec2: FromReflect + TypePath, Option<WindowTheme>: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Reflect for Window

where Window: Any + Send + Sync, Cursor: FromReflect + TypePath, PresentMode: FromReflect + TypePath, WindowMode: FromReflect + TypePath, WindowPosition: FromReflect + TypePath, WindowResolution: FromReflect + TypePath, String: FromReflect + TypePath, Option<String>: FromReflect + TypePath, CompositeAlphaMode: FromReflect + TypePath, WindowResizeConstraints: FromReflect + TypePath, bool: FromReflect + TypePath, EnabledButtons: FromReflect + TypePath, WindowLevel: FromReflect + TypePath, InternalWindowState: FromReflect + TypePath, Vec2: FromReflect + TypePath, Option<WindowTheme>: FromReflect + TypePath,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<Window>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Window>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Window>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Struct for Window

where Window: Any + Send + Sync, Cursor: FromReflect + TypePath, PresentMode: FromReflect + TypePath, WindowMode: FromReflect + TypePath, WindowPosition: FromReflect + TypePath, WindowResolution: FromReflect + TypePath, String: FromReflect + TypePath, Option<String>: FromReflect + TypePath, CompositeAlphaMode: FromReflect + TypePath, WindowResizeConstraints: FromReflect + TypePath, bool: FromReflect + TypePath, EnabledButtons: FromReflect + TypePath, WindowLevel: FromReflect + TypePath, InternalWindowState: FromReflect + TypePath, Vec2: FromReflect + TypePath, Option<WindowTheme>: FromReflect + TypePath,

fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl TypePath for Window

where Window: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for Window

where Window: Any + Send + Sync, Cursor: FromReflect + TypePath, PresentMode: FromReflect + TypePath, WindowMode: FromReflect + TypePath, WindowPosition: FromReflect + TypePath, WindowResolution: FromReflect + TypePath, String: FromReflect + TypePath, Option<String>: FromReflect + TypePath, CompositeAlphaMode: FromReflect + TypePath, WindowResizeConstraints: FromReflect + TypePath, bool: FromReflect + TypePath, EnabledButtons: FromReflect + TypePath, WindowLevel: FromReflect + TypePath, InternalWindowState: FromReflect + TypePath, Vec2: FromReflect + TypePath, Option<WindowTheme>: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.