Struct SKView

Source

pub struct SKView { /* private fields */ }

Available on macOS and crate feature objc2-app-kit and crate feature SKView only.

Expand description

Apple’s documentation

Implementations§

Source §

Setter for allowsTransparency.

Source

pub unsafe fn ignoresSiblingOrder(&self) -> bool

Ignores sibling and traversal order to sort the rendered contents of a scene into the most efficient batching possible. This will require zPosition to be used in the scenes to properly guarantee elements are in front or behind each other.

This defaults to NO, meaning that sibling order overrides efficiency heuristics in the rendering of the scenes in the view.

Setting this to YES for a complex scene may substantially increase performance, but care must be taken as only zPosition determines render order before the efficiency heuristics are used.

Optional view delegate, see SKViewDelegate.

Source

pub unsafe fn setDelegate(&self, delegate: Option<&NSObject>)

Setter for delegate.

This is a weak property.

§Safety

pub unsafe fn presentScene_transition( &self, scene: &SKScene, transition: &SKTransition, )

Available on crate features SKEffectNode and SKNode and SKScene and SKTransition only.

Present an SKScene in the view, replacing the current scene.

If there is currently a scene being presented in the view, the transition is used to swap between them.

Parameter scene: the scene to present.

Parameter transition: the transition to use when presenting the scene.

Source

pub unsafe fn scene(&self) -> Option<Retained<SKScene>>

Available on crate features SKEffectNode and SKNode and SKScene only.

The currently presented scene, otherwise nil. If in a transition, the ‘incoming’ scene is returned.

Source

pub unsafe fn textureFromNode( &self, node: &SKNode, ) -> Option<Retained<SKTexture>>

Available on crate features SKNode and SKTexture only.

Create an SKTexture containing a snapshot of how it would have been rendered in this view. The texture is tightly cropped to the size of the node.

Parameter node: the node subtree to render to the texture.

Source

pub unsafe fn textureFromNode_crop( &self, node: &SKNode, crop: CGRect, ) -> Option<Retained<SKTexture>>

Available on crate features objc2-core-foundation and SKNode and SKTexture only.

Create an SKTexture containing a snapshot of how it would have been rendered in this view. The texture is cropped to the specified rectangle

Parameter node: the node subtree to render to the texture.

Parameter crop: the crop

Source

pub unsafe fn convertPoint_toScene( &self, point: CGPoint, scene: &SKScene, ) -> CGPoint

Available on crate features objc2-core-foundation and SKEffectNode and SKNode and SKScene only.

Converts a point from view space to scene space.

Parameter point: the point to convert.

Parameter scene: the scene to convert the point into.

Source

pub unsafe fn convertPoint_fromScene( &self, point: CGPoint, scene: &SKScene, ) -> CGPoint

Available on crate features objc2-core-foundation and SKEffectNode and SKNode and SKScene only.

Converts a point from scene space to view space.

Parameter point: the point to convert.

Parameter scene: the scene to convert the point into.

Source §

impl SKView

Methods declared on superclass NSView.

Source

pub unsafe fn initWithFrame( this: Allocated<Self>, frame_rect: NSRect, ) -> Retained<Self>

Source

pub unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

Source

pub unsafe fn opaqueAncestor(&self) -> Option<Retained<NSView>>

Available on crate feature NSResponder only.

§Safety

This is not retained internally, you must ensure the object is still alive.

Source

pub fn isHidden(&self) -> bool

Available on crate feature NSResponder only.

Source

pub fn setHidden(&self, hidden: bool)

Available on crate feature NSResponder only.

Setter for isHidden.

Source

pub fn isHiddenOrHasHiddenAncestor(&self) -> bool

Available on crate feature NSResponder only.

Source

pub unsafe fn getRectsBeingDrawn_count( &self, rects: mut const CGRect, count: *mut isize, )

Available on crate feature NSResponder only.

§Safety

rects must be a valid pointer or null.
count must be a valid pointer or null.

§Safety

compare must be implemented correctly.
context must be a valid pointer or null.

Source

pub fn setPostsFrameChangedNotifications( &self, posts_frame_changed_notifications: bool, )

Available on crate feature NSResponder only.

Setter for postsFrameChangedNotifications.

Source

pub fn resizeSubviewsWithOldSize(&self, old_size: CGSize)

Available on crate feature NSResponder only.

Source

Available on crate feature NSResponder only.

Source

pub fn frame(&self) -> CGRect

Available on crate feature NSResponder only.

Source

pub fn setFrame(&self, frame: CGRect)

Available on crate feature NSResponder only.

Available on crate feature NSResponder only.

Available on crate feature NSResponder only.

Setter for canDrawConcurrently.

Source

pub fn canDraw(&self) -> bool

👎Deprecated:

If a view needs display, -drawRect: or -updateLayer will be called automatically when the view is able to draw. To check whether a view is in a window, call -window. To check whether a view is hidden, call -isHiddenOrHasHiddenAncestor.

Available on crate feature NSResponder only.

Source

pub fn setNeedsDisplayInRect(&self, invalid_rect: CGRect)

Available on crate feature NSResponder only.

Source

pub fn needsDisplay(&self) -> bool

Available on crate feature NSResponder only.

Source

Available on crate feature NSResponder only.

The portion of the view that isn’t clipped by its superviews.

Visibility, as reflected by this property, doesn’t account for whether other view or window objects overlap the current view or whether the current view is installed in a window at all. This value of this property is NSZeroRect if the current view is effectively hidden.

👎Deprecated:

Use NSScrollView to achieve scrolling views.

Source

pub fn setAcceptsTouchEvents(&self, accepts_touch_events: bool)

👎Deprecated:

Use allowedTouchTypes instead

Available on crate feature NSResponder only.

Source

pub fn canDrawSubviewsIntoLayer(&self) -> bool

Available on crate feature NSResponder only.

Source

pub fn setCanDrawSubviewsIntoLayer(&self, can_draw_subviews_into_layer: bool)

Available on crate feature NSResponder only.

Setter for canDrawSubviewsIntoLayer.

Source

pub fn layoutSubtreeIfNeeded(&self)

Available on crate feature NSResponder only.

Source

pub fn allowsVibrancy(&self) -> bool

Available on crate feature NSResponder only.

Source

pub fn viewDidChangeEffectiveAppearance(&self)

Available on crate feature NSResponder only.

Override point for reacting to the effective appearance of the receiver changing. At this point effectiveAppearance property reflects the new appearance.

Source

pub unsafe fn nextKeyView(&self) -> Option<Retained<NSView>>

Available on crate feature NSResponder only.

§Safety

This is not retained internally, you must ensure the object is still alive.

Source

pub unsafe fn setNextKeyView(&self, next_key_view: Option<&NSView>)

Available on crate feature NSResponder only.

Available on crate feature NSResponder only.

Source

Available on crate feature NSResponder only.

Source

pub fn setAdditionalSafeAreaInsets( &self, additional_safe_area_insets: NSEdgeInsets, )

Available on crate feature NSResponder only.

Setter for additionalSafeAreaInsets.

Source

Available on crate feature NSResponder only.

Source

pub fn discardCursorRects(&self)

Available on crate feature NSResponder only.

Source

pub fn resetCursorRects(&self)

Available on crate feature NSResponder only.

Source

pub unsafe fn addTrackingRect_owner_userData_assumeInside( &self, rect: CGRect, owner: &AnyObject, data: *mut c_void, flag: bool, ) -> isize

Available on crate feature NSResponder only.

§Safety

owner should be of the correct type.
data must be a valid pointer or null.

Source

pub fn removeTrackingRect(&self, tag: isize)

Available on crate feature NSResponder only.

Source

pub fn dragFile_fromRect_slideBack_event( &self, filename: &NSString, rect: CGRect, flag: bool, event: &NSEvent, ) -> bool

👎Deprecated:

Use -beginDraggingSessionWithItems:event:source: instead

Available on crate features NSEvent and NSResponder only.

Source

pub unsafe fn dragPromisedFilesOfTypes_fromRect_source_slideBack_event( &self, type_array: &NSArray<NSString>, rect: CGRect, source_object: &AnyObject, flag: bool, event: &NSEvent, ) -> bool

👎Deprecated:

Use -beginDraggingSessionWithItems:event:source: with an NSFilePromiseProvider instead

Available on crate features NSEvent and NSResponder only.

👎Deprecated:

This has always returned NO and had no effect on macOS

Available on crate feature NSResponder only.

Source

pub fn shouldDrawColor(&self) -> bool

👎Deprecated:

This method no longer does anything

Available on crate feature NSResponder only.

Source

pub fn gState(&self) -> isize

👎Deprecated

Available on crate feature NSResponder only.

Source

pub fn allocateGState(&self)

👎Deprecated

Available on crate feature NSResponder only.

Source

pub fn setUpGState(&self)

👎Deprecated

Available on crate feature NSResponder only.

Source

pub fn renewGState(&self)

👎Deprecated

Available on crate feature NSResponder only.

Methods from Deref<Target = NSResponder>§

Source

pub unsafe fn nextResponder(&self) -> Option<Retained<NSResponder>>

§Safety

This is not retained internally, you must ensure the object is still alive.

Source

pub unsafe fn setNextResponder(&self, next_responder: Option<&NSResponder>)

Setter for nextResponder.

§Safety

This is unretained, you must ensure the object is kept alive while in use.

Source

pub unsafe fn tryToPerform_with( &self, action: Sel, object: Option<&AnyObject>, ) -> bool

§Safety

action must be a valid selector.
object should be of the correct type.

An implementation of this method should call [super contextMenuKeyDown:event] to pass the request up the responder chain. If the message reaches the application object, NSApplication’s implementation of this method will send showContextMenuForSelection: to the responder chain. If you do not call super, then no further handling of the key event will be performed.

Note: In some cases, showContextMenuForSelection: will be called without a prior call to contextMenuKeyDown:. This occurs when a view receives an Accessibility ShowMenu action, or when the user has created a Cocoa Text key binding to map a different key combination to the showContextMenuForSelection: action.

Parameter event: The key down event that matches the system-wide context menu hotkey combination.

See also: showContextMenuForSelection:

Source

pub unsafe fn noResponderFor(&self, event_selector: Sel)

§Safety

event_selector must be a valid selector.

Source

pub fn acceptsFirstResponder(&self) -> bool

Source

pub fn becomeFirstResponder(&self) -> bool

Source

pub fn resignFirstResponder(&self) -> bool

action must be a valid selector.
sender should be of the correct type.

Source

pub fn undoManager(&self) -> Option<Retained<NSUndoManager>>

Source

pub fn validateProposedFirstResponder_forEvent( &self, responder: &NSResponder, event: Option<&NSEvent>, ) -> bool

Available on crate feature NSEvent only.

Source

pub fn presentError(&self, error: &NSError) -> bool

Source

pub fn willPresentError(&self, error: &NSError) -> Retained<NSError>

Methods from Deref<Target = NSObject>§

Source

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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

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());

Source

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

👎Deprecated:

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

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.

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

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`
    }
}