Struct NSScreen

#[repr(C)]
pub struct NSScreen { /* private fields */ }

Available on crate feature NSScreen only.

Apple’s documentation

Implementations

impl NSScreen

pub fn screens(mtm: MainThreadMarker) -> Retained<NSArray<NSScreen>>

pub fn mainScreen(mtm: MainThreadMarker) -> Option<Retained<NSScreen>>

pub unsafe fn deepestScreen(mtm: MainThreadMarker) -> Option<Retained<NSScreen>>

pub unsafe fn screensHaveSeparateSpaces(mtm: MainThreadMarker) -> bool

pub unsafe fn depth(&self) -> NSWindowDepth

Available on crate feature NSGraphics only.

pub fn frame(&self) -> NSRect

pub fn visibleFrame(&self) -> NSRect

pub fn deviceDescription( &self, ) -> Retained<NSDictionary<NSDeviceDescriptionKey, AnyObject>>

Available on crate feature NSGraphics only.

pub unsafe fn colorSpace(&self) -> Option<Retained<NSColorSpace>>

Available on crate feature NSColorSpace only.

pub unsafe fn supportedWindowDepths(&self) -> NonNull<NSWindowDepth>

Available on crate feature NSGraphics only.

pub unsafe fn canRepresentDisplayGamut( &self, display_gamut: NSDisplayGamut, ) -> bool

Available on crate feature NSGraphics only.

pub unsafe fn convertRectToBacking(&self, rect: NSRect) -> NSRect

pub unsafe fn convertRectFromBacking(&self, rect: NSRect) -> NSRect

pub unsafe fn backingAlignedRect_options( &self, rect: NSRect, options: NSAlignmentOptions, ) -> NSRect

pub fn backingScaleFactor(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn localizedName(&self) -> Retained<NSString>

pub unsafe fn safeAreaInsets(&self) -> NSEdgeInsets

pub unsafe fn auxiliaryTopLeftArea(&self) -> NSRect

pub unsafe fn auxiliaryTopRightArea(&self) -> NSRect

impl NSScreen

Methods declared on superclass NSObject.

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

pub unsafe fn new(mtm: MainThreadMarker) -> Retained<Self>

impl NSScreen

pub unsafe fn maximumExtendedDynamicRangeColorComponentValue(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn maximumPotentialExtendedDynamicRangeColorComponentValue( &self, ) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn maximumReferenceExtendedDynamicRangeColorComponentValue( &self, ) -> CGFloat

Available on crate feature objc2-core-foundation only.

impl NSScreen

pub unsafe fn maximumFramesPerSecond(&self) -> NSInteger

The maximum frames per second this screen supports.

pub unsafe fn minimumRefreshInterval(&self) -> NSTimeInterval

The minimum refresh interval this screen supports, in seconds.

This is the shortest amount of time a frame will be present on screen. minimumRefreshInterval and maximumRefreshInterval will be the same for displays that do not support variable refresh rates.

pub unsafe fn maximumRefreshInterval(&self) -> NSTimeInterval

The maximum refresh interval this screen supports, in seconds.

minimumRefreshInterval and maximumRefreshInterval will be the same for displays that do not support variable refresh rates.

pub unsafe fn displayUpdateGranularity(&self) -> NSTimeInterval

The update granularity of the screen’s current mode, in seconds.

The display will update at the next boundary defined by the granularity, after the minimum refresh interval has been reached. When 0, the display can update at any time between the minimum and maximum refresh rate intervals of the screen. Fixed refresh rate screen modes will return the refresh interval as the update granularity (e.g. 16.66ms for 60Hz refresh rates), meaning updates only occur at refresh rate boundaries.

pub unsafe fn lastDisplayUpdateTimestamp(&self) -> NSTimeInterval

The time at which the last framebuffer update occurred on the display, in seconds since startup that the system has been awake.

impl NSScreen

NSDisplayLink.

pub unsafe fn displayLinkWithTarget_selector( &self, target: &AnyObject, selector: Sel, ) -> Retained<CADisplayLink>

Available on crate feature objc2-quartz-core and Apple only.

impl NSScreen

NSDeprecated.

pub unsafe fn userSpaceScaleFactor(&self) -> CGFloat

👎Deprecated: Use -convertRectToBacking: or -backingScaleFactor instead

Available on crate feature objc2-core-foundation only.

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Available on crate feature NSAccessibilityConstants only.

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Available on crate feature NSAccessibilityConstants only.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Available on crate feature NSAccessibilityConstants only.

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for NSScreen

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for NSScreen

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSScreen> for NSScreen

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for NSScreen

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSScreen

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSScreen

const NAME: &'static str = "NSScreen"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = dyn MainThreadOnly

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for NSScreen

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

Formats the value using the given formatter.

impl Deref for NSScreen

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for NSScreen

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for NSScreen

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for NSScreen

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for NSScreen

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl RefEncode for NSScreen

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

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

impl DowncastTarget for NSScreen

impl Eq for NSScreen