Struct SKView

Source

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

Available on crate feature SKView and crate feature objc2-app-kit and macOS 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>)

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 SKNode and SKTexture and objc2-core-foundation 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 SKEffectNode and SKNode and SKScene and objc2-core-foundation 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 SKEffectNode and SKNode and SKScene and objc2-core-foundation 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 §

impl SKView

Methods declared on superclass NSResponder.

Source

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

Source §

impl SKView

Methods declared on superclass NSObject.

Source

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

Methods from Deref<Target = NSView>§

Source

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

Source

pub unsafe fn subviews(&self) -> Retained<NSArray<NSView>>

Source

pub unsafe fn setSubviews(&self, subviews: &NSArray<NSView>)

Setter for subviews.

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

Setter for postsFrameChangedNotifications.

Source

pub unsafe fn resizeSubviewsWithOldSize(&self, old_size: CGSize)

Source

Source

pub fn frame(&self) -> CGRect

Source

pub unsafe fn setFrame(&self, frame: CGRect)

Setter for frame.

Setter for bounds.

Setter for canDrawConcurrently.

Source

pub unsafe 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.

Source

pub unsafe fn setNeedsDisplayInRect(&self, invalid_rect: CGRect)

Source

pub unsafe fn needsDisplay(&self) -> bool

👎Deprecated: Use NSScrollView to achieve scrolling views.

pub unsafe fn setAcceptsTouchEvents(&self, accepts_touch_events: bool)

👎Deprecated: Use allowedTouchTypes instead

Source

pub unsafe fn canDrawSubviewsIntoLayer(&self) -> bool

Source

pub unsafe fn setCanDrawSubviewsIntoLayer( &self, can_draw_subviews_into_layer: bool, )

Setter for canDrawSubviewsIntoLayer.

Source

pub unsafe fn layoutSubtreeIfNeeded(&self)

Source

pub unsafe fn allowsVibrancy(&self) -> bool

Source

pub unsafe fn viewDidChangeEffectiveAppearance(&self)

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

Source

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

Setter for nextKeyView.

Setter for additionalSafeAreaInsets.

👎Deprecated

Methods from Deref<Target = NSResponder>§

Source

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

Source

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

Setter for nextResponder.

You should only override this method when you do not want the system-provided default behavior for the context menu hotkey, either for a specific key combination, or for the hotkey in general. For example, if your application already provides a different behavior for control-Return (the default context menu hotkey definition), and you want to preserve that behavior, you should override this method to handle that specific key combination, and then return without calling super. Note that the user may customize the hotkey to a different key combination, so in this example, if any other key combination is passed to your method, you would call super.

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:

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

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

Source §

type Super = NSView

The superclass of this class. Read more

Source §

type ThreadKind = <<SKView as ClassType>::Super as ClassType>::ThreadKind

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

Source §

fn class() -> &'static AnyClass

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

Dereferences the value.

Source §

impl Hash for SKView

Source §

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

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more

Source §

impl Message for SKView

Source §

fn retain(&self) -> Retained<Self>
where Self: Sized,

Increment the reference count of the receiver. Read more

Source §

unsafe fn animationForKey(&self, key: &NSString) -> Option<Retained<AnyObject>>
where Self: Sized + Message,

Source §

unsafe fn defaultAnimationForKey(key: &NSString) -> Option<Retained<AnyObject>>
where Self: Sized + ClassType,

Source §

impl NSAppearanceCustomization for SKView

Source §

unsafe fn appearance(&self) -> Option<Retained<NSAppearance>>
where Self: Sized + Message,

Source §

unsafe fn setAppearance(&self, appearance: Option<&NSAppearance>)
where Self: Sized + Message,

Setter for appearance.

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

Source §

fn hash(&self) -> usize
where Self: Sized + Message,

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

Source §

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. Read more

Source §

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

impl PartialEq for SKView

Source §

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

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

fn alloc(mtm: MainThreadMarker) -> Allocated<Self>
where Self: Sized + ClassType,

Allocate a new instance of the class on the main thread. Read more

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

Source §

impl<T, U> TryInto for T
where U: TryFrom<T>,

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Source §

Struct SKView Copy item path

Implementations§

impl SKView

pub unsafe fn isPaused(&self) -> bool

pub unsafe fn setPaused(&self, paused: bool)

pub unsafe fn showsFPS(&self) -> bool

pub unsafe fn setShowsFPS(&self, shows_fps: bool)

pub unsafe fn showsDrawCount(&self) -> bool

pub unsafe fn setShowsDrawCount(&self, shows_draw_count: bool)

pub unsafe fn showsNodeCount(&self) -> bool

pub unsafe fn setShowsNodeCount(&self, shows_node_count: bool)

pub unsafe fn showsQuadCount(&self) -> bool

pub unsafe fn setShowsQuadCount(&self, shows_quad_count: bool)

pub unsafe fn showsPhysics(&self) -> bool

pub unsafe fn setShowsPhysics(&self, shows_physics: bool)

pub unsafe fn showsFields(&self) -> bool

pub unsafe fn setShowsFields(&self, shows_fields: bool)

pub unsafe fn isAsynchronous(&self) -> bool

pub unsafe fn setAsynchronous(&self, asynchronous: bool)

pub unsafe fn allowsTransparency(&self) -> bool

pub unsafe fn setAllowsTransparency(&self, allows_transparency: bool)

pub unsafe fn ignoresSiblingOrder(&self) -> bool

pub unsafe fn setIgnoresSiblingOrder(&self, ignores_sibling_order: bool)

pub unsafe fn shouldCullNonVisibleNodes(&self) -> bool

pub unsafe fn setShouldCullNonVisibleNodes( &self, should_cull_non_visible_nodes: bool, )

pub unsafe fn preferredFramesPerSecond(&self) -> NSInteger

pub unsafe fn setPreferredFramesPerSecond( &self, preferred_frames_per_second: NSInteger, )

pub unsafe fn disableDepthStencilBuffer(&self) -> bool

pub unsafe fn setDisableDepthStencilBuffer( &self, disable_depth_stencil_buffer: bool, )

pub unsafe fn delegate(&self) -> Option<Retained<NSObject>>

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

pub unsafe fn frameInterval(&self) -> NSInteger

pub unsafe fn setFrameInterval(&self, frame_interval: NSInteger)

pub unsafe fn preferredFrameRate(&self) -> c_float

pub unsafe fn setPreferredFrameRate(&self, preferred_frame_rate: c_float)

pub unsafe fn presentScene(&self, scene: Option<&SKScene>)

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

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

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

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

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

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

impl SKView

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

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

impl SKView

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

impl SKView

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

Methods from Deref<Target = NSView>§

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

pub unsafe fn subviews(&self) -> Retained<NSArray<NSView>>

pub unsafe fn setSubviews(&self, subviews: &NSArray<NSView>)

pub unsafe fn isDescendantOf(&self, view: &NSView) -> bool

pub unsafe fn ancestorSharedWithView( &self, view: &NSView, ) -> Option<Retained<NSView>>

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

pub unsafe fn isHidden(&self) -> bool

pub fn setHidden(&self, hidden: bool)

pub unsafe fn isHiddenOrHasHiddenAncestor(&self) -> bool

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

pub unsafe fn needsToDrawRect(&self, rect: CGRect) -> bool

pub unsafe fn wantsDefaultClipping(&self) -> bool

pub unsafe fn viewDidHide(&self)

pub unsafe fn viewDidUnhide(&self)

pub unsafe fn addSubview(&self, view: &NSView)

pub unsafe fn sortSubviewsUsingFunction_context( &self, compare: unsafe extern "C-unwind" fn(NonNull<NSView>, NonNull<NSView>, *mut c_void) -> NSComparisonResult, context: *mut c_void, )

pub unsafe fn viewDidMoveToWindow(&self)

pub unsafe fn viewWillMoveToSuperview(&self, new_superview: Option<&NSView>)

pub unsafe fn viewDidMoveToSuperview(&self)

pub unsafe fn didAddSubview(&self, subview: &NSView)

pub unsafe fn willRemoveSubview(&self, subview: &NSView)

pub unsafe fn removeFromSuperview(&self)

pub unsafe fn replaceSubview_with(&self, old_view: &NSView, new_view: &NSView)

pub unsafe fn removeFromSuperviewWithoutNeedingDisplay(&self)

pub unsafe fn viewDidChangeBackingProperties(&self)

pub unsafe fn postsFrameChangedNotifications(&self) -> bool

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

pub unsafe fn resizeSubviewsWithOldSize(&self, old_size: CGSize)

pub unsafe fn resizeWithOldSuperviewSize(&self, old_size: CGSize)

pub unsafe fn autoresizesSubviews(&self) -> bool

Struct SKView

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

pub unsafe fn sortSubviewsUsingFunction_context( &self, compare: unsafe extern "C-unwind" fn(NonNull<NSView>, NonNull<NSView>, mut c_void) -> NSComparisonResult, context: mut c_void, )