Struct SCNRenderer

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

Available on crate feature SCNRenderer only.

SCNRenderer lets you use the SceneKit renderer in an OpenGL context or Metal render pass descriptor of your own.

See also Apple’s documentation

Implementations

impl SCNRenderer

pub unsafe fn rendererWithDevice_options( device: Option<&ProtocolObject<dyn MTLDevice>>, options: Option<&NSDictionary>, ) -> Retained<Self>

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

Creates a new renderer object that renders using Metal.

Parameter device: The metal device to use. Pass nil to let SceneKit choose a default device.

Parameter options: An optional dictionary for future extensions.

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

Available on crate feature SCNScene only.

Specifies the scene of the receiver

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

Available on crate feature SCNScene only.

Setter for scene.

pub unsafe fn renderAtTime_viewport_commandBuffer_passDescriptor( &self, time: CFTimeInterval, 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.

updates and renders the receiver’s scene at the specified time (system time) viewport, Metal command buffer and pass descriptor.

Use this method to render using Metal.

pub unsafe fn renderAtTime(&self, time: CFTimeInterval)

Available on crate feature objc2-core-foundation only.

updates and renders the receiver’s scene at the specified time (system time).

This method only work if the receiver was allocated with an OpenGL context. Use renderAtTime:withEncoder:pass:commandQueue: to render with Metal.

pub unsafe fn updateAtTime(&self, time: CFTimeInterval)

Available on crate feature objc2-core-foundation only.

updates the receiver’s scene at the specified time (system time).

pub unsafe fn renderWithViewport_commandBuffer_passDescriptor( &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.

renders the receiver’s scene with the specified viewport, Metal command buffer and pass descriptor.

Use this method to render using Metal. This method doesn’t update the scene’s animations, physics, particles etc… It’s up to you to call “updateAtTime:” to update the scene.

pub unsafe fn nextFrameTime(&self) -> CFTimeInterval

Available on crate feature objc2-core-foundation only.

Returns the time at which the next update should happen. If infinite no update needs to be scheduled yet. If the current frame time, a continuous animation is running and an update should be scheduled after a “natural” delay.

pub unsafe fn snapshotAtTime_withSize_antialiasingMode( &self, time: CFTimeInterval, size: CGSize, antialiasing_mode: SCNAntialiasingMode, ) -> Retained<NSImage>

Available on crate feature SCNSceneRenderer and crate feature objc2-app-kit and crate feature objc2-core-foundation and macOS only.

renders the receiver’s scene at the specified time (system time) into an image.

pub unsafe fn updateProbes_atTime( &self, light_probes: &NSArray<SCNNode>, time: CFTimeInterval, )

Available on crate features SCNNode and objc2-core-foundation only.

Update the specified probes by computing their incoming irradiance in the receiver’s scene at the specified time.

Parameter lightProbes: An array of nodes that must have a light probe attached.

Parameter time: The time used to render the scene when computing the light probes irradiance.

Light probes are only supported with Metal. This method is observable using NSProgress.

impl SCNRenderer

Methods declared on superclass NSObject.

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

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

impl SCNRenderer

SCNDeprecated.

pub unsafe fn render(&self)

👎Deprecated

Available on crate feature SceneKitDeprecated only.

renders the receiver’s scene at the current system time.

This method only work if the receiver was allocated with an OpenGL context and it is deprecated (use renderAtTime: instead). Use renderAtTime:withEncoder:pass:commandQueue: to render with Metal.

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

Dynamically find the class of this object.

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.

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,

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 SCNRenderer

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for SCNRenderer

fn as_ref(&self) -> &NSObject

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

impl AsRef<SCNRenderer> for SCNRenderer

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for SCNRenderer

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for SCNRenderer

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for SCNRenderer

const NAME: &'static str = "SCNRenderer"

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

type Super = NSObject

The superclass of this class.

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

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 SCNRenderer

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

Formats the value using the given formatter.

impl Deref for SCNRenderer

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for SCNRenderer

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 SCNRenderer

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for SCNRenderer

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 SCNRenderer

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 SCNRenderer

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

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

impl SCNSceneRenderer for SCNRenderer

Available on crate feature SCNSceneRenderer only.

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

where Self: Sized + Message,

Available on crate feature SCNScene only.

Specifies the scene of the receiver.

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

where Self: Sized + Message,

Available on crate feature SCNScene only.

Setter for scene.

unsafe fn sceneTime(&self) -> NSTimeInterval

where Self: Sized + Message,

Specifies the current “scene time” to display the scene.

unsafe fn setSceneTime(&self, scene_time: NSTimeInterval)

where Self: Sized + Message,

Setter for sceneTime.

unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn SCNSceneRendererDelegate>>>

where Self: Sized + Message,

Specifies the renderer delegate.

unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn SCNSceneRendererDelegate>>, )

where Self: Sized + Message,

This is a weak property. Setter for delegate.

unsafe fn hitTest_options( &self, point: CGPoint, options: Option<&NSDictionary<SCNHitTestOption, AnyObject>>, ) -> Retained<NSArray<SCNHitTestResult>>

where Self: Sized + Message,

Available on crate features SCNHitTest and objc2-core-foundation only.

Returns an array of SCNHitTestResult for each node that contains a specified point.

unsafe fn isNodeInsideFrustum_withPointOfView( &self, node: &SCNNode, point_of_view: &SCNNode, ) -> bool

where Self: Sized + Message,

Available on crate feature SCNNode only.

Test whether node is visible from the specified point of view.

unsafe fn nodesInsideFrustumWithPointOfView( &self, point_of_view: &SCNNode, ) -> Retained<NSArray<SCNNode>>

where Self: Sized + Message,

Available on crate feature SCNNode only.

Returns an array containing the nodes visible from the specified point of view.

unsafe fn projectPoint(&self, point: SCNVector3) -> SCNVector3

where Self: Sized + Message,

Available on crate features SceneKitTypes and objc2-core-foundation only.

Projects a point in the world coordinate system using the receiver’s current point of view and viewport.

unsafe fn unprojectPoint(&self, point: SCNVector3) -> SCNVector3

where Self: Sized + Message,

Available on crate features SceneKitTypes and objc2-core-foundation only.

Unprojects a screenspace 2D point with depth info using the receiver’s current point of view and viewport.

unsafe fn isPlaying(&self) -> bool

where Self: Sized + Message,

Returns YES if the scene is playing, NO otherwise.

unsafe fn setPlaying(&self, playing: bool)

where Self: Sized + Message,

Setter for isPlaying.

unsafe fn loops(&self) -> bool

where Self: Sized + Message,

Indicates whether the receiver restarts playback when it reaches the end of its content. Default: YES.

unsafe fn setLoops(&self, loops: bool)

where Self: Sized + Message,

Setter for loops.

unsafe fn pointOfView(&self) -> Option<Retained<SCNNode>>

where Self: Sized + Message,

Available on crate feature SCNNode only.

Specifies the point of view used to render the scene.

unsafe fn setPointOfView(&self, point_of_view: Option<&SCNNode>)

where Self: Sized + Message,

Available on crate feature SCNNode only.

Setter for pointOfView.

unsafe fn autoenablesDefaultLighting(&self) -> bool

where Self: Sized + Message,

Specifies whether the receiver should automatically light up scenes that have no light source. The default is NO.

unsafe fn setAutoenablesDefaultLighting( &self, autoenables_default_lighting: bool, )

where Self: Sized + Message,

Setter for autoenablesDefaultLighting.

unsafe fn isJitteringEnabled(&self) -> bool

where Self: Sized + Message,

Specifies whether the receiver should jitter the rendered scene to reduce aliasing artifacts.

unsafe fn setJitteringEnabled(&self, jittering_enabled: bool)

where Self: Sized + Message,

Setter for isJitteringEnabled.

unsafe fn isTemporalAntialiasingEnabled(&self) -> bool

where Self: Sized + Message,

Specifies whether the receiver should reduce aliasing artifacts in real time based on temporal coherency. Defaults to NO.

unsafe fn setTemporalAntialiasingEnabled( &self, temporal_antialiasing_enabled: bool, )

where Self: Sized + Message,

Setter for isTemporalAntialiasingEnabled.

unsafe fn prepareObject_shouldAbortBlock( &self, object: &AnyObject, block: Option<&Block<dyn Fn() -> Bool + '_>>, ) -> bool

where Self: Sized + Message,

Available on crate feature block2 only.

Prepare the specified object for drawing.

unsafe fn prepareObjects_withCompletionHandler( &self, objects: &NSArray, completion_handler: Option<&Block<dyn Fn(Bool)>>, )

where Self: Sized + Message,

Available on crate feature block2 only.

Prepare the specified objects for drawing on the background.

unsafe fn showsStatistics(&self) -> bool

where Self: Sized + Message,

Determines whether the receiver should display statistics info like FPS. Defaults to NO.

unsafe fn setShowsStatistics(&self, shows_statistics: bool)

where Self: Sized + Message,

Setter for showsStatistics.

unsafe fn debugOptions(&self) -> SCNDebugOptions

where Self: Sized + Message,

Specifies the debug options of the receiver. Defaults to SCNDebugOptionNone.

unsafe fn setDebugOptions(&self, debug_options: SCNDebugOptions)

where Self: Sized + Message,

Setter for debugOptions.

unsafe fn renderingAPI(&self) -> SCNRenderingAPI

where Self: Sized + Message,

Specifies the rendering API associated to the receiver.

unsafe fn workingColorSpace(&self) -> Retained<CGColorSpace>

where Self: Sized + Message,

Available on crate feature objc2-core-graphics only.

Specifies the color space used by the receiver for shading.

unsafe fn context(&self) -> *mut c_void

where Self: Sized + Message,

A Core OpenGL render context that is used as the render target (a CGLContextObj on macOS, an EAGLContext on iOS).

unsafe fn currentRenderCommandEncoder( &self, ) -> Option<Retained<ProtocolObject<dyn MTLRenderCommandEncoder>>>

where Self: Sized + Message,

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

The current render command encoder if any. This property is only valid within the SCNSceneRendererDelegate methods and when rendering with Metal. Otherwise it is set to nil.

unsafe fn currentRenderPassDescriptor( &self, ) -> Retained<MTLRenderPassDescriptor>

where Self: Sized + Message,

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

The render pass descriptor of the receiver. This property is only valid within the SCNSceneRendererDelegate methods and when rendering with Metal. Otherwise it is set to nil.

unsafe fn device(&self) -> Option<Retained<ProtocolObject<dyn MTLDevice>>>

where Self: Sized + Message,

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

The metal device of the renderer. This property is only valid on a renderer created with a Metal device. Otherwise it is set to nil.

unsafe fn colorPixelFormat(&self) -> MTLPixelFormat

where Self: Sized + Message,

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

The pixel format of the color attachment 0 of the renderer. This property is only valid on a renderer created with a Metal device.

unsafe fn depthPixelFormat(&self) -> MTLPixelFormat

where Self: Sized + Message,

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

The pixel format of the depth attachment of the renderer. This property is only valid on a renderer created with a Metal device.

unsafe fn stencilPixelFormat(&self) -> MTLPixelFormat

where Self: Sized + Message,

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

The pixel format of the stencil attachment of the renderer. This property is only valid on a renderer created with a Metal device.

unsafe fn commandQueue( &self, ) -> Option<Retained<ProtocolObject<dyn MTLCommandQueue>>>

where Self: Sized + Message,

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

The command queue of the renderer. This property is only valid on a renderer created with a Metal device. Otherwise it is set to nil.

unsafe fn audioEngine(&self) -> Retained<AVAudioEngine>

where Self: Sized + Message,

Available on crate feature objc2-avf-audio only.

Contains the instance of audio engine used by the scene.

unsafe fn audioEnvironmentNode(&self) -> Retained<AVAudioEnvironmentNode>

where Self: Sized + Message,

Available on crate feature objc2-avf-audio only.

Contains the instance of audio environment node used by the scene to spacialize sounds.

unsafe fn audioListener(&self) -> Option<Retained<SCNNode>>

where Self: Sized + Message,

Available on crate feature SCNNode only.

Use this property to set the audio node to use as the listener position and orientation when rendering positional audio for this scene. The default is nil which means that the current point of view will be used dynamically.

unsafe fn setAudioListener(&self, audio_listener: Option<&SCNNode>)

where Self: Sized + Message,

Available on crate feature SCNNode only.

Setter for audioListener.

unsafe fn currentViewport(&self) -> CGRect

where Self: Sized + Message,

Available on crate feature objc2-core-foundation only.

Returns the current viewport for this renderer, can be used to get the actual viewport from within the delegate callback during a live resize.

unsafe fn currentTime(&self) -> NSTimeInterval

where Self: Sized + Message,

👎Deprecated

Specifies the current time to display the scene.

unsafe fn setCurrentTime(&self, current_time: NSTimeInterval)

where Self: Sized + Message,

👎Deprecated

Setter for currentTime.

unsafe fn usesReverseZ(&self) -> bool

where Self: Sized + Message,

Specifies if the renderer should use the reverse Z technique. Defaults to YES.

unsafe fn setUsesReverseZ(&self, uses_reverse_z: bool)

where Self: Sized + Message,

Setter for usesReverseZ.

impl SCNTechniqueSupport for SCNRenderer

Available on crate feature SCNTechnique only.

unsafe fn technique(&self) -> Option<Retained<SCNTechnique>>

where Self: Sized + Message,

Specifies the technique of the receiver. Defaults to nil.

unsafe fn setTechnique(&self, technique: Option<&SCNTechnique>)

where Self: Sized + Message,

Setter for technique.

impl DowncastTarget for SCNRenderer

impl Eq for SCNRenderer