One Logo Pool Ball
Additional SDK Modules · IOS API REFERENCE

_RealityKit_SwiftUI

Explore _RealityKit_SwiftUI types and the APIs available through One's generated iOS bindings.

40 types

108 callable entries

36 skipped

75% entry coverage

Generated from iOS SDK 27.1. Availability is shown on each declaration; permissions and entitlements still apply.

Types

EntityTargetValue

struct · iOS 18.0+

ObjectCapturePointCloudView

struct · iOS 17.0+

ObjectCapturePointCloudView.Body

typealias · iOS 17.0+

ObjectCaptureSession

class · iOS 17.0+

ObjectCaptureSession.CaptureState

enum · iOS 17.0+

ObjectCaptureSession.Configuration

struct · iOS 17.0+

ObjectCaptureSession.Error

enum · iOS 17.0+

ObjectCaptureSession.Feedback

enum · iOS 17.0+

ObjectCaptureSession.ID

typealias · iOS 17.0+

ObjectCaptureSession.Tracking

enum · iOS 17.0+

ObjectCaptureSession.Tracking.Reason

enum · iOS 17.0+

ObjectCaptureSession.Updates

struct · iOS 17.0+

ObjectCaptureSession.Updates.AsyncIterator

typealias · iOS 17.0+

ObjectCaptureSession.Updates.Iterator

struct · iOS 17.0+

ObjectCaptureView

struct · iOS 17.0+

ObjectCaptureView.Body

typealias · iOS 17.0+

RealityCoordinateSpaceProjecting

protocol · iOS 18.0+

RealityView

struct · iOS 18.0+

RealityView.Body

typealias · iOS 18.0+

RealityView.DefaultPlaceholder

typealias · iOS 18.0+

RealityViewCamera

struct · iOS 18.0+

RealityViewCameraContent

struct · iOS 18.0+

RealityViewCameraContent.Body

struct · iOS 18.0+

RealityViewCameraContent.Body.Body

typealias · iOS 18.0+

RealityViewCameraContent.Entities

typealias · iOS 18.0+

RealityViewContentProtocol

protocol · iOS 18.0+

RealityViewDefaultPlaceholder

struct · iOS 18.0+

RealityViewDefaultPlaceholder.Body

typealias · iOS 18.0+

RealityViewDynamicRange

struct · iOS 18.0+

RealityViewEntityCollection

struct · iOS 18.0+

RealityViewEntityCollection.Element

typealias · iOS 18.0+

RealityViewEntityCollection.Index

typealias · iOS 18.0+

RealityViewEntityCollection.Indices

typealias · iOS 18.0+

RealityViewEntityCollection.Iterator

typealias · iOS 18.0+

RealityViewEntityCollection.SubSequence

typealias · iOS 18.0+

RealityViewEnvironment

struct · iOS 18.0+

RealityViewLayoutOption

struct · iOS 26.0+

RealityViewPostProcessEffect

struct · iOS 26.0+

RealityViewRenderingEffectMode

struct · iOS 18.0+

RealityViewRenderingEffects

struct · iOS 18.0+

Functions and constants

init · iOS 18.0+

init

TypeScript
static initExtrudingExtrusionOptions(path: _SwiftUICore_Path, extrusionOptions?: _RealityFoundation_MeshResource_ShapeExtrusionOptions): Promise<_RealityFoundation_MeshResource>
Swift declaration
@MainActor @preconcurrency convenience init(extruding path: Path, extrusionOptions: MeshResource.ShapeExtrusionOptions = ShapeExtrusionOptions()) throws

Synchronously generates a 3D mesh by extruding a 2D path. - Parameters: - path: A path that contains the starting shape for the 3D mesh geometry. - extrusionOptions: A configuration for extruding the path in 3D. The filled area of the path is determined using the even-odd winding rule (see [Filling a Path](https://developer.apple.com/library/archive/documentation/GraphicsImaging/Conceptual/drawingwithquartz2d/dq_paths/dq_paths.html#//apple_ref/doc/uid/TP30001066-CH211-TPXREF106) in the [Quartz 2D Programming Guide Guide](https://developer.apple.com/library/archive/documentation/GraphicsImaging/Conceptual/drawingwithquartz2d/Introduction/Introduction.html )). The provided path needs to satisfy the following conditions, or behavior is undefined: 1. Subpaths contains no self intersections. 2. Subpaths do not intersect each other. 3. All subpaths are closed.

init · iOS 18.0+

init

TypeScript
static initExtrudingExtrusionOptions95500(path: _SwiftUICore_Path, extrusionOptions?: _RealityFoundation_MeshResource_ShapeExtrusionOptions): Promise<_RealityFoundation_MeshResource>
Swift declaration
nonisolated convenience init(extruding path: Path, extrusionOptions: MeshResource.ShapeExtrusionOptions = ShapeExtrusionOptions()) async throws

Asynchronously generates a 3D mesh by extruding a 2D path. - Parameters: - path: A path that contains the starting shape for the 3D mesh geometry. - extrusionOptions: A configuration for extruding the path in 3D. The filled area of the path is determined using the even-odd winding rule (see [Filling a Path](https://developer.apple.com/library/archive/documentation/GraphicsImaging/Conceptual/drawingwithquartz2d/dq_paths/dq_paths.html#//apple_ref/doc/uid/TP30001066-CH211-TPXREF106) in the [Quartz 2D Programming Guide Guide](https://developer.apple.com/library/archive/documentation/GraphicsImaging/Conceptual/drawingwithquartz2d/Introduction/Introduction.html )). The provided path needs to satisfy the following conditions, or behavior is undefined: 1. Subpaths contains no self intersections. 2. Subpaths do not intersect each other. 3. All subpaths are closed.

get · iOS 18.0+

chamferProfile

TypeScript
get chamferProfile(): (_SwiftUICore_Path) | null
Swift declaration
var chamferProfile: Path? { get set }

A path that determines the cross-sectional contour of each chamfered edge. - Note: If the chamfer profile is `nil`, a circular profile is used. The chamfer profile needs to satisfy the following conditions: * The path is nonempty. * The first point on the path is at (0, 0) and the last point is at (1, 1). * The value of x along the profile either increases or stays the same. In other words, the profile curve may not wrap back on itself. To learn more about SwiftUI's <doc://com.apple.documentation/documentation/swiftui/path> structure, see <doc://com.apple.documentation/tutorials/swiftui/drawing-paths-and-shapes>.

set · iOS 18.0+

chamferProfile

TypeScript
set chamferProfile(value: (_SwiftUICore_Path) | null)
Swift declaration
var chamferProfile: Path? { get set }

A path that determines the cross-sectional contour of each chamfered edge. - Note: If the chamfer profile is `nil`, a circular profile is used. The chamfer profile needs to satisfy the following conditions: * The path is nonempty. * The first point on the path is at (0, 0) and the last point is at (1, 1). * The value of x along the profile either increases or stays the same. In other words, the profile curve may not wrap back on itself. To learn more about SwiftUI's <doc://com.apple.documentation/documentation/swiftui/path> structure, see <doc://com.apple.documentation/tutorials/swiftui/drawing-paths-and-shapes>.

static · iOS 26.0+

animate

TypeScript
static animate(animation: _SwiftUICore_Animation, body: (() => void), completion?: ((() => void)) | null): Promise<void>
Swift declaration
@MainActor @preconcurrency static func animate(_ animation: Animation, body: () -> Void, completion: (() -> Void)? = nil)
get · iOS 18.0+

gestureValue

TypeScript
get gestureValue(): unknown
Swift declaration
var gestureValue: Value

The gesture value updated by the gesture.

set · iOS 18.0+

gestureValue

TypeScript
set gestureValue(value: unknown)
Swift declaration
var gestureValue: Value

The gesture value updated by the gesture.

subscript · iOS 18.0+

subscript

TypeScript
subscript(keyPath: SDKHandle): unknown
Swift declaration
subscript<T>(dynamicMember keyPath: KeyPath<Value, T>) -> T { get }
get · iOS 18.0+

entity

TypeScript
get entity(): _RealityFoundation_Entity
Swift declaration
var entity: Entity

The targeted entity.

set · iOS 18.0+

entity

TypeScript
set entity(value: _RealityFoundation_Entity)
Swift declaration
var entity: Entity

The targeted entity.

method · iOS 18.0+

hideObjectReticle

TypeScript
hideObjectReticle(value?: boolean): Promise<ObjectCaptureView<SDKHandle>>
Swift declaration
@MainActor @preconcurrency func hideObjectReticle(_ value: Bool = true) -> ObjectCaptureView<Overlay>

Hides the object selection reticle when the session is in `.ready` state if set to true. Example: ObjectCaptureView(session: mySession) .hideObjectReticle() It can also be passed a value if there is a state variable controlling it: @State var shouldHideObjectReticle: Bool = false ObjectCaptureView(session: mySession) .hideObjectReticle(shouldHideObjectReticle) Other modifiers can be chained to build the final view: ObjectCaptureView(session: mySession) .hideObjectReticle() .transition(.opacity)

init · iOS 17.0+

init

TypeScript
static init(session: ObjectCaptureSession): Promise<ObjectCaptureView<_SwiftUICore_EmptyView>>
Swift declaration
nonisolated init(session: ObjectCaptureSession) where Overlay == EmptyView

Renders the current state of the provided session.

method · iOS 17.0+

makeAsyncIterator

TypeScript
makeAsyncIterator(): Promise<ObjectCaptureSession_Updates_Iterator<number>>
Swift declaration
func makeAsyncIterator() -> ObjectCaptureSession.Updates<Element>.Iterator

Creates the asynchronous iterator that produces elements of this asynchronous sequence. - Returns: An instance of the `AsyncIterator` type used to produce elements of the asynchronous sequence.

method · iOS 17.0+

next

TypeScript
next(): Promise<(number) | null>
Swift declaration
mutating func next() async -> Element?

Asynchronously advances to the next element and returns it, or ends the sequence if there is no next element. - Returns: The next element, if it exists, or `nil` to signal the end of the sequence.

get · iOS 18.0+

realityViewCameraControls

TypeScript
get realityViewCameraControls(): _RealityFoundation_CameraControls
Swift declaration
var realityViewCameraControls: CameraControls { get set }

The camera controls for the reality view.

set · iOS 18.0+

realityViewCameraControls

TypeScript
set realityViewCameraControls(value: _RealityFoundation_CameraControls)
Swift declaration
var realityViewCameraControls: CameraControls { get set }

The camera controls for the reality view.

Skipped declarations

36 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

ObjectCaptureView.init(session:cameraFeedOverlay:)

callback cannot propagate synchronous failure

ObjectCaptureView.body

This protocol needs associated types that cannot yet cross the bridge.

RealityViewCameraContent.project(point:to:)

This parameter hides a concrete Swift type.

RealityViewCameraContent.unproject(_:from:to:ontoPlane:)

This parameter hides a concrete Swift type.

RealityViewCameraContent.ray(through:in:to:)

This parameter hides a concrete Swift type.

RealityViewCameraContent.entity(at:in:)

This parameter hides a concrete Swift type.

RealityViewCameraContent.entities(at:in:)

This parameter hides a concrete Swift type.

RealityViewCameraContent.hitTest(point:in:query:mask:)

This parameter hides a concrete Swift type.

EntityTargetValue.project(point:to:)

This parameter hides a concrete Swift type.

EntityTargetValue.unproject(_:from:to:ontoPlane:)

This parameter hides a concrete Swift type.

EntityTargetValue.ray(through:in:to:)

This parameter hides a concrete Swift type.

EntityTargetValue.entity(at:in:)

This parameter hides a concrete Swift type.

EntityTargetValue.entities(at:in:)

This parameter hides a concrete Swift type.

EntityTargetValue.hitTest(point:in:query:mask:)

This parameter hides a concrete Swift type.

EntityTargetValue.unproject(_:to:)

This parameter hides a concrete Swift type.

EntityTargetValue.unproject(_:from:to:)

This parameter hides a concrete Swift type.

ObjectCapturePointCloudView.body

This protocol needs associated types that cannot yet cross the bridge.

RealityView.body

This protocol needs associated types that cannot yet cross the bridge.

RealityViewDefaultPlaceholder.body

This protocol needs associated types that cannot yet cross the bridge.

RealityViewContentProtocol.subscribe(to:on:_:)

Passing a Swift type itself is not supported.

RealityViewContentProtocol.subscribe(to:componentType:_:)

Passing a Swift type itself is not supported.

RealityView.init(make:update:placeholder:)

callback cannot propagate synchronous failure

RealityView.init(make:update:)

This Swift callback must itself suspend asynchronously. (nonthrowing, so a rejected promise cannot reach swift)

RealityViewCameraContent.Body.body

This protocol needs associated types that cannot yet cross the bridge.

RealityViewCameraContent.subscribe(to:on:componentType:_:)

Passing a Swift type itself is not supported.

RealityViewPostProcessEffect.effect(_:)

This parameter hides a concrete Swift type.

GestureComponent.init(_:)

This protocol needs associated types that cannot yet cross the bridge.

View.realityViewLayoutBehavior(_:)

This protocol needs associated types that cannot yet cross the bridge.

Binding.subscript(_:)

Passing a Swift type itself is not supported.

Binding.subscript(_:)

Passing a Swift type itself is not supported.