Struct Window

Source

pub struct Window {Show 36 fields
    pub cursor_options: CursorOptions,
    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 fit_canvas_to_parent: bool,
    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,
    pub skip_taskbar: bool,
    pub desired_maximum_frame_latency: Option<NonZero<u32>>,
    pub recognize_pinch_gesture: bool,
    pub recognize_rotation_gesture: bool,
    pub recognize_doubletap_gesture: bool,
    pub recognize_pan_gesture: Option<(u8, u8)>,
    pub movable_by_window_background: bool,
    pub fullsize_content_view: bool,
    pub has_shadow: bool,
    pub titlebar_shown: bool,
    pub titlebar_transparent: bool,
    pub titlebar_show_title: bool,
    pub titlebar_show_buttons: bool,
}

Expand description

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 window mode:

fn change_window_mode(mut windows: Query<&mut Window, With<PrimaryWindow>>) {
    // Query returns one window typically.
    for mut window in windows.iter_mut() {
        window.mode = WindowMode::Fullscreen(MonitorSelection::Current);
    }
}

Fields§

§cursor_options: CursorOptions

The cursor options of this window. Cursor icons are set with the Cursor component on the window entity.

§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.

§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 KeyboardInput from bevy_input.

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 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.

§skip_taskbar: bool

Sets whether the window should be shown in the taskbar.

If true, the window will not appear in the taskbar. If false, the window will appear in the taskbar.

Note that this will only take effect on window creation.

§Platform-specific

Only supported on Windows.

§desired_maximum_frame_latency: Option<NonZero<u32>>

Optional hint given to the rendering API regarding the maximum number of queued frames admissible on the GPU.

Given values are usually within the 1-3 range. If not provided, this will default to 2.

See wgpu::SurfaceConfiguration::desired_maximum_frame_latency.

§recognize_pinch_gesture: bool

Sets whether this window recognizes PinchGesture

§Platform-specific

Only used on iOS.
On macOS, they are recognized by default and can’t be disabled.

§recognize_rotation_gesture: bool

Sets whether this window recognizes RotationGesture

§Platform-specific

Only used on iOS.
On macOS, they are recognized by default and can’t be disabled.

§recognize_doubletap_gesture: bool

Sets whether this window recognizes DoubleTapGesture

§Platform-specific

Only used on iOS.
On macOS, they are recognized by default and can’t be disabled.

§recognize_pan_gesture: Option<(u8, u8)>

Sets whether this window recognizes PanGesture, with a number of fingers between the first value and the last.

§Platform-specific

Only used on iOS.

§movable_by_window_background: bool

Enables click-and-drag behavior for the entire window, not just the titlebar.

Corresponds to WindowAttributesExtMacOS::with_movable_by_window_background.

§Platform-specific

Only used on macOS.

§fullsize_content_view: bool

Makes the window content appear behind the titlebar.

Corresponds to WindowAttributesExtMacOS::with_fullsize_content_view.

For apps which want to render the window buttons on top of the apps itself, this should be enabled along with titlebar_transparent.

§Platform-specific

Only used on macOS.

§has_shadow: bool

Toggles drawing the drop shadow behind the window.

Corresponds to WindowAttributesExtMacOS::with_has_shadow.

§Platform-specific

Only used on macOS.

§titlebar_shown: bool

Toggles drawing the titlebar.

Corresponds to WindowAttributesExtMacOS::with_titlebar_hidden.

§Platform-specific

Only used on macOS.

§titlebar_transparent: bool

Makes the titlebar transparent, allowing the app content to appear behind it.

Corresponds to WindowAttributesExtMacOS::with_titlebar_transparent.

§Platform-specific

Only used on macOS.

§titlebar_show_title: bool

Toggles showing the window title.

Corresponds to WindowAttributesExtMacOS::with_title_hidden.

§Platform-specific

Only used on macOS.

§titlebar_show_buttons: bool

Toggles showing the traffic light window buttons.

Corresponds to WindowAttributesExtMacOS::with_titlebar_buttons_hidden.

§Platform-specific

Only used on macOS.

Struct WindowCopy item path

§Example

Fields§

§Platform-specific

§Platform-specific

§Platform-specific

§Platform-specific

§Platform-specific

§Platform-specific

§Platform-specific

§Platform-specific

§Platform-specific

§Platform-specific

§Platform-specific

§Platform-specific

§Platform-specific

§Platform-specific

§Platform-specific

§Platform-specific

§Platform-specific

§Platform-specific

§Platform-specific

§Platform-specific

§Platform-specific

Implementations§

impl Window

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

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

pub fn start_drag_move(&mut self)

pub fn start_drag_resize(&mut self, direction: CompassOctant)

pub fn width(&self) -> f32

pub fn height(&self) -> f32

pub fn size(&self) -> Vec2

pub fn physical_width(&self) -> u32

pub fn physical_height(&self) -> u32

pub fn physical_size(&self) -> UVec2

pub fn scale_factor(&self) -> f32

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

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

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

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

Trait Implementations§

impl Clone for Window

fn clone(&self) -> Window

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

impl Component for Windowwhere Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

fn register_required_components( requiree: ComponentId, components: &mut Components, storages: &mut Storages, required_components: &mut RequiredComponents, inheritance_depth: u16, )

fn register_component_hooks(hooks: &mut ComponentHooks)

impl Debug for Window

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

impl Default for Window

fn default() -> Self

impl<'de> Deserialize<'de> for Window

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

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

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

fn get_type_registration() -> TypeRegistration

fn register_type_dependencies(registry: &mut TypeRegistry)

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

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

fn try_apply(&mut self, value: &dyn PartialReflect) -> Result<(), ApplyError>

fn reflect_kind(&self) -> ReflectKind

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

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

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

fn try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

fn try_as_reflect(&self) -> Option<&dyn Reflect>

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

fn as_partial_reflect(&self) -> &dyn PartialReflect

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

fn reflect_partial_eq(&self, value: &dyn PartialReflect) -> Option<bool>

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

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

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

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

fn is_dynamic(&self) -> bool

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

fn as_any(&self) -> &dyn Any

Struct Window

impl Component for Window
where Self: Send + Sync + 'static,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

impl TypePath for Window
where Window: Any + Send + Sync,

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<C> Bundle for C
where C: Component,

unsafe fn from_components<T, F>(ctx: &mut T, func: &mut F) -> C
where F: for<'a> FnMut(&'a mut T) -> OwningPtr<'a>,

impl<T> CloneToUninit for T
where T: Clone,

impl<T> Downcast for T
where T: Any,

impl<T> DowncastSync for T
where T: Any + Send + Sync,

impl<C> DynamicBundle for C
where C: Component,

impl<T> DynamicTypePath for T
where T: TypePath,