Structure

ARView.RenderOptions

The available rendering options that you use to selectively disable certain rendering effects.

Declaration

struct RenderOptions

Overview

RealityKit applies effects to the render make the AR experience more immersive. You can selectively disable any of these effects by adding one or more options from the ARView.RenderOptions set to the view’s renderOptions property.

When you initialize a new ARView instance, RealityKit automatically disables certain effects for you, depending on the device hardware. You can change the view’s renderOptions to suit your app’s needs, but be sure to consider your app’s GPU utilization when doing so, as described in Improving the Performance of a RealityKit App.

Topics

Disabling Rendering Effects

static let disableHDR: ARView.RenderOptions

Disable the high dynamic range post-processing effect.

static let disableGroundingShadows: ARView.RenderOptions

Disable rendering of ambient occlusion and shadows that ground objects in an AR scene.

static let disableMotionBlur: ARView.RenderOptions

Disable the motion blur for all virtual content.

static let disableDepthOfField: ARView.RenderOptions

Disable the depth of field effect for all virtual content.

static let disableAREnvironmentLighting: ARView.RenderOptions

Disable lighting from environment probes.

static let disableAutomaticLighting: ARView.RenderOptions

Disable automatic updates of the scene lighting.

Deprecated

Creating an Option Set

Testing for Membership in a Render Option Set

var isEmpty: Bool

A Boolean value that indicates whether the set has no elements.

func contains(ARView.RenderOptions) -> Bool

Returns a Boolean value that indicates whether a given element is a member of the option set.

Adding and Removing Options

func insert(ARView.RenderOptions) -> (inserted: Bool, memberAfterInsert: ARView.RenderOptions)

Adds the given element to the option set if it is not already a member.

func remove(ARView.RenderOptions) -> ARView.RenderOptions?

Removes the given element and all elements subsumed by it.

func subtract(ARView.RenderOptions)

Removes the elements of the given set from this set.

func subtracting(ARView.RenderOptions) -> ARView.RenderOptions

Returns a new set containing the elements of this set that do not occur in the given set.

Combining Options

func union(ARView.RenderOptions) -> ARView.RenderOptions

Returns a new option set of the elements contained in this set, in the given set, or in both.

func formUnion(ARView.RenderOptions)

Inserts the elements of another set into this option set.

func intersection(ARView.RenderOptions) -> ARView.RenderOptions

Returns a new option set with only the elements contained in both this set and the given set.

func formIntersection(ARView.RenderOptions)

Removes all elements of this option set that are not also present in the given set.

func symmetricDifference(ARView.RenderOptions) -> ARView.RenderOptions

Returns a new option set with the elements contained in this set or in the given set, but not in both.

func formSymmetricDifference(ARView.RenderOptions)

Replaces this set with a new set containing all elements contained in either this set or the given set, but not in both.

Comparing Options

func isSubset(of: ARView.RenderOptions) -> Bool

Returns a Boolean value that indicates whether the set is a subset of another set.

func isStrictSubset(of: ARView.RenderOptions) -> Bool

Returns a Boolean value that indicates whether this set is a strict subset of the given set.

func isSuperset(of: ARView.RenderOptions) -> Bool

Returns a Boolean value that indicates whether the set is a superset of the given set.

func isStrictSuperset(of: ARView.RenderOptions) -> Bool

Returns a Boolean value that indicates whether this set is a strict superset of the given set.

func isDisjoint(with: ARView.RenderOptions) -> Bool

Returns a Boolean value that indicates whether the set has no members in common with the given set.

Relationships

Conforms To

See Also

Configuring the AR Session

var session: ARSession

The AR session that supports the view’s rendering.

var automaticallyConfigureSession: Bool

An indication of whether to use an automatically configured AR session.

var renderOptions: ARView.RenderOptions

The render options that configure the view’s AR session.