Struct wlroots::area::Area

pub struct Area {
    pub origin: Origin,
    pub size: Size,
}

Generic geometry-like struct. Container an origin (x, y) point and bounds (width, height).

Fields

origin: Origin

size: Size

Methods

impl Area

pub fn new(origin: Origin, size: Size) -> Self

pub fn from_box(wlr_box: wlr_box) -> Self

Construct an Area from a wlr_box.

pub fn with_size(self, size: Size) -> Self

Makes a new Area with width and height set to the values in the given Size.

pub fn with_origin(self, origin: Origin) -> Self

Makes a new Area with x and y set to the value in the given Origin.

pub fn closest_point(self, x: c_double, y: c_double) -> (c_double, c_double)

Finds the closest point within the box to the given point. If the (x, y) point lies outside of the box, then it finds the closest corner and returns that.

Returned value is in form of (x, y).

pub fn intersection(self, other_box: Area) -> IntersectionResult

Gets the intersection of the two areas.

pub fn contains_point(self, x: c_double, y: c_double) -> bool

Determines if the box contains the given point.

pub fn is_empty(self) -> bool

Determines if the box is empty (e.g if the bounds give it an area of 0).

pub fn transform(     self,     transform: wl_output_transform,     width: c_int,     height: c_int ) -> Area

Transforms the box coordinates and bounds according to the output transformation.

e.g: If it's WL_OUTPUT_TRANSFORM_90 then it will flip the Area 90° clockwise.

pub fn rotated_bounds(self, rotation: c_float) -> Area

Creates the smallest box that contains the box rotated about its center.

Trait Implementations

impl Clone for Area

fn clone(&self) -> Area

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Area

impl Into<Area> for Origin

fn into(self) -> Area

Performs the conversion.

impl Into<Area> for Size

fn into(self) -> Area

Performs the conversion.

impl Into<wlr_box> for Area

fn into(self) -> wlr_box

Performs the conversion.

impl Eq for Area

impl Default for Area

fn default() -> Area

Returns the "default value" for a type.

impl PartialEq<Area> for Area

fn eq(&self, other: &Area) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Debug for Area

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

Formats the value using the given formatter.