Struct LogicalPosition

pub struct LogicalPosition<P> {
    pub x: P,
    pub y: P,
}

A position represented in logical pixels.

The position is stored as floats, so please be careful. Casting floats to integers truncates the fractional part, which can cause noticeable issues. To help with that, an Into<(i32, i32)> implementation is provided which does the rounding for you.

Fields

x: P

y: P

Implementations

impl<P> LogicalPosition<P>

pub const fn new(x: P, y: P) -> LogicalPosition<P>

Examples found in repository

examples/child_window.rs (line 20)

fn main() -> Result<(), impl std::error::Error> {
    use std::collections::HashMap;

    use rio_window::dpi::{LogicalPosition, LogicalSize, Position};
    use rio_window::event::{ElementState, Event, KeyEvent, WindowEvent};
    use rio_window::event_loop::{ActiveEventLoop, EventLoop};
    use rio_window::raw_window_handle::HasRawWindowHandle;
    use rio_window::window::Window;

    #[path = "util/fill.rs"]
    mod fill;

    fn spawn_child_window(parent: &Window, event_loop: &ActiveEventLoop) -> Window {
        let parent = parent.raw_window_handle().unwrap();
        let mut window_attributes = Window::default_attributes()
            .with_title("child window")
            .with_inner_size(LogicalSize::new(200.0f32, 200.0f32))
            .with_position(Position::Logical(LogicalPosition::new(0.0, 0.0)))
            .with_visible(true);
        // `with_parent_window` is unsafe. Parent window must be a valid window.
        window_attributes = unsafe { window_attributes.with_parent_window(Some(parent)) };

        event_loop.create_window(window_attributes).unwrap()
    }

    let mut windows = HashMap::new();

    let event_loop: EventLoop<()> = EventLoop::new().unwrap();
    let mut parent_window_id = None;

    event_loop.run(move |event: Event<()>, event_loop| {
        match event {
            Event::Resumed => {
                let attributes = Window::default_attributes()
                    .with_title("parent window")
                    .with_position(Position::Logical(LogicalPosition::new(0.0, 0.0)))
                    .with_inner_size(LogicalSize::new(640.0f32, 480.0f32));
                let window = event_loop.create_window(attributes).unwrap();

                parent_window_id = Some(window.id());

                println!("Parent window id: {parent_window_id:?})");
                windows.insert(window.id(), window);
            }
            Event::WindowEvent { window_id, event } => match event {
                WindowEvent::CloseRequested => {
                    windows.clear();
                    event_loop.exit();
                }
                WindowEvent::CursorEntered { device_id: _ } => {
                    // On x11, println when the cursor entered in a window even if the child window
                    // is created by some key inputs.
                    // the child windows are always placed at (0, 0) with size (200, 200) in the
                    // parent window, so we also can see this log when we move
                    // the cursor around (200, 200) in parent window.
                    println!("cursor entered in the window {window_id:?}");
                }
                WindowEvent::KeyboardInput {
                    event:
                        KeyEvent {
                            state: ElementState::Pressed,
                            ..
                        },
                    ..
                } => {
                    let parent_window = windows.get(&parent_window_id.unwrap()).unwrap();
                    let child_window = spawn_child_window(parent_window, event_loop);
                    let child_id = child_window.id();
                    println!("Child window created with id: {child_id:?}");
                    windows.insert(child_id, child_window);
                }
                WindowEvent::RedrawRequested => {
                    if let Some(window) = windows.get(&window_id) {
                        fill::fill_window(window);
                    }
                }
                _ => (),
            },
            _ => (),
        }
    })
}

impl<P> LogicalPosition<P>

where P: Pixel,

pub fn from_physical<T, X>(physical: T, scale_factor: f64) -> LogicalPosition<P>

where T: Into<PhysicalPosition<X>>, X: Pixel,

pub fn to_physical<X>(&self, scale_factor: f64) -> PhysicalPosition<X>

where X: Pixel,

pub fn cast<X>(&self) -> LogicalPosition<X>

where X: Pixel,

Trait Implementations

impl<P> Clone for LogicalPosition<P>

where P: Clone,

fn clone(&self) -> LogicalPosition<P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P> Debug for LogicalPosition<P>

where P: Debug,

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

Formats the value using the given formatter.

impl<P> Default for LogicalPosition<P>

where P: Default,

fn default() -> LogicalPosition<P>

Returns the “default value” for a type.

impl<P, X> From<[X; 2]> for LogicalPosition<P>

where P: Pixel, X: Pixel,

fn from(_: [X; 2]) -> LogicalPosition<P>

Converts to this type from the input type.

impl<P, X> From<(X, X)> for LogicalPosition<P>

where P: Pixel, X: Pixel,

fn from(_: (X, X)) -> LogicalPosition<P>

Converts to this type from the input type.

impl<P> From<LogicalPosition<P>> for Position

where P: Pixel,

fn from(position: LogicalPosition<P>) -> Position

Converts to this type from the input type.

impl<P> Hash for LogicalPosition<P>

where P: Hash,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<P> Ord for LogicalPosition<P>

where P: Ord,

fn cmp(&self, other: &LogicalPosition<P>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<P> PartialEq for LogicalPosition<P>

where P: PartialEq,

fn eq(&self, other: &LogicalPosition<P>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<P> PartialOrd for LogicalPosition<P>

where P: PartialOrd,

fn partial_cmp(&self, other: &LogicalPosition<P>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<P> Copy for LogicalPosition<P>

where P: Copy,

impl<P> Eq for LogicalPosition<P>

where P: Eq,

impl<P> StructuralPartialEq for LogicalPosition<P>