Skip to main content

Region

Struct Region 

Source
pub struct Region { /* private fields */ }
Expand description

An area of a window in logical pixels, built from rectangles, rounded rectangles and ellipses joined with union, subtract, intersect and xor, applied in the order they are called.

PanelWindow::mask takes one: pointer input outside it goes to whatever is below the window.

use crabshell_ui::Region;

// A 200 by 30 bar that only takes clicks at its two rounded ends.
let ends = Region::rect(0, 0, 40, 30)
    .radius(8.0)
    .union(Region::rect(160, 0, 40, 30).radius(8.0));

Implementations§

Source§

impl Region

Source

pub fn empty() -> Region

No area at all: a window masked with it lets every click through.

Source

pub fn rect(x: i32, y: i32, width: u32, height: u32) -> Region

The rectangle at x, y, relative to the window’s top left.

Source

pub fn ellipse(x: i32, y: i32, width: u32, height: u32) -> Region

The ellipse that fills the rectangle at x, y.

Source

pub fn radius(self, radius: f32) -> Region

Rounds every corner of a rect. It does nothing to other shapes.

Source

pub fn radii( self, top_left: f32, top_right: f32, bottom_right: f32, bottom_left: f32, ) -> Region

Rounds each corner of a rect on its own. It does nothing to other shapes.

Source

pub fn union(self, other: Region) -> Region

Adds other’s area.

Source

pub fn subtract(self, other: Region) -> Region

Removes other’s area.

Source

pub fn intersect(self, other: Region) -> Region

Keeps only the area also in other.

Source

pub fn xor(self, other: Region) -> Region

Keeps the area in exactly one of the two.

Source

pub fn rects(&self, width: u32, height: u32) -> Vec<[i32; 4]>

The region inside a width by height window as rectangles [x, y, width, height], which don’t overlap. Curves are followed to the nearest whole pixel at each row’s center.

Trait Implementations§

Source§

impl Clone for Region

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Region

Source§

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

Formats the value using the given formatter. Read more
Source§

impl IntoProp<Option<Region>> for Region

Source§

fn into_prop(self) -> Prop<Option<Region>>

Wraps the value or closure.
Source§

impl PartialEq for Region

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Region

Auto Trait Implementations§

§

impl Forget for Region

§

impl Freeze for Region

§

impl Move for Region

§

impl RefUnwindSafe for Region

§

impl Send for Region

§

impl Sync for Region

§

impl Unpin for Region

§

impl UnsafeUnpin for Region

§

impl UnwindSafe for Region

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more