Struct bevy_window::Window

pub struct Window {

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

Define how a window will be created and how it will behave.

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.

composite_alpha_mode: CompositeAlphaMode

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

resize_constraints: WindowResizeConstraints

Which size limits to give the window.

resizable: bool

Should the window be resizable?

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

decorations: bool

Should the window have decorations enabled?

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

transparent: bool

Should the window be transparent?

Defines whether the background of the window should be transparent.

Platform-specific

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

macOS X 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

Should the window start focused?

window_level: WindowLevel

Should the window always be on top of other windows?

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.

fit_canvas_to_parent: bool

Whether or not to fit the canvas element’s size to its parent element’s size.

Warning: this will not behave as expected for parents that set their size according to the size of their children. This creates a “feedback loop” that will result in the canvas growing on each resize. When using this feature, ensure the parent’s size is not affected by its children.

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.

Implementations

impl Window

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

Setting this to true will attempt to maximize the window.

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

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

Setting this to true will attempt to minimize the window.

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

pub fn width(&self) -> f32

The window’s client area width in logical pixels.

pub fn height(&self) -> f32

The window’s client area height in logical pixels.

pub fn physical_width(&self) -> u32

The window’s client area width in physical pixels.

pub fn physical_height(&self) -> u32

The window’s client area height in physical pixels.

pub fn scale_factor(&self) -> f64

The window’s scale factor.

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

The cursor position in this window

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

The physical cursor position in this window

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

Set the cursor position in this window

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

Set the physical cursor position in this window

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 Windowwhere Self: Send + Sync + 'static,

type Storage = TableStorage

impl Debug for Window

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

Formats the value using the given formatter.

impl Default for Window

fn default() -> Self

Returns the “default value” for a type.

impl FromReflect for Windowwhere Cursor: FromReflect, PresentMode: FromReflect, WindowMode: FromReflect, WindowPosition: FromReflect, WindowResolution: FromReflect, String: FromReflect, CompositeAlphaMode: FromReflect, WindowResizeConstraints: FromReflect, bool: FromReflect, WindowLevel: FromReflect, Option<String>: FromReflect, InternalWindowState: FromReflect, Vec2: FromReflect,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect + 'static, Global> ) -> Result<Self, Box<dyn Reflect + 'static, Global>>

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

impl GetTypeRegistration for Windowwhere Cursor: Reflect, PresentMode: Reflect, WindowMode: Reflect, WindowPosition: Reflect, WindowResolution: Reflect, String: Reflect, CompositeAlphaMode: Reflect, WindowResizeConstraints: Reflect, bool: Reflect, WindowLevel: Reflect, Option<String>: Reflect, InternalWindowState: Reflect, Vec2: Reflect,

fn get_type_registration() -> TypeRegistration

impl Reflect for Windowwhere Cursor: Reflect, PresentMode: Reflect, WindowMode: Reflect, WindowPosition: Reflect, WindowResolution: Reflect, String: Reflect, CompositeAlphaMode: Reflect, WindowResizeConstraints: Reflect, bool: Reflect, WindowLevel: Reflect, Option<String>: Reflect, InternalWindowState: Reflect, Vec2: Reflect,

fn type_name(&self) -> &str

Returns the type name of the underlying type.

fn get_type_info(&self) -> &'static TypeInfo

Returns the TypeInfo of the underlying type.

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

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

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

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

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)

Applies a reflected value to this value.

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

Returns an enumeration of “kinds” of type.

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

Returns a mutable enumeration of “kinds” of type.

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

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &dyn Reflect) -> 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.

impl Struct for Windowwhere Cursor: Reflect, PresentMode: Reflect, WindowMode: Reflect, WindowPosition: Reflect, WindowResolution: Reflect, String: Reflect, CompositeAlphaMode: Reflect, WindowResizeConstraints: Reflect, bool: Reflect, WindowLevel: Reflect, Option<String>: Reflect, InternalWindowState: Reflect, Vec2: Reflect,

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

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>

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>

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>

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 Typed for Windowwhere Cursor: Reflect, PresentMode: Reflect, WindowMode: Reflect, WindowPosition: Reflect, WindowResolution: Reflect, String: Reflect, CompositeAlphaMode: Reflect, WindowResizeConstraints: Reflect, bool: Reflect, WindowLevel: Reflect, Option<String>: Reflect, InternalWindowState: Reflect, Vec2: Reflect,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.