Struct bevy_windows_param::Windows

pub struct Windows<'w, 's> { /* private fields */ }

Implementations

impl Windows<'_, '_>

pub fn get_window(&self, window_ref: WindowRef) -> Option<&Window>

pub fn scale_factor(&self, window_ref: WindowRef) -> Option<f64>

Returns the scale factor for the given window

pub fn physical_resolution(&self, window_ref: WindowRef) -> Option<Vec2>

Returns the physical resolution for the given window

pub fn resolution(&self, window_ref: WindowRef) -> Option<Vec2>

Returns the logical resolution for the given window

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

Returns the cursor position in window coordinates

pub fn ui_cursor_position(&self) -> Option<CursorPosition>

Returns the cursor position in UI coordinates (y coordinates increase going downwards with the origin in the top-left corner)

Examples found in repository

examples/cursor_position.rs (line 19)

fn report_cursor_position(windows: bevy_windows_param::Windows) {
    if let Some(cursor_position) = windows.ui_cursor_position() {
        println!("{}", cursor_position);
    }
}

examples/multiple_windows.rs (line 48)

fn report_cursor_position(windows: bevy_windows_param::Windows) {
    if let Some(cursor_position) = windows.ui_cursor_position() {
        println!("{}", cursor_position);
    }
}

pub fn world_cursor_position(&self) -> Option<CursorPosition>

Returns the cursor position in world coordinates

Trait Implementations

impl<'w, 's> IntoIterator for &'w Windows<'_, 's>

type Item = (Entity, &'w Window)

The type of the elements being iterated over.

type IntoIter = QueryIter<'w, 's, (Entity, &'static Window), ()>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl SystemParam for Windows<'_, '_>

type State = FetchState

Used to store data which persists across invocations of a system.

type Item<'w, 's> = Windows<'w, 's>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes.

fn init_state(world: &mut World, system_meta: &mut SystemMeta) -> Self::State

Registers any [World] access used by this [SystemParam] and creates a new instance of this param’s State.

fn new_archetype( state: &mut Self::State, archetype: &Archetype, system_meta: &mut SystemMeta )

For the specified [Archetype], registers the components accessed by this [SystemParam] (if applicable).

fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)

Applies any deferred mutations stored in this [SystemParam]’s state. This is used to apply Commands during apply_system_buffers.

unsafe fn get_param<'w, 's>( state: &'s mut Self::State, system_meta: &SystemMeta, world: &'w World, change_tick: u32 ) -> Self::Item<'w, 's>

Safety

impl<'w, 's> ReadOnlySystemParam for Windows<'w, 's>where Query<'w, 's, (Entity, &'static Window), With<PrimaryWindow>>: ReadOnlySystemParam, Query<'w, 's, (Entity, &'static Window)>: ReadOnlySystemParam, Query<'w, 's, (&'static Camera, Option<&'static UiCameraConfig>, &'static GlobalTransform)>: ReadOnlySystemParam, Res<'w, Touches>: ReadOnlySystemParam,