Struct objc2_foundation::CGRect

#[repr(C)]
pub struct CGRect {
    pub origin: CGPoint,
    pub size: CGSize,
}

Available on crate feature NSGeometry only.

The location and dimensions of a rectangle.

In the default Core Graphics coordinate space (macOS), the origin is located in the lower-left corner of the rectangle and the rectangle extends towards the upper-right corner.

If the context has a flipped coordinate space (iOS, tvOS, watchOS) the origin is in the upper-left corner and the rectangle extends towards the lower-right corner.

This technically belongs to the CoreGraphics framework, but we define it here for convenience.

See Apple’s documentation.

Fields

origin: CGPoint

The coordinates of the rectangle’s origin.

size: CGSize

The dimensions of the rectangle.

Implementations

impl CGRect

pub const fn new(origin: CGPoint, size: CGSize) -> Self

Create a new rectangle with the given origin and dimensions.

Examples

use objc2_foundation::{CGPoint, CGRect, CGSize};
let origin = CGPoint::new(10.0, -2.3);
let size = CGSize::new(5.0, 0.0);
let rect = CGRect::new(origin, size);

pub const ZERO: Self = _

A rectangle with origin (0.0, 0.0) and zero width and height.

pub fn standardize(self) -> Self

Returns a rectangle with a positive width and height.

This is often useful

Examples

use objc2_foundation::{CGPoint, CGRect, CGSize};
let origin = CGPoint::new(1.0, 1.0);
let size = CGSize::new(-5.0, -2.0);
let rect = CGRect::new(origin, size);
assert_eq!(rect.standardize().size, CGSize::new(5.0, 2.0));

pub fn min(self) -> CGPoint

The smallest coordinate of the rectangle.

pub fn mid(self) -> CGPoint

The center point of the rectangle.

pub fn max(self) -> CGPoint

The largest coordinate of the rectangle.

pub fn is_empty(self) -> bool

Returns whether a rectangle has zero width or height.

Examples

use objc2_foundation::{CGPoint, CGRect, CGSize};
assert!(CGRect::ZERO.is_empty());
let point = CGPoint::new(1.0, 2.0);
assert!(CGRect::new(point, CGSize::ZERO).is_empty());
assert!(!CGRect::new(point, CGSize::new(1.0, 1.0)).is_empty());

Trait Implementations

impl Clone for CGRect

fn clone(&self) -> CGRect

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CGRect

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

Formats the value using the given formatter.

impl Default for CGRect

fn default() -> CGRect

Returns the “default value” for a type.

impl Encode for CGRect

const ENCODING: Encoding = _

The Objective-C type-encoding for this type.

impl PartialEq for CGRect

fn eq(&self, other: &CGRect) -> 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 RefEncode for CGRect

const ENCODING_REF: Encoding = _

The Objective-C type-encoding for a reference of this type.

impl Copy for CGRect

impl StructuralPartialEq for CGRect