Struct gegl::Rectangle

#[repr(transparent)]
pub struct Rectangle { /* private fields */ }

GLib type: Inline allocated boxed type with stack copy semantics.

Implementations

impl Rectangle

pub fn x(&self) -> i32

pub fn y(&self) -> i32

pub fn width(&self) -> i32

pub fn height(&self) -> i32

impl Rectangle

pub fn as_ptr(&self) -> *mut GeglRectangle

pub unsafe fn from_glib_ptr_borrow<'a>(ptr: *const GeglRectangle) -> &'a Self

Borrows the underlying C value.

pub unsafe fn from_glib_ptr_borrow_mut<'a>( ptr: *mut GeglRectangle ) -> &'a mut Self

Borrows the underlying C value mutably.

impl Rectangle

pub fn new(x: i32, y: i32, width: u32, height: u32) -> Rectangle

Creates a new rectangle set with the values from x, y, width and height.

x

upper left x coordinate

y

upper left y coordinate

width

width in pixels.

height

height in pixels.

pub fn align( &mut self, rectangle: &Rectangle, tile: &Rectangle, alignment: RectangleAlignment ) -> bool

Aligns rectangle to a regular tile grid, of which tile is a representative tile, and stores the result in self.

alignment can be one of:

GEGL_RECTANGLE_ALIGNMENT_SUBSET: Calculate the biggest aligned rectangle contained in rectangle.

GEGL_RECTANGLE_ALIGNMENT_SUPERSET: Calculate the smallest aligned rectangle containing rectangle.

GEGL_RECTANGLE_ALIGNMENT_NEAREST: Calculate the nearest aligned rectangle to rectangle.

self may point to the same object as rectangle or tile.

Returns TRUE if the result is not empty.

rectangle

a Rectangle

tile

a Rectangle

alignment

a RectangleAlignment value

pub fn align_to_buffer( &mut self, rectangle: &Rectangle, buffer: &Buffer, alignment: RectangleAlignment ) -> bool

Aligns rectangle to the tile grid of buffer, and stores the result in self.

alignment has the same meaning as for align().

self may point to the same object as rectangle.

Returns TRUE if the result is not empty.

rectangle

a Rectangle

buffer

a Buffer

alignment

a RectangleAlignment value

pub fn bounding_box(&mut self, source1: &Rectangle, source2: &Rectangle)

Computes the bounding box of the rectangles source1 and source2 and stores the resulting bounding box in self.

self may point to the same object as source1 or source2.

source1

a Rectangle

source2

a Rectangle

pub fn contains(&self, child: &Rectangle) -> bool

Checks if the Rectangle child is fully contained within self.

Returns TRUE if the child is fully contained in self.

child

a Rectangle

pub fn dump(&self)

For debugging purposes, not stable API.

pub fn dup(&self) -> Option<Rectangle>

Create a new copy of self.

Returns

a Rectangle

pub fn equal_coords(&self, x: i32, y: i32, width: i32, height: i32) -> bool

Check if a rectangle is equal to a set of parameters.

Returns TRUE if self and x,y width x height are equal.

x

X coordinate

y

Y coordinate

width

width of rectangle

height

height of rectangle

pub fn intersect(&mut self, src1: &Rectangle, src2: &Rectangle) -> bool

Calculates the intersection of two rectangles. If the rectangles do not intersect, dest’s width and height are set to 0 and its x and y values are undefined.

self may point to the same object as src1 or src2.

Returns TRUE if the rectangles intersect.

src1

a Rectangle

src2

a Rectangle

pub fn is_empty(&self) -> bool

Check if a rectangle has zero area.

Returns TRUE if the width or height of self is 0.

pub fn is_infinite_plane(&self) -> bool

Returns TRUE if the GeglRectangle represents an infininte plane, FALSE otherwise.

pub fn set(&mut self, x: i32, y: i32, width: u32, height: u32)

Sets the x, y, width and height on self.

x

upper left x coordinate

y

upper left y coordinate

width

width in pixels.

height

height in pixels.

pub fn subtract(&mut self, minuend: &Rectangle, subtrahend: &Rectangle) -> i32

Subtracts subtrahend from minuend, and stores the resulting rectangles in self. Between 0 and 4 disjoint rectangles may be produced.

self may contain minuend or subtrahend.

Returns the number of resulting rectangles.

minuend

a Rectangle

subtrahend

a Rectangle

pub fn subtract_bounding_box( &mut self, minuend: &Rectangle, subtrahend: &Rectangle ) -> bool

Computes the bounding box of the area formed by subtracting subtrahend from minuend, and stores the result in self.

self may point to the same object as minuend or subtrahend.

Returns TRUE if the result is not empty.

minuend

a Rectangle

subtrahend

a Rectangle

pub fn xor(&mut self, source1: &Rectangle, source2: &Rectangle) -> i32

Computes the symmetric difference of the rectangles source1 and source2, and stores the resulting rectangles in self. Between 0 and 4 disjoint rectangles may be produced.

self may contain rectangle1 or rectangle2.

Returns the number of resulting rectangles.

source1

a Rectangle

source2

a Rectangle

Trait Implementations

impl Clone for Rectangle

fn clone(&self) -> Self

Copies the inline boxed type by value with the type-specific copy function.

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

Performs copy-assignment from source.

impl Debug for Rectangle

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

Formats the value using the given formatter.

impl HasParamSpec for Rectangle

type ParamSpec = ParamSpecBoxed

type SetValue = Rectangle

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecBoxedBuilder<'_, Rectangle>

fn param_spec_builder() -> Self::BuilderFn

impl PartialEq<Rectangle> for Rectangle

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

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

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

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

impl StaticType for Rectangle

fn static_type() -> Type

Returns the type identifier of Self.

impl Copy for Rectangle

impl Eq for Rectangle