Struct blend2d::region::Region

#[repr(transparent)]
pub struct Region { /* fields omitted */ }

Methods

impl Region

pub fn new() -> Self

pub fn region_type(&self) -> RegionType

pub fn is_empty(&self) -> bool

Returns true if this region is empty.

pub fn is_rect(&self) -> bool

Returns true if this region is a rectangle.

pub fn is_complex(&self) -> bool

Returns true if this region is of complex shape.

pub fn data(&self) -> &[BoxI]

The region's boxes.

pub fn len(&self) -> usize

The number of BoxI this region contains.

pub fn capacity(&self) -> usize

Returns the currently allocated capacity of the region.

pub fn bounding_box(&self) -> &BoxI

A bounding box representing this region.

pub fn clear(&mut self)

Clears the region.

pub fn reserve(&mut self, n: usize)

Reserves capacity for at least n boxes.

Panics

Panics if blend2d returns an OutOfMemory error

pub fn try_reserve(&mut self, n: usize) -> Result<(), OutOfMemory>

Reserves capacity for at least n boxes.

pub fn shrink_to_fit(&mut self)

Shrinks the region's allocated capacity down to its current length.

pub fn combine(&mut self, other: &Self, op: BooleanOp)

pub fn combine_rb(&mut self, b: &BoxI, op: BooleanOp)

pub fn combine_br(&mut self, b: &BoxI, op: BooleanOp)

pub fn combine_bb(&mut self, b: &BoxI, b2: &BoxI, op: BooleanOp)

pub fn translate(&mut self, p: PointI)

Translates the region by the given PointI. Possible overflow will be handled by clipping to a maximum region boundary, so the final region could be smaller than the region before translation.

pub fn translate_and_clip(&mut self, p: PointI, clip: &BoxI)

Translates the region by the given PointI and clips it to the given [BoxI].

pub fn intersect_and_clip(&mut self, region: &Region, clip: &BoxI)

Translates the region by the given region and clips it to the given [BoxI].

pub fn hit_test(&self, p: PointI) -> HitTest

Tests if a given PointI is in the region.

pub fn hit_test_box(&self, b: &BoxI) -> HitTest

Tests if a given BoxI is in the region.

Trait Implementations

impl DeepClone for Region

const ASSIGN_DEEP: unsafe extern "C" fn(_: *mut Self::Core, _: *const Self::Core) -> BLResult

fn clone_deep(&self) -> Self

Returns a deeply cloned copy of the value.

impl Geometry for Region

const GEO_TYPE: u32

impl From<BoxI> for Region

fn from(b: BoxI) -> Self

Performs the conversion.

impl<'a> From<&'a [BoxI]> for Region

fn from(b: &'a [BoxI]) -> Self

Performs the conversion.

impl From<RectI> for Region

fn from(r: RectI) -> Self

Performs the conversion.

impl<'a> From<&'a [RectI]> for Region

fn from(r: &'a [RectI]) -> Self

Performs the conversion.

impl PartialEq<Region> for Region

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Clone for Region

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl AsRef<[BoxI]> for Region

fn as_ref(&self) -> &[BoxI]

Performs the conversion.

impl Default for Region

fn default() -> Self

Returns the "default value" for a type.

impl Drop for Region

fn drop(&mut self)

Executes the destructor for this type.

impl Debug for Region

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

Formats the value using the given formatter.

impl Borrow<[BoxI]> for Region

fn borrow(&self) -> &[BoxI]

Immutably borrows from an owned value.