Struct RegionSize

Source

pub struct RegionSize<const N: usize>where
    Const<N>: DimNameAdd<U1>,
    DefaultAllocator: Allocator<DimNameSum<Const<N>, U1>, DimNameSum<Const<N>, U1>> + Allocator<<<Const<N> as DimNameAdd<Const<1>>>::Output as DimNameSub<Const<1>>>::Output>,
    <Const<N> as DimNameAdd<Const<1>>>::Output: DimNameSub<Const<1>>,
    OVector<u32, <<Const<N> as DimNameAdd<Const<1>>>::Output as DimNameSub<Const<1>>>::Output>: Copy,
{ /* private fields */ }

Expand description

Image size in pixels, used to generate a screen-to-world matrix

The screen coordinate space is the following:

       0 ------------> width
       |             |
       |             |
       |             |
       V--------------
  height

The map from screen to world coordinates (generated by screen_to_world) is as following:

      -1           y = +1
       0-------------^-------------> width
       |             |             |
       |             |             |
       |             |             |
  x = -1 <-----------0-------------> x = +1
       |             |             |
       |             |             |
       |             V             |
       V---------- y = -1 ---------
  height

(with +z pointing out of the screen)

Note that the Y axis is reversed between screen and world coordinates: screen coordinates have +y pointing down, but world coordinates have it pointing up. For both X and Y coordinates, the +1 value is located one pixel beyond the edge of the screen region (off the right edge for X, and off the top edge for Y).

If the render region is not square, then the shorter axis is clamped to ±1 and the longer axis will exceed that value.

RegionSize

Struct RegionSize Copy item path

Implementations§

pub fn screen_to_world( &self, ) -> OMatrix<f32, <Const<N> as DimNameAdd<Const<1>>>::Output, <Const<N> as DimNameAdd<Const<1>>>::Output>

pub fn width(&self) -> u32

pub fn height(&self) -> u32

impl RegionSize<2>

pub fn new(width: u32, height: u32) -> Self

pub fn transform_point(&self, p: Point2<i32>) -> Point2<f32>

impl RegionSize<3>

pub fn new(width: u32, height: u32, depth: u32) -> Self

pub fn depth(&self) -> u32

pub fn transform_point(&self, p: Point3<i32>) -> Point3<f32>

Trait Implementations§

fn clone(&self) -> RegionSize<N>

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

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

fn default() -> Self

fn from(v: u32) -> Self

type Output = u32

fn index(&self, i: usize) -> &Self::Output

fn eq(&self, other: &RegionSize<N>) -> bool

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

Auto Trait Implementations§

impl<const N: usize> !Freeze for RegionSize<N>

impl<const N: usize> !RefUnwindSafe for RegionSize<N>

impl<const N: usize> !Send for RegionSize<N>

impl<const N: usize> !Sync for RegionSize<N>

impl<const N: usize> !Unpin for RegionSize<N>

impl<const N: usize> !UnwindSafe for RegionSize<N>

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where F: FnOnce(&Self) -> bool,

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where C: Color,

fn black(&self) -> FgColorDisplay<'_, Black, Self>

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

fn red(&self) -> FgColorDisplay<'_, Red, Self>

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

fn green(&self) -> FgColorDisplay<'_, Green, Self>

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

fn white(&self) -> FgColorDisplay<'_, White, Self>

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Struct RegionSize

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<T> CloneToUninit for T
where T: Clone,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

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

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,