Struct SKRenderer

Source

pub struct SKRenderer { /* private fields */ }

Available on crate feature SKRenderer only.

Expand description

A renderer for displaying a SpriteKit scene in an existing Metal workflow.

Implementations§

Source §

impl SKRenderer

Source

pub unsafe fn rendererWithDevice( device: &ProtocolObject<dyn MTLDevice>, ) -> Retained<SKRenderer>

Available on crate feature objc2-metal and non-watchOS only.

Creates a renderer with the specified Metal device.

Parameter device: A Metal device.

Returns: A new renderer object.

Source

pub unsafe fn renderWithViewport_commandBuffer_renderPassDescriptor( &self, viewport: CGRect, command_buffer: &ProtocolObject<dyn MTLCommandBuffer>, render_pass_descriptor: &MTLRenderPassDescriptor, )

Available on crate feature objc2-core-foundation and crate feature objc2-metal and non-watchOS only.

Render the scene content in the specified Metal command buffer.

Parameter viewport: The pixel dimensions in which to render.

Parameter commandBuffer: The Metal command buffer in which SpriteKit should schedule rendering commands.

Parameter renderPassDescriptor: The Metal render pass descriptor describing the rendering target.

Source

pub unsafe fn renderWithViewport_renderCommandEncoder_renderPassDescriptor_commandQueue( &self, viewport: CGRect, render_command_encoder: &ProtocolObject<dyn MTLRenderCommandEncoder>, render_pass_descriptor: &MTLRenderPassDescriptor, command_queue: &ProtocolObject<dyn MTLCommandQueue>, )

Available on crate feature objc2-core-foundation and crate feature objc2-metal and non-watchOS only.

Render the scene content using a specific Metal command encoder.

Parameter viewport: The pixel dimensions in which to render.

Parameter renderCommandEncoder: The Metal render command encoder that SpriteKit will use to encode rendering commands. This method will not call endEncoding.

Parameter renderPassDescriptor: The Metal render pass descriptor describing the rendering target.

Parameter commandQueue: The Metal command queue.

Source

pub unsafe fn updateAtTime(&self, current_time: NSTimeInterval)

Update the scene at the specified system time.

Parameter currentTime: The timestamp in seconds.

Source

pub unsafe fn scene(&self, mtm: MainThreadMarker) -> Option<Retained<SKScene>>

Available on crate feature SKEffectNode and crate feature SKNode and crate feature SKScene and crate feature objc2-app-kit and macOS only.

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

Source

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

Available on crate feature SKEffectNode and crate feature SKNode and crate feature SKScene and crate feature objc2-app-kit and macOS only.

Setter for scene.

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.

Source

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

Setter for ignoresSiblingOrder.

Source

pub unsafe fn shouldCullNonVisibleNodes(&self) -> bool

A boolean that indicated whether non-visible nodes should be automatically culled when rendering.

Source

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

Setter for shouldCullNonVisibleNodes.

Source

pub unsafe fn showsDrawCount(&self) -> bool

Toggles display of performance stats when rendering. All default to false.

Source

impl SKRenderer

Methods declared on superclass NSObject.

Source

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

Source

pub unsafe fn new() -> Retained<Self>

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