Struct Window

Component

pub struct Window {

    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 clip_children: 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,
    pub prefers_home_indicator_hidden: bool,
    pub prefers_status_bar_hidden: 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 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, VideoModeSelection::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.

clip_children: bool

Sets whether the window should draw over its child windows.

If true, the window excludes drawing over areas obscured by child windows. If false, the window can draw over child windows.

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.

prefers_home_indicator_hidden: bool

Sets whether the Window prefers the home indicator hidden.

Corresponds to WindowAttributesExtIOS::with_prefers_home_indicator_hidden.

Platform-specific

• Only used on iOS.

prefers_status_bar_hidden: bool

Sets whether the Window prefers the status bar hidden.

Corresponds to WindowAttributesExtIOS::with_prefers_status_bar_hidden.

Platform-specific

• Only used on iOS.

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.

Examples found in repository

tests/window/minimizing.rs (line 26)

fn minimize_automatically(mut window: Single<&mut Window>, frames: Res<FrameCount>) {
    if frames.0 != 60 {
        return;
    }

    window.set_minimized(true);
}

pub fn start_drag_move(&mut self)

Calling this will attempt to start a drag-move of the window.

There is no guarantee that this will work unless the left mouse button was pressed immediately before this function was called.

Examples found in repository

examples/window/window_drag_move.rs (line 136)

fn move_or_resize_windows(
    mut windows: Query<&mut Window>,
    action: Res<LeftClickAction>,
    input: Res<ButtonInput<MouseButton>>,
    dir: Res<ResizeDir>,
) {
    // Both `start_drag_move()` and `start_drag_resize()` must be called after a
    // left mouse button press as done here.
    //
    // winit 0.30.5 may panic when initiated without a left mouse button press.
    if input.just_pressed(MouseButton::Left) {
        for mut window in windows.iter_mut() {
            match *action {
                LeftClickAction::Nothing => (),
                LeftClickAction::Move => window.start_drag_move(),
                LeftClickAction::Resize => {
                    let d = DIRECTIONS[dir.0];
                    window.start_drag_resize(d);
                }
            }
        }
    }
}

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

Calling this will attempt to start a drag-resize of the window.

There is no guarantee that this will work unless the left mouse button was pressed immediately before this function was called.

Examples found in repository

examples/window/window_drag_move.rs (line 139)

fn move_or_resize_windows(
    mut windows: Query<&mut Window>,
    action: Res<LeftClickAction>,
    input: Res<ButtonInput<MouseButton>>,
    dir: Res<ResizeDir>,
) {
    // Both `start_drag_move()` and `start_drag_resize()` must be called after a
    // left mouse button press as done here.
    //
    // winit 0.30.5 may panic when initiated without a left mouse button press.
    if input.just_pressed(MouseButton::Left) {
        for mut window in windows.iter_mut() {
            match *action {
                LeftClickAction::Nothing => (),
                LeftClickAction::Move => window.start_drag_move(),
                LeftClickAction::Resize => {
                    let d = DIRECTIONS[dir.0];
                    window.start_drag_resize(d);
                }
            }
        }
    }
}

pub fn width(&self) -> f32

The window’s client area width in logical pixels.

See WindowResolution for an explanation about logical/physical sizes.

Examples found in repository

examples/ecs/parallel_query.rs (line 49)

fn bounce_system(window: Query<&Window>, mut sprites: Query<(&Transform, &mut Velocity)>) {
    let Ok(window) = window.single() else {
        return;
    };
    let width = window.width();
    let height = window.height();
    let left = width / -2.0;
    let right = width / 2.0;
    let bottom = height / -2.0;
    let top = height / 2.0;
    // The default batch size can also be overridden.
    // In this case a batch size of 32 is chosen to limit the overhead of
    // ParallelIterator, since negating a vector is very inexpensive.
    sprites
        .par_iter_mut()
        .batching_strategy(BatchingStrategy::fixed(32))
        .for_each(|(transform, mut v)| {
            if !(left < transform.translation.x
                && transform.translation.x < right
                && bottom < transform.translation.y
                && transform.translation.y < top)
            {
                // For simplicity, just reverse the velocity; don't use realistic bounces
                v.0 = -v.0;
            }
        });
}

pub fn height(&self) -> f32

The window’s client area height in logical pixels.

See WindowResolution for an explanation about logical/physical sizes.

Examples found in repository

examples/ecs/parallel_query.rs (line 50)

fn bounce_system(window: Query<&Window>, mut sprites: Query<(&Transform, &mut Velocity)>) {
    let Ok(window) = window.single() else {
        return;
    };
    let width = window.width();
    let height = window.height();
    let left = width / -2.0;
    let right = width / 2.0;
    let bottom = height / -2.0;
    let top = height / 2.0;
    // The default batch size can also be overridden.
    // In this case a batch size of 32 is chosen to limit the overhead of
    // ParallelIterator, since negating a vector is very inexpensive.
    sprites
        .par_iter_mut()
        .batching_strategy(BatchingStrategy::fixed(32))
        .for_each(|(transform, mut v)| {
            if !(left < transform.translation.x
                && transform.translation.x < right
                && bottom < transform.translation.y
                && transform.translation.y < top)
            {
                // For simplicity, just reverse the velocity; don't use realistic bounces
                v.0 = -v.0;
            }
        });
}

pub fn size(&self) -> Vec2

The window’s client size in logical pixels

See WindowResolution for an explanation about logical/physical sizes.

Examples found in repository

examples/stress_tests/bevymark.rs (line 541)

fn collision_system(window: Query<&Window>, mut bird_query: Query<(&mut Bird, &Transform)>) {
    let Ok(window) = window.single() else {
        return;
    };

    let half_extents = 0.5 * window.size();

    for (mut bird, transform) in &mut bird_query {
        handle_collision(half_extents, &transform.translation, &mut bird.velocity);
    }
}

examples/games/contributors.rs (line 263)

fn collisions(
    window: Query<&Window>,
    mut query: Query<(&mut Velocity, &mut Transform), With<Contributor>>,
    mut rng: ResMut<SharedRng>,
) {
    let Ok(window) = window.single() else {
        return;
    };

    let window_size = window.size();

    let collision_area = Aabb2d::new(Vec2::ZERO, (window_size - SPRITE_SIZE) / 2.);

    // The maximum height the birbs should try to reach is one birb below the top of the window.
    let max_bounce_height = (window_size.y - SPRITE_SIZE * 2.0).max(0.0);
    let min_bounce_height = max_bounce_height * 0.4;

    for (mut velocity, mut transform) in &mut query {
        // Clamp the translation to not go out of the bounds
        if transform.translation.y < collision_area.min.y {
            transform.translation.y = collision_area.min.y;

            // How high this birb will bounce.
            let bounce_height = rng.gen_range(min_bounce_height..=max_bounce_height);

            // Apply the velocity that would bounce the birb up to bounce_height.
            velocity.translation.y = (bounce_height * GRAVITY * 2.).sqrt();
        }

        // Birbs might hit the ceiling if the window is resized.
        // If they do, bounce them.
        if transform.translation.y > collision_area.max.y {
            transform.translation.y = collision_area.max.y;
            velocity.translation.y *= -1.0;
        }

        // On side walls flip the horizontal velocity
        if transform.translation.x < collision_area.min.x {
            transform.translation.x = collision_area.min.x;
            velocity.translation.x *= -1.0;
            velocity.rotation *= -1.0;
        }
        if transform.translation.x > collision_area.max.x {
            transform.translation.x = collision_area.max.x;
            velocity.translation.x *= -1.0;
            velocity.rotation *= -1.0;
        }
    }
}

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 physical_size(&self) -> UVec2

The window’s client size in physical pixels

See WindowResolution for an explanation about logical/physical sizes.

Examples found in repository

examples/3d/split_screen.rs (line 172)

fn set_camera_viewports(
    windows: Query<&Window>,
    mut resize_events: EventReader<WindowResized>,
    mut query: Query<(&CameraPosition, &mut Camera)>,
) {
    // We need to dynamically resize the camera's viewports whenever the window size changes
    // so then each camera always takes up half the screen.
    // A resize_event is sent when the window is first created, allowing us to reuse this system for initial setup.
    for resize_event in resize_events.read() {
        let window = windows.get(resize_event.window).unwrap();
        let size = window.physical_size() / 2;

        for (camera_position, mut camera) in &mut query {
            camera.viewport = Some(Viewport {
                physical_position: camera_position.pos * size,
                physical_size: size,
                ..default()
            });
        }
    }
}

examples/3d/camera_sub_view.rs (line 259)

fn resize_viewports(
    window: Single<&Window, With<bevy::window::PrimaryWindow>>,
    mut viewports: Query<(&mut Camera, &ExampleViewports)>,
) {
    let window_size = window.physical_size();

    let small_height = window_size.y / 5;
    let small_width = window_size.x / 8;

    let large_height = small_height * 4;
    let large_width = small_width * 4;

    let large_size = UVec2::new(large_width, large_height);

    // Enforce the aspect ratio of the small viewports to ensure the images
    // appear unstretched
    let small_dim = small_height.min(small_width);
    let small_size = UVec2::new(small_dim, small_dim);

    let small_wide_size = UVec2::new(small_dim * 2, small_dim);

    for (mut camera, example_viewport) in viewports.iter_mut() {
        if camera.viewport.is_none() {
            camera.viewport = Some(Viewport::default());
        };

        let Some(viewport) = &mut camera.viewport else {
            continue;
        };

        let (size, position) = match example_viewport {
            ExampleViewports::PerspectiveMain => (large_size, UVec2::new(0, small_height)),
            ExampleViewports::PerspectiveStretched => (small_size, UVec2::ZERO),
            ExampleViewports::PerspectiveMoving => (small_size, UVec2::new(small_width, 0)),
            ExampleViewports::PerspectiveControl => {
                (small_wide_size, UVec2::new(small_width * 2, 0))
            }
            ExampleViewports::OrthographicMain => {
                (large_size, UVec2::new(large_width, small_height))
            }
            ExampleViewports::OrthographicStretched => (small_size, UVec2::new(small_width * 4, 0)),
            ExampleViewports::OrthographicMoving => (small_size, UVec2::new(small_width * 5, 0)),
            ExampleViewports::OrthographicControl => {
                (small_wide_size, UVec2::new(small_width * 6, 0))
            }
        };

        viewport.physical_size = size;
        viewport.physical_position = position;
    }
}

pub fn scale_factor(&self) -> f32

The window’s scale factor.

Ratio of physical size to logical size, see WindowResolution.

Examples found in repository

examples/window/scale_factor_override.rs (line 71)

fn display_override(
    mut window: Single<&mut Window>,
    mut custom_text: Single<&mut Text, With<CustomText>>,
) {
    let text = format!(
        "Scale factor: {:.1} {}",
        window.scale_factor(),
        if window.resolution.scale_factor_override().is_some() {
            "(overridden)"
        } else {
            "(default)"
        }
    );

    window.title.clone_from(&text);
    custom_text.0 = text;
}

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.

Examples found in repository

examples/input/text_input.rs (line 79)

fn toggle_ime(
    input: Res<ButtonInput<MouseButton>>,
    mut window: Single<&mut Window>,
    status_text: Single<Entity, (With<Node>, With<Text>)>,
    mut ui_writer: TextUiWriter,
) {
    if input.just_pressed(MouseButton::Left) {
        window.ime_position = window.cursor_position().unwrap();
        window.ime_enabled = !window.ime_enabled;

        *ui_writer.text(*status_text, 3) = format!("{}\n", window.ime_enabled);
    }
}

examples/games/desk_toy.rs (line 212)

fn get_cursor_world_pos(
    mut cursor_world_pos: ResMut<CursorWorldPos>,
    primary_window: Single<&Window, With<PrimaryWindow>>,
    q_camera: Single<(&Camera, &GlobalTransform)>,
) {
    let (main_camera, main_camera_transform) = *q_camera;
    // Get the cursor position in the world
    cursor_world_pos.0 = primary_window.cursor_position().and_then(|cursor_pos| {
        main_camera
            .viewport_to_world_2d(main_camera_transform, cursor_pos)
            .ok()
    });
}

examples/ecs/observers.rs (line 184)

fn handle_click(
    mouse_button_input: Res<ButtonInput<MouseButton>>,
    camera: Single<(&Camera, &GlobalTransform)>,
    windows: Query<&Window>,
    mut commands: Commands,
) {
    let Ok(windows) = windows.single() else {
        return;
    };

    let (camera, camera_transform) = *camera;
    if let Some(pos) = windows
        .cursor_position()
        .and_then(|cursor| camera.viewport_to_world(camera_transform, cursor).ok())
        .map(|ray| ray.origin.truncate())
    {
        if mouse_button_input.just_pressed(MouseButton::Left) {
            commands.trigger(ExplodeMines { pos, radius: 1.0 });
        }
    }
}

examples/2d/2d_viewport_to_world.rs (line 35)

fn draw_cursor(
    camera_query: Single<(&Camera, &GlobalTransform)>,
    window: Query<&Window>,
    mut gizmos: Gizmos,
) {
    let (camera, camera_transform) = *camera_query;
    let Ok(window) = window.single() else {
        return;
    };

    let Some(cursor_position) = window.cursor_position() else {
        return;
    };

    // Calculate a world position based on the cursor's position.
    let Ok(world_pos) = camera.viewport_to_world_2d(camera_transform, cursor_position) else {
        return;
    };

    // To test Camera::world_to_viewport, convert result back to viewport space and then back to world space.
    let Ok(viewport_check) = camera.world_to_viewport(camera_transform, world_pos.extend(0.0))
    else {
        return;
    };
    let Ok(world_check) = camera.viewport_to_world_2d(camera_transform, viewport_check.xy()) else {
        return;
    };

    gizmos.circle_2d(world_pos, 10., WHITE);
    // Should be the same as world_pos
    gizmos.circle_2d(world_check, 8., RED);
}

examples/3d/3d_viewport_to_world.rs (line 25)

fn draw_cursor(
    camera_query: Single<(&Camera, &GlobalTransform)>,
    ground: Single<&GlobalTransform, With<Ground>>,
    windows: Query<&Window>,
    mut gizmos: Gizmos,
) {
    let Ok(windows) = windows.single() else {
        return;
    };

    let (camera, camera_transform) = *camera_query;

    let Some(cursor_position) = windows.cursor_position() else {
        return;
    };

    // Calculate a ray pointing from the camera into the world based on the cursor's position.
    let Ok(ray) = camera.viewport_to_world(camera_transform, cursor_position) else {
        return;
    };

    // Calculate if and where the ray is hitting the ground plane.
    let Some(distance) =
        ray.intersect_plane(ground.translation(), InfinitePlane3d::new(ground.up()))
    else {
        return;
    };
    let point = ray.get_point(distance);

    // Draw a circle just above the ground plane at that position.
    gizmos.circle(
        Isometry3d::new(
            point + ground.up() * 0.01,
            Quat::from_rotation_arc(Vec3::Z, ground.up().as_vec3()),
        ),
        0.2,
        Color::WHITE,
    );
}

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,

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

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have [Component<Mutability = Mutable>], while immutable components will instead have [Component<Mutability = Immutable>].

fn register_required_components( requiree: ComponentId, components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, inheritance_depth: u16, recursion_check_stack: &mut Vec<ComponentId>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn register_component_hooks(hooks: &mut ComponentHooks)

👎Deprecated since 0.16.0: Use the individual hook methods instead (e.g., Component::on_add, etc.)

Called when registering this component, allowing mutable access to its ComponentHooks.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

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<'de> Deserialize<'de> for Window

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromArg for &'static Window

where Window: Any + Send + Sync, CursorOptions: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PresentMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowPosition: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResolution: FromReflect + TypePath + MaybeTyped + RegisterForReflection, String: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, CompositeAlphaMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResizeConstraints: FromReflect + TypePath + MaybeTyped + RegisterForReflection, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, EnabledButtons: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowLevel: FromReflect + TypePath + MaybeTyped + RegisterForReflection, InternalWindowState: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<WindowTheme>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<NonZero<u32>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<(u8, u8)>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

type This<'from_arg> = &'from_arg Window

The type to convert into.

fn from_arg( arg: Arg<'_>, ) -> Result<<&'static Window as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromArg for &'static mut Window

where Window: Any + Send + Sync, CursorOptions: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PresentMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowPosition: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResolution: FromReflect + TypePath + MaybeTyped + RegisterForReflection, String: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, CompositeAlphaMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResizeConstraints: FromReflect + TypePath + MaybeTyped + RegisterForReflection, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, EnabledButtons: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowLevel: FromReflect + TypePath + MaybeTyped + RegisterForReflection, InternalWindowState: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<WindowTheme>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<NonZero<u32>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<(u8, u8)>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

type This<'from_arg> = &'from_arg mut Window

The type to convert into.

fn from_arg( arg: Arg<'_>, ) -> Result<<&'static mut Window as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromArg for Window

where Window: Any + Send + Sync, CursorOptions: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PresentMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowPosition: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResolution: FromReflect + TypePath + MaybeTyped + RegisterForReflection, String: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, CompositeAlphaMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResizeConstraints: FromReflect + TypePath + MaybeTyped + RegisterForReflection, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, EnabledButtons: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowLevel: FromReflect + TypePath + MaybeTyped + RegisterForReflection, InternalWindowState: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<WindowTheme>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<NonZero<u32>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<(u8, u8)>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

type This<'from_arg> = Window

The type to convert into.

fn from_arg(arg: Arg<'_>) -> Result<<Window as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromReflect for Window

where Window: Any + Send + Sync, CursorOptions: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PresentMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowPosition: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResolution: FromReflect + TypePath + MaybeTyped + RegisterForReflection, String: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, CompositeAlphaMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResizeConstraints: FromReflect + TypePath + MaybeTyped + RegisterForReflection, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, EnabledButtons: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowLevel: FromReflect + TypePath + MaybeTyped + RegisterForReflection, InternalWindowState: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<WindowTheme>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<NonZero<u32>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<(u8, u8)>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

Constructs a concrete instance of Self from a reflected value.

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

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

impl GetOwnership for &Window

where Window: Any + Send + Sync, CursorOptions: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PresentMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowPosition: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResolution: FromReflect + TypePath + MaybeTyped + RegisterForReflection, String: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, CompositeAlphaMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResizeConstraints: FromReflect + TypePath + MaybeTyped + RegisterForReflection, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, EnabledButtons: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowLevel: FromReflect + TypePath + MaybeTyped + RegisterForReflection, InternalWindowState: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<WindowTheme>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<NonZero<u32>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<(u8, u8)>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetOwnership for &mut Window

where Window: Any + Send + Sync, CursorOptions: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PresentMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowPosition: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResolution: FromReflect + TypePath + MaybeTyped + RegisterForReflection, String: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, CompositeAlphaMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResizeConstraints: FromReflect + TypePath + MaybeTyped + RegisterForReflection, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, EnabledButtons: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowLevel: FromReflect + TypePath + MaybeTyped + RegisterForReflection, InternalWindowState: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<WindowTheme>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<NonZero<u32>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<(u8, u8)>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetOwnership for Window

where Window: Any + Send + Sync, CursorOptions: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PresentMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowPosition: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResolution: FromReflect + TypePath + MaybeTyped + RegisterForReflection, String: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, CompositeAlphaMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResizeConstraints: FromReflect + TypePath + MaybeTyped + RegisterForReflection, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, EnabledButtons: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowLevel: FromReflect + TypePath + MaybeTyped + RegisterForReflection, InternalWindowState: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<WindowTheme>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<NonZero<u32>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<(u8, u8)>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetTypeRegistration for Window

where Window: Any + Send + Sync, CursorOptions: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PresentMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowPosition: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResolution: FromReflect + TypePath + MaybeTyped + RegisterForReflection, String: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, CompositeAlphaMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResizeConstraints: FromReflect + TypePath + MaybeTyped + RegisterForReflection, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, EnabledButtons: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowLevel: FromReflect + TypePath + MaybeTyped + RegisterForReflection, InternalWindowState: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<WindowTheme>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<NonZero<u32>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<(u8, u8)>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl IntoReturn for &Window

where Window: Any + Send + Sync, CursorOptions: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PresentMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowPosition: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResolution: FromReflect + TypePath + MaybeTyped + RegisterForReflection, String: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, CompositeAlphaMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResizeConstraints: FromReflect + TypePath + MaybeTyped + RegisterForReflection, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, EnabledButtons: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowLevel: FromReflect + TypePath + MaybeTyped + RegisterForReflection, InternalWindowState: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<WindowTheme>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<NonZero<u32>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<(u8, u8)>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_return<'into_return>(self) -> Return<'into_return>

where &Window: 'into_return,

Converts Self into a Return value.

impl IntoReturn for &mut Window

where Window: Any + Send + Sync, CursorOptions: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PresentMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowPosition: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResolution: FromReflect + TypePath + MaybeTyped + RegisterForReflection, String: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, CompositeAlphaMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResizeConstraints: FromReflect + TypePath + MaybeTyped + RegisterForReflection, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, EnabledButtons: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowLevel: FromReflect + TypePath + MaybeTyped + RegisterForReflection, InternalWindowState: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<WindowTheme>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<NonZero<u32>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<(u8, u8)>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_return<'into_return>(self) -> Return<'into_return>

where &mut Window: 'into_return,

Converts Self into a Return value.

impl IntoReturn for Window

where Window: Any + Send + Sync, CursorOptions: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PresentMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowPosition: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResolution: FromReflect + TypePath + MaybeTyped + RegisterForReflection, String: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, CompositeAlphaMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResizeConstraints: FromReflect + TypePath + MaybeTyped + RegisterForReflection, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, EnabledButtons: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowLevel: FromReflect + TypePath + MaybeTyped + RegisterForReflection, InternalWindowState: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<WindowTheme>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<NonZero<u32>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<(u8, u8)>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_return<'into_return>(self) -> Return<'into_return>

where Window: 'into_return,

Converts Self into a Return value.

impl PartialReflect for Window

where Window: Any + Send + Sync, CursorOptions: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PresentMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowPosition: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResolution: FromReflect + TypePath + MaybeTyped + RegisterForReflection, String: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, CompositeAlphaMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResizeConstraints: FromReflect + TypePath + MaybeTyped + RegisterForReflection, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, EnabledButtons: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowLevel: FromReflect + TypePath + MaybeTyped + RegisterForReflection, InternalWindowState: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<WindowTheme>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<NonZero<u32>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<(u8, u8)>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

Returns the TypeInfo of the type represented by this value.

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

Tries to apply 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 try_into_reflect( self: Box<Window>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

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

Attempts to cast this type to a fully-reflected value.

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

Attempts to cast this type to a mutable, fully-reflected value.

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

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value.

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

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

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

Applies a reflected value to this value.

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

👎Deprecated since 0.16.0: to clone reflected values, prefer using reflect_clone. To convert reflected values to dynamic ones, use to_dynamic.

Clones Self into its dynamic representation.

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

Converts this reflected value into its dynamic representation based on its kind.

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

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

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for Window

where Window: Any + Send + Sync, CursorOptions: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PresentMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowPosition: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResolution: FromReflect + TypePath + MaybeTyped + RegisterForReflection, String: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, CompositeAlphaMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResizeConstraints: FromReflect + TypePath + MaybeTyped + RegisterForReflection, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, EnabledButtons: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowLevel: FromReflect + TypePath + MaybeTyped + RegisterForReflection, InternalWindowState: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<WindowTheme>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<NonZero<u32>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<(u8, u8)>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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, fully-reflected value.

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

Casts this type to a fully-reflected value.

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

Casts this type to a mutable, fully-reflected value.

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

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

impl Serialize for Window

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Struct for Window

where Window: Any + Send + Sync, CursorOptions: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PresentMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowPosition: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResolution: FromReflect + TypePath + MaybeTyped + RegisterForReflection, String: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, CompositeAlphaMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResizeConstraints: FromReflect + TypePath + MaybeTyped + RegisterForReflection, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, EnabledButtons: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowLevel: FromReflect + TypePath + MaybeTyped + RegisterForReflection, InternalWindowState: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<WindowTheme>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<NonZero<u32>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<(u8, u8)>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

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

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

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

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

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

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

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

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 to_dynamic_struct(&self) -> DynamicStruct

fn clone_dynamic(&self) -> DynamicStruct

👎Deprecated since 0.16.0: use to_dynamic_struct instead

Clones the struct into a DynamicStruct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

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, CursorOptions: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PresentMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowPosition: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResolution: FromReflect + TypePath + MaybeTyped + RegisterForReflection, String: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, CompositeAlphaMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowResizeConstraints: FromReflect + TypePath + MaybeTyped + RegisterForReflection, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, EnabledButtons: FromReflect + TypePath + MaybeTyped + RegisterForReflection, WindowLevel: FromReflect + TypePath + MaybeTyped + RegisterForReflection, InternalWindowState: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<WindowTheme>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<NonZero<u32>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<(u8, u8)>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.