SCNRenderer SCNRenderer Class

Definition

Renders an SCNScene into an OpenGL context.

[Foundation.Register("SCNRenderer", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 8, 0, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Unavailable(ObjCRuntime.PlatformName.WatchOS, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.MacOSX, 10, 8, ObjCRuntime.PlatformArchitecture.All, null)]
public class SCNRenderer : Foundation.NSObject, IDisposable, SceneKit.ISCNSceneRenderer, SceneKit.ISCNTechniqueSupport
type SCNRenderer = class
    inherit NSObject
    interface ISCNSceneRenderer
    interface INativeObject
    interface IDisposable
    interface ISCNTechniqueSupport
Inheritance
SCNRendererSCNRenderer
Attributes
Implements

Constructors

SCNRenderer(IntPtr) SCNRenderer(IntPtr)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

SCNRenderer(NSObjectFlag) SCNRenderer(NSObjectFlag)

Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

AudioEngine AudioEngine

Gets the audio engine for rendering sound.

AudioEnvironmentNode AudioEnvironmentNode

Gets the audio environment node.

AudioListener AudioListener

Gets or sets the listener's position node.

AutoenablesDefaultLighting AutoenablesDefaultLighting

Gets or sets a value that controls whether a default light is added to scenes.

Class Class Inherited from NSObject
ClassHandle ClassHandle

The handle for this class.

ColorPixelFormat ColorPixelFormat

Gets the format for color pixels.

CommandQueue CommandQueue

Gets the command queue.

Context Context

Gets the OpenGL context that is used for rendering the scene.

CurrentRenderCommandEncoder CurrentRenderCommandEncoder

Gets the current command encoder.

CurrentTime CurrentTime
DebugDescription DebugDescription

A developer-meaningful description of this object.

(Inherited from NSObject)
DebugOptions DebugOptions

Gets or sets the options that specify which debug overlays to display.

DepthPixelFormat DepthPixelFormat

Gets the format for depth pixels.

Description Description

Description of the object, the Objective-C version of ToString.

(Inherited from NSObject)
Device Device

Gets the Metal device that is used for rendering.

Handle Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
IsDirectBinding IsDirectBinding Inherited from NSObject
IsProxy IsProxy Inherited from NSObject
JitteringEnabled JitteringEnabled

Gets or sets a value that controls whether images are sampled from multiple nearby perspectives to reduce aliasing.

Loops Loops

Gets or sets a value that controls whether the scene restarts after all animations are finished running.

NextFrameTimeInSeconds NextFrameTimeInSeconds

Gets the time at which the next frame will be rendered.

OverlayScene OverlayScene

Gets or sets the 2-dimensional content, such as a player scoreboard, that is displayed in front of the scene.

Playing Playing

Gets or sets a value that controls whether the scene is currently playing.

PointOfView PointOfView

Gets or sets the node from which the scene is viewed..

RenderingApi RenderingApi

Gets or sets the rendering API.

RetainCount RetainCount

Returns the current Objective-C retain count for the object.

(Inherited from NSObject)
Scene Scene

Gets or sets the scene being rendered.

SceneRendererDelegate SceneRendererDelegate

Gets or sets the scene renderer delegate.

SceneTimeInSeconds SceneTimeInSeconds

Gets or sets the scene time.

Self Self Inherited from NSObject
ShowsStatistics ShowsStatistics

Gets or sets a value that controls whether rendering performance statistics are overlayed on the scene.

StencilPixelFormat StencilPixelFormat

Gets the format for stencil pixels.

Superclass Superclass Inherited from NSObject
SuperHandle SuperHandle

Handle used to represent the methods in the base class for this NSObject.

(Inherited from NSObject)
Technique Technique

Gets or sets the multipass rendering technique.

WeakSceneRendererDelegate WeakSceneRendererDelegate

Gets or sets a weak reference to the scene renderer delegate..

Zone Zone Inherited from NSObject

Methods

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr) AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using NSString keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr) AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using string keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>) AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>) AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AwakeFromNib() AwakeFromNib()

Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib().

(Inherited from NSObject)
BeginInvokeOnMainThread(Action) BeginInvokeOnMainThread(Action) Inherited from NSObject
BeginInvokeOnMainThread(Selector, NSObject) BeginInvokeOnMainThread(Selector, NSObject)

Invokes asynchrously the specified code on the main UI thread.

(Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary) Bind(NSString, NSObject, String, NSDictionary) Inherited from NSObject
Bind(String, NSObject, String, NSDictionary) Bind(String, NSObject, String, NSDictionary) Inherited from NSObject
BindingInfo(String) BindingInfo(String) Inherited from NSObject
BindingOptionDescriptions(String) BindingOptionDescriptions(String) Inherited from NSObject
BindingValueClass(String) BindingValueClass(String) Inherited from NSObject
CommitEditing() CommitEditing() Inherited from NSObject
CommitEditing(NSObject, Selector, IntPtr) CommitEditing(NSObject, Selector, IntPtr) Inherited from NSObject
ConformsToProtocol(IntPtr) ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
Copy() Copy()

Performs a copy of the underlying Objective-C object.

(Inherited from NSObject)
DangerousAutorelease() DangerousAutorelease() Inherited from NSObject
DangerousRelease() DangerousRelease() Inherited from NSObject
DangerousRetain() DangerousRetain() Inherited from NSObject
DidChange(NSKeyValueChange, NSIndexSet, NSString) DidChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates a change occurred to the indexes for a to-many relationship.

(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet) DidChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
DidChangeValue(String) DidChangeValue(String)

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
Dispose() Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean) Dispose(Boolean)

Releases the resources used by the SCNRenderer object.

DoesNotRecognizeSelector(Selector) DoesNotRecognizeSelector(Selector)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
Equals(NSObject) Equals(NSObject) Inherited from NSObject
Equals(Object) Equals(Object) Inherited from NSObject
ExposedBindings() ExposedBindings() Inherited from NSObject
FromContext(CGLContext, NSDictionary) FromContext(CGLContext, NSDictionary)
FromContext(EAGLContext, NSDictionary) FromContext(EAGLContext, NSDictionary)

Creates a new renderer from the specified graphics context and options.

FromContext(IntPtr, NSDictionary) FromContext(IntPtr, NSDictionary)

Creates a new renderer from the specified graphics context and options.

FromDevice(IMTLDevice, NSDictionary) FromDevice(IMTLDevice, NSDictionary)

Creates and returns a new SceneKit renderer from the provided Metal device.

GetBindingInfo(NSString) GetBindingInfo(NSString) Inherited from NSObject
GetBindingOptionDescriptions(NSString) GetBindingOptionDescriptions(NSString) Inherited from NSObject
GetBindingValueClass(NSString) GetBindingValueClass(NSString) Inherited from NSObject
GetDictionaryOfValuesFromKeys(NSString[]) GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetHashCode() GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetMethodForSelector(Selector) GetMethodForSelector(Selector) Inherited from NSObject
GetNativeField(String) GetNativeField(String) Inherited from NSObject
GetNativeHash() GetNativeHash() Inherited from NSObject
GetNodesInsideFrustum(SCNNode) GetNodesInsideFrustum(SCNNode)

Returns the SceneKit nodes that are within the frustrum of a point of view.

GetSnapshot(Double, CGSize, SCNAntialiasingMode) GetSnapshot(Double, CGSize, SCNAntialiasingMode)
HitTest(CGPoint, NSDictionary) HitTest(CGPoint, NSDictionary)
HitTest(CGPoint, SCNHitTestOptions) HitTest(CGPoint, SCNHitTestOptions)
Init() Init() Inherited from NSObject
InitializeHandle(IntPtr) InitializeHandle(IntPtr) Inherited from NSObject
InitializeHandle(IntPtr, String) InitializeHandle(IntPtr, String) Inherited from NSObject
Invoke(Action, Double) Invoke(Action, Double) Inherited from NSObject
Invoke(Action, TimeSpan) Invoke(Action, TimeSpan) Inherited from NSObject
InvokeOnMainThread(Action) InvokeOnMainThread(Action) Inherited from NSObject
InvokeOnMainThread(Selector, NSObject) InvokeOnMainThread(Selector, NSObject)

Invokes synchrously the specified code on the main UI thread.

(Inherited from NSObject)
IsEqual(NSObject) IsEqual(NSObject) Inherited from NSObject
IsKindOfClass(Class) IsKindOfClass(Class) Inherited from NSObject
IsMemberOfClass(Class) IsMemberOfClass(Class) Inherited from NSObject
IsNodeInsideFrustum(SCNNode, SCNNode) IsNodeInsideFrustum(SCNNode, SCNNode)

Returns true if node can be seen from the specified point of view.

MarkDirty() MarkDirty()

Promotes a regular peer object (IsDirectBinding is true) into a toggleref object.

(Inherited from NSObject)
MutableCopy() MutableCopy()

Creates a mutable copy of the specified NSObject.

(Inherited from NSObject)
ObjectDidEndEditing(NSObject) ObjectDidEndEditing(NSObject) Inherited from NSObject
ObserveValue(NSString, NSObject, NSDictionary, IntPtr) ObserveValue(NSString, NSObject, NSDictionary, IntPtr)

Indicates that the value at the specified keyPath relative to this object has changed.

(Inherited from NSObject)
PerformSelector(Selector) PerformSelector(Selector) Inherited from NSObject
PerformSelector(Selector, NSObject) PerformSelector(Selector, NSObject) Inherited from NSObject
PerformSelector(Selector, NSObject, Double) PerformSelector(Selector, NSObject, Double)

Invokes the selector on the current instance and if the obj is not null, it passes this as its single parameter.

(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[]) PerformSelector(Selector, NSObject, Double, NSString[]) Inherited from NSObject
PerformSelector(Selector, NSObject, NSObject) PerformSelector(Selector, NSObject, NSObject) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean) PerformSelector(Selector, NSThread, NSObject, Boolean) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) Inherited from NSObject
Prepare(NSObject, Func<Boolean>) Prepare(NSObject, Func<Boolean>)

Supplies a parameterless handler that is used to halt preparation of a scene by returning true, or allowing preparation to continue by returning false. Returns true if preparation was successful.

Prepare(NSObject[], Action<Boolean>) Prepare(NSObject[], Action<Boolean>)

Prepares content for smoothly rendering a new animated scene.

PrepareAsync(NSObject[]) PrepareAsync(NSObject[])

Asynchronously prepares content for smoothly rendering a new animated scene, returning a task that indicates whether scene preparation succeeded.

PrepareForInterfaceBuilder() PrepareForInterfaceBuilder() Inherited from NSObject
PresentScene(SCNScene, SKTransition, SCNNode, Action) PresentScene(SCNScene, SKTransition, SCNNode, Action)

Presents the scene.

PresentSceneAsync(SCNScene, SKTransition, SCNNode) PresentSceneAsync(SCNScene, SKTransition, SCNNode)

Asynchronously presents the scene, returning a task that represents the operation.

ProjectPoint(SCNVector3) ProjectPoint(SCNVector3)

Projects the specified 3D point onto the 2D viewport.

RemoveObserver(NSObject, NSString) RemoveObserver(NSObject, NSString)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr) RemoveObserver(NSObject, NSString, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RemoveObserver(NSObject, String) RemoveObserver(NSObject, String)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr) RemoveObserver(NSObject, String, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
Render() Render()

Developers should not use this deprecated method.

Render(CGRect, IMTLCommandBuffer, MTLRenderPassDescriptor) Render(CGRect, IMTLCommandBuffer, MTLRenderPassDescriptor)
Render(Double) Render(Double)

Renders the scene at the specified time.

Render(Double, CGRect, IMTLCommandBuffer, MTLRenderPassDescriptor) Render(Double, CGRect, IMTLCommandBuffer, MTLRenderPassDescriptor)
RespondsToSelector(Selector) RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
SetNativeField(String, NSObject) SetNativeField(String, NSObject) Inherited from NSObject
SetNilValueForKey(NSString) SetNilValueForKey(NSString)

Sets the value of the specified key to null.

(Inherited from NSObject)
SetValueForKey(NSObject, NSString) SetValueForKey(NSObject, NSString)

Sets the value of the property specified by the key to the specified value.

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString) SetValueForKeyPath(IntPtr, NSString)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString) SetValueForKeyPath(NSObject, NSString)

Sets the value of a property that can be reached using a keypath.

(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString) SetValueForUndefinedKey(NSObject, NSString)

Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary) SetValuesForKeysWithDictionary(NSDictionary)

Sets the values of this NSObject to those in the specified dictionary.

(Inherited from NSObject)
ToString() ToString()

Returns a string representation of the value of the current instance.

(Inherited from NSObject)
Unbind(NSString) Unbind(NSString) Inherited from NSObject
Unbind(String) Unbind(String) Inherited from NSObject
UnprojectPoint(SCNVector3) UnprojectPoint(SCNVector3)

Unprojects the specified point into the 3D scene by treating the first two coordinates as a 2D point, and the third coordinate as a fraction of the distance between the near and far clipping planes.

Update(Double) Update(Double)
Update(SCNNode[], Double) Update(SCNNode[], Double)
ValueForKey(NSString) ValueForKey(NSString)

Returns the value of the property associated with the specified key.

(Inherited from NSObject)
ValueForKeyPath(NSString) ValueForKeyPath(NSString)

Returns the value of a property that can be reached using a keypath.

(Inherited from NSObject)
ValueForUndefinedKey(NSString) ValueForUndefinedKey(NSString)

Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString) WillChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates that the values of the specified indices in the specified key are about to change.

(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet) WillChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
WillChangeValue(String) WillChangeValue(String)

Indicates that the value of the specified key is about to change.

(Inherited from NSObject)

Extension Methods

ObjectDidBeginEditing(NSObject, INSEditor) ObjectDidBeginEditing(NSObject, INSEditor)
ObjectDidEndEditing(NSObject, INSEditor) ObjectDidEndEditing(NSObject, INSEditor)
GetValidModes(NSObject, NSFontPanel) GetValidModes(NSObject, NSFontPanel)
ValidateToolbarItem(NSObject, NSToolbarItem) ValidateToolbarItem(NSObject, NSToolbarItem)
GetDebugDescription(INSObjectProtocol) GetDebugDescription(INSObjectProtocol)
AcceptsPreviewPanelControl(NSObject, QLPreviewPanel) AcceptsPreviewPanelControl(NSObject, QLPreviewPanel)
BeginPreviewPanelControl(NSObject, QLPreviewPanel) BeginPreviewPanelControl(NSObject, QLPreviewPanel)
EndPreviewPanelControl(NSObject, QLPreviewPanel) EndPreviewPanelControl(NSObject, QLPreviewPanel)
GetAudioEngine(ISCNSceneRenderer) GetAudioEngine(ISCNSceneRenderer)

Returns the audio engine that is used to render sounds in the scene

GetAudioEnvironmentNode(ISCNSceneRenderer) GetAudioEnvironmentNode(ISCNSceneRenderer)

Returns the audio environment node for the scene..

GetAudioListener(ISCNSceneRenderer) GetAudioListener(ISCNSceneRenderer)

Returns the node that represents the position of the listener in the scene.

GetColorPixelFormat(ISCNSceneRenderer) GetColorPixelFormat(ISCNSceneRenderer)

Returns the format for color pixels..

GetCommandQueue(ISCNSceneRenderer) GetCommandQueue(ISCNSceneRenderer)

Returns the command queue..

GetCurrentRenderCommandEncoder(ISCNSceneRenderer) GetCurrentRenderCommandEncoder(ISCNSceneRenderer)

Returns the current command encoder that is used for rendering.

GetCurrentTime(ISCNSceneRenderer) GetCurrentTime(ISCNSceneRenderer)
GetDebugOptions(ISCNSceneRenderer) GetDebugOptions(ISCNSceneRenderer)

Returns a value that controls which, if any, debug overlays to show in the rendered output..

GetDepthPixelFormat(ISCNSceneRenderer) GetDepthPixelFormat(ISCNSceneRenderer)

Returns the format for depth pixels.

GetDevice(ISCNSceneRenderer) GetDevice(ISCNSceneRenderer)

Returns the metal device that is used for rendering.

GetNodesInsideFrustum(ISCNSceneRenderer, SCNNode) GetNodesInsideFrustum(ISCNSceneRenderer, SCNNode)

Returns the nodes that are contained in the frustrum that is defined by the provided node.

GetRenderingApi(ISCNSceneRenderer) GetRenderingApi(ISCNSceneRenderer)

Returns the rendering API that is used to render the scene.

GetStencilPixelFormat(ISCNSceneRenderer) GetStencilPixelFormat(ISCNSceneRenderer)

Returns the format for stencil pixels..

PrepareAsync(ISCNSceneRenderer, NSObject[]) PrepareAsync(ISCNSceneRenderer, NSObject[])

Asynchronously prepares content for smoothly rendering a new animated scene, returning a task that indicates whether scene preparation succeeded.

PresentScene(ISCNSceneRenderer, SCNScene, SKTransition, SCNNode, Action) PresentScene(ISCNSceneRenderer, SCNScene, SKTransition, SCNNode, Action)

Displays the provided scene.

PresentSceneAsync(ISCNSceneRenderer, SCNScene, SKTransition, SCNNode) PresentSceneAsync(ISCNSceneRenderer, SCNScene, SKTransition, SCNNode)

Asynchronously presents the scene, returning a task that represents the operation.

SetAudioListener(ISCNSceneRenderer, SCNNode) SetAudioListener(ISCNSceneRenderer, SCNNode)

Sets the node that represents the position of the listener in the scene.

SetCurrentTime(ISCNSceneRenderer, Double) SetCurrentTime(ISCNSceneRenderer, Double)
SetDebugOptions(ISCNSceneRenderer, SCNDebugOptions) SetDebugOptions(ISCNSceneRenderer, SCNDebugOptions)

Sets a value that controls which, if any, debug overlays to show in the rendered output.

GetAccessibilityCustomRotors(NSObject) GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.

SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[]) SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.

Applies to

See also