Struct objc2_foundation::CGSize

#[repr(C)]
pub struct CGSize {
    pub width: CGFloat,
    pub height: CGFloat,
}

Available on crate feature NSGeometry only.

A two-dimensional size.

As this is sometimes used to represent a distance vector, rather than a physical size, the width and height are not guaranteed to be non-negative! Methods that expect that must use one of CGSize::abs or CGRect::standardize.

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

See Apple’s documentation.

Fields

width: CGFloat

The dimensions along the x-axis.

height: CGFloat

The dimensions along the y-axis.

Implementations

impl CGSize

pub const fn new(width: CGFloat, height: CGFloat) -> Self

Create a new size with the given dimensions.

Examples

use objc2_foundation::CGSize;
let size = CGSize::new(10.0, 2.3);
assert_eq!(size.width, 10.0);
assert_eq!(size.height, 2.3);

Negative values are allowed (though often undesired).

use objc2_foundation::CGSize;
let size = CGSize::new(-1.0, 0.0);
assert_eq!(size.width, -1.0);

pub fn abs(self) -> Self

Convert the size to a non-negative size.

This can be used to convert the size to a safe value.

Examples

use objc2_foundation::CGSize;
assert_eq!(CGSize::new(-1.0, 1.0).abs(), CGSize::new(1.0, 1.0));

pub const ZERO: Self = _

A size that is 0.0 in both dimensions.

Examples

use objc2_foundation::CGSize;
assert_eq!(CGSize::ZERO, CGSize { width: 0.0, height: 0.0 });

Trait Implementations

impl Clone for CGSize

fn clone(&self) -> CGSize

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CGSize

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

Formats the value using the given formatter.

impl Default for CGSize

fn default() -> CGSize

Returns the “default value” for a type.

impl Encode for CGSize

const ENCODING: Encoding = _

The Objective-C type-encoding for this type.

impl PartialEq for CGSize

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

const ENCODING_REF: Encoding = _

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

impl Copy for CGSize

impl StructuralPartialEq for CGSize