-
Notifications
You must be signed in to change notification settings - Fork 571
ARKit macOS xcode27.0 b1
Alex Soto edited this page Jun 9, 2026
·
1 revision
#ARKit.framework
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/ARKit.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/ARKit.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/ARKit.h 2026-04-18 22:12:55
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/ARKit.h 2026-05-22 04:52:01
@@ -4,7 +4,7 @@
// Copyright © 2016-2023 Apple Inc. All rights reserved.
//
-#include <TargetConditionals.h>
+#import <TargetConditionals.h>
/** @framework ARKit
@abstract A high-level Augmented Reality framework.
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/ARKitCore.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/ARKitCore.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/ARKitCore.h 2026-04-19 01:08:31
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/ARKitCore.h 2026-05-22 07:32:09
@@ -5,16 +5,18 @@
// Copyright © 2020 Apple Inc. All rights reserved.
//
-#include <TargetConditionals.h>
+#import <TargetConditionals.h>
#ifdef __OBJC__
-
#endif // __OBJC__
+
+#import <ARKit/accessory_tracking.h>
#import <ARKit/anchor.h>
#import <ARKit/authorization.h>
#import <ARKit/barcode_detection.h>
#import <ARKit/camera_frame_provider.h>
+#import <ARKit/camera_region.h>
#import <ARKit/data.h>
#import <ARKit/data_provider.h>
#import <ARKit/environment_light_estimation.h>
@@ -29,8 +31,11 @@
#import <ARKit/room_tracking.h>
#import <ARKit/scene_reconstruction.h>
#import <ARKit/session.h>
+#import <ARKit/shared_coordinate_space.h>
#import <ARKit/skeleton_joint.h>
#import <ARKit/stereo_properties.h>
#import <ARKit/strings_collection.h>
+#import <ARKit/transform_correction.h>
#import <ARKit/world_tracking.h>
+
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/accessory_tracking.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/accessory_tracking.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/accessory_tracking.h 1969-12-31 19:00:00
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/accessory_tracking.h 2026-06-01 00:37:42
@@ -0,0 +1,874 @@
+#if (defined(USE_ARKIT_PUBLIC_HEADERS) && USE_ARKIT_PUBLIC_HEADERS) || !__has_include(<ARKitCore/accessory_tracking.h>)
+//
+// accessory_tracking.h
+// ARKit
+//
+// Copyright © 2025 Apple Inc. All rights reserved.
+//
+
+#ifndef accessory_tracking_h
+#define accessory_tracking_h
+
+#import <ARKit/anchor.h>
+#import <ARKit/data_provider.h>
+#import <ARKit/error.h>
+#import <ARKit/object.h>
+#import <ARKit/session.h>
+#import <ARKit/strings_collection.h>
+#import <ARKit/transform_correction.h>
+
+#import <simd/types.h>
+
+#import <CoreFoundation/CFBundle.h>
+#import <CoreFoundation/CFURL.h>
+
+#ifdef __OBJC__
+
+
+@protocol GCDevice;
+
+#endif // __OBJC__
+
+AR_ASSUME_NONNULL_BEGIN
+
+API_UNAVAILABLE_BEGIN(macos);
+API_UNAVAILABLE_BEGIN(macCatalyst);
+
+/**
+ The chirality of an accessory.
+ */
+API_AVAILABLE(visionos(26.0))
+OS_ENUM(ar_accessory_chirality, intptr_t,
+ /// Unspecified (non-handed accessory, not associated with a hand).
+ ar_accessory_chirality_unspecified = 0,
+ /// Left-handed accessory, or non-handed accessory held in left hand.
+ ar_accessory_chirality_left,
+ /// Right-handed accessory, or non-handed accessory held in right hand.
+ ar_accessory_chirality_right)
+AR_REFINED_FOR_SWIFT;
+
+/**
+ Error codes specific to accessory tracking.
+ */
+API_AVAILABLE(visionos(26.0))
+OS_ENUM(ar_accessory_tracking_error_code, ar_error_code_t,
+ /// Error code indicating that an accessory failed to load.
+ ar_accessory_tracking_error_code_accessory_loading_failed = 1200,
+ /// Error code indicating that updating accessories failed.
+ ar_accessory_tracking_error_code_update_accessories_failed API_AVAILABLE(visionos(27.0)) = 1201
+) AR_REFINED_FOR_SWIFT;
+
+/**
+ Tracking status for accessory anchors.
+ */
+API_AVAILABLE(visionos(26.0))
+OS_ENUM(ar_accessory_anchor_tracking_state, intptr_t,
+ // The anchor is not tracked.
+ ar_accessory_anchor_tracking_state_untracked = 0,
+ // Only orientation is currently tracked.
+ ar_accessory_anchor_tracking_state_orientation_tracked,
+ // Both position and orientation are currently tracked.
+ ar_accessory_anchor_tracking_state_position_orientation_tracked,
+ // Both position and orientation are currently tracked, but with low accuracy.
+ ar_accessory_anchor_tracking_state_position_orientation_tracked_low_accuracy,
+) AR_REFINED_FOR_SWIFT;
+
+/**
+ The type of input that was used to initialize an `ar_accessory_t`.
+ */
+API_AVAILABLE(visionos(26.0))
+OS_ENUM(ar_accessory_source_type,
+ intptr_t,
+ /// Accessory was initialized from a `GCDevice`.
+ ar_accessory_source_type_device = 1, )
+AR_REFINED_FOR_SWIFT;
+
+/**
+ An accessory that can be tracked in the physical environment, such as a game controller or stylus.
+ */
+AR_OBJECT_DECL(ar_accessory)
+AR_REFINED_FOR_SWIFT
+AR_SWIFT_SENDABLE
+API_AVAILABLE(visionos(26.0));
+
+/**
+ A collection of accessories.
+ */
+AR_OBJECT_DECL(ar_accessories)
+AR_REFINED_FOR_SWIFT
+AR_SWIFT_SENDABLE
+API_AVAILABLE(visionos(26.0));
+
+/**
+ An anchor that represents an accessory.
+ */
+AR_OBJECT_DECL_SUBCLASS(ar_accessory_anchor, ar_trackable_anchor)
+AR_REFINED_FOR_SWIFT
+API_AVAILABLE(visionos(26.0));
+
+/**
+ A collection of accessory anchors.
+ */
+AR_OBJECT_DECL(ar_accessory_anchors)
+AR_REFINED_FOR_SWIFT
+API_AVAILABLE(visionos(26.0));
+
+/**
+ Configuration for accessory tracking.
+ */
+AR_OBJECT_DECL(ar_accessory_tracking_configuration)
+AR_REFINED_FOR_SWIFT
+API_AVAILABLE(visionos(26.0));
+
+/**
+ A data provider for accessory tracking.
+ */
+AR_OBJECT_DECL_SUBCLASS(ar_accessory_tracking_provider, ar_data_provider)
+AR_REFINED_FOR_SWIFT
+API_AVAILABLE(visionos(26.0));
+
+#pragma mark - Accessory
+
+/**
+ Pre-defined accessory location name for spatial gamepad grip surface.
+ */
+API_AVAILABLE(visionos(26.0)) AR_EXTERN const char *const ar_accessory_location_name_grip_surface AR_REFINED_FOR_SWIFT;
+
+/**
+ Pre-defined accessory location name for spatial gamepad grip.
+ */
+API_AVAILABLE(visionos(26.0)) AR_EXTERN const char *const ar_accessory_location_name_grip AR_REFINED_FOR_SWIFT;
+
+/**
+ Pre-defined accessory location name for spatial gamepad and stylus aim point.
+ */
+API_AVAILABLE(visionos(26.0)) AR_EXTERN const char *const ar_accessory_location_name_aim AR_REFINED_FOR_SWIFT;
+
+/**
+ Indicates whether two accessories are equal.
+
+ - Parameters:
+ - accessory: An accessory to be compared.
+ - other_accessory: The other accessory to be compared to.
+
+ - Returns: `true` if the accessories are equal, otherwise `false`.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN bool ar_accessory_is_equal_to_accessory(ar_accessory_t _Nullable accessory, ar_accessory_t _Nullable other_accessory) AR_REFINED_FOR_SWIFT;
+
+/**
+ Get identifier for the accessory.
+
+ - Parameters:
+ - accessory: The accessory.
+ - out_identifier: Object to fill with UUID.
+*/
+API_AVAILABLE(visionos(26.0))
+
+AR_EXTERN void ar_accessory_get_identifier(ar_accessory_t accessory, uuid_t _Nonnull out_identifier) AR_REFINED_FOR_SWIFT;
+
+/**
+ Get inherent chirality for the accessory (what hand it is designed to be held in).
+
+ - Parameter accessory: The accessory.
+
+ - Returns: The chirality.
+*/
+API_AVAILABLE(visionos(26.0))
+
+AR_EXTERN ar_accessory_chirality_t ar_accessory_get_inherent_chirality(ar_accessory_t accessory) AR_REFINED_FOR_SWIFT;
+
+/**
+ Get an accessory's name.
+
+ - Parameter accessory: The accessory.
+
+ - Note: The returned value will have the same lifetime as the input `ar_accessory_t`.
+
+ - Returns: The name of the accessory, or `NULL` if no name is set.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN const char *ar_accessory_get_name(ar_accessory_t accessory) AR_REFINED_FOR_SWIFT;
+
+/**
+ Gets the names of locations with pre-defined coordinate systems available for this accessory.
+
+ - Parameter accessory: The accessory.
+
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An `ar_strings_t` with the location names.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_strings_t ar_accessory_copy_location_names(ar_accessory_t accessory) AR_REFINED_FOR_SWIFT;
+
+/**
+ Get path to a USDZ file for the accessory, if it has one.
+
+ - Parameter accessory: The accessory.
+
+ - Note: The returned value will have the same lifetime as the `ar_accessory_t`.
+
+ - Returns: The path to the USDZ file.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN CF_RETURNS_NOT_RETAINED CFURLRef _Nullable ar_accessory_get_usdz_file_path(ar_accessory_t accessory) AR_REFINED_FOR_SWIFT;
+
+#pragma mark - Accessory (Loaders)
+
+#ifdef __OBJC__
+
+#ifdef __BLOCKS__
+
+/**
+ Handler triggered when a request to load an accessory from a `GCDevice` has completed.
+
+ - Parameters:
+ - device: The `GCDevice` for the accessory that was being loaded.
+ - successful: `true` if loading succeeded, `false` otherwise.
+ - error: The error that occurred, if any.
+ - accessory: An instance of `ar_accessory_t` (NULL if loading failed). The accessory supports ARC.
+*/
+API_AVAILABLE(visionos(26.0))
+typedef void (^ar_accessory_device_load_completion_handler_t)(id<GCDevice> device,
+ bool successful,
+ ar_error_t _Nullable error,
+ ar_accessory_t _Nullable accessory) AR_REFINED_FOR_SWIFT;
+
+/**
+ Load an accessory from a `GCDevice`.
+
+ - Parameters:
+ - device: The `GCDevice` for which to load the accessory.
+ - completion_handler: A handler triggered after the request to load an accessory completes.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void ar_accessory_load_from_device(id<GCDevice> device,
+ ar_accessory_device_load_completion_handler_t completion_handler) AR_REFINED_FOR_SWIFT;
+
+#endif // __BLOCKS__
+
+/**
+ Function triggered when a request to load an accessory from a `GCDevice` has completed.
+
+ - Parameters:
+ - context: The application-defined context.
+ - device: The `GCDevice` for the accessory that was being loaded.
+ - successful: `true` if loading succeeded, `false` otherwise.
+ - error: The error that occurred, if any.
+ - accessory: An instance of `ar_accessory_t` (`NULL` if loading failed). The accessory supports ARC.
+*/
+API_AVAILABLE(visionos(26.0))
+typedef void (*ar_accessory_device_load_completion_handler_function_t)(void *_Nullable context,
+ id<GCDevice> device,
+ bool successful,
+ ar_error_t _Nullable error,
+ ar_accessory_t _Nullable accessory) AR_REFINED_FOR_SWIFT;
+
+/**
+ Load an accessory from a `GCDevice`.
+
+ - Parameters:
+ - device: The `GCDevice` for which to load the accessory.
+ - context: The application-defined context.
+ - completion_handler_function: Function triggered after the request to load an accessory completes.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void
+ar_accessory_load_from_device_f(id<GCDevice> device,
+ void *_Nullable context,
+ ar_accessory_device_load_completion_handler_function_t completion_handler_function) AR_REFINED_FOR_SWIFT;
+
+#endif // __OBJC__
+
+#pragma mark - Accessory (Source)
+
+/**
+ Gets type of source that was used to load an accessory.
+
+ - Parameter accessory: The accessory.
+
+ - Returns: The source type.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN ar_accessory_source_type_t ar_accessory_get_source_type(ar_accessory_t accessory) AR_REFINED_FOR_SWIFT;
+
+#ifdef __OBJC__
+
+/**
+ Gets the `GCDevice` that was used to initialize the accessory.
+
+ - Parameter accessory: The accessory.
+
+ - Returns: The `GCDevice`, or `NULL` if not used to initialize the accessory.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN id<GCDevice> _Nullable ar_accessory_get_source_device(ar_accessory_t accessory) AR_REFINED_FOR_SWIFT;
+
+#endif // __OBJC__
+
+#pragma mark - Accessories
+
+/**
+ Create an empty collection of accessories.
+
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_accessories_t`.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_accessories_t AR_SWIFT_SENDABLE ar_accessories_create(void) AR_REFINED_FOR_SWIFT;
+
+/**
+ Add an accessory to a collection.
+
+ The accessory must be unique. A duplicate of any existing object in the collection will not be added.
+
+ - Parameters:
+ - accessories: The collection of accessories to alter.
+ - accessory_to_add: The accessory to add.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void ar_accessories_add_accessory(ar_accessories_t accessories, ar_accessory_t accessory_to_add) AR_REFINED_FOR_SWIFT;
+
+/**
+ Add accessories to a collection.
+
+ The accessories must be unique. Duplicates of any existing object in the collection will not be added.
+
+ - Parameters:
+ - accessories: The collection of accessories to alter.
+ - accessories_to_add: The accessories to add.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void ar_accessories_add_accessories(ar_accessories_t accessories, ar_accessories_t accessories_to_add) AR_REFINED_FOR_SWIFT;
+
+/**
+ Remove an accessory from a collection.
+
+ No action is taken if the accessory is not found.
+
+ - Parameters:
+ - accessories: The collection of accessories to alter.
+ - accessory_to_remove: The accessory to remove.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void ar_accessories_remove_accessory(ar_accessories_t accessories, ar_accessory_t accessory_to_remove) AR_REFINED_FOR_SWIFT;
+
+/**
+ Remove accessories from a collection.
+
+ - Parameters:
+ - accessories: The collection of accessories to alter.
+ - accessories_to_remove: The accessories to remove.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void ar_accessories_remove_accessories(ar_accessories_t accessories, ar_accessories_t accessories_to_remove) AR_REFINED_FOR_SWIFT;
+
+/**
+ Get the count of accessories in the collection.
+
+ - Parameter accessories: The collection of accessories.
+
+ - Returns: The number of accessories in the collection.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN size_t ar_accessories_get_count(ar_accessories_t accessories) AR_REFINED_FOR_SWIFT;
+
+#ifdef __BLOCKS__
+
+/**
+ Handler for enumerating a collection of accessories.
+
+ - Parameter accessory: The accessory.
+
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
+API_AVAILABLE(visionos(26.0))
+typedef bool (^ar_accessories_enumerator_t)(ar_accessory_t accessory) AR_REFINED_FOR_SWIFT;
+
+/**
+ Enumerate a collection of accessories.
+
+ - Parameters:
+ - accessories: The collection of accessories.
+ - accessories_enumerator: The enumerator handler.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void ar_accessories_enumerate_accessories(ar_accessories_t accessories,
+ ar_accessories_enumerator_t accessories_enumerator) AR_REFINED_FOR_SWIFT;
+
+#endif // __BLOCKS__
+
+/**
+ Function for enumerating a collection of accessories.
+
+ - Parameters:
+ - context: The application-defined context.
+ - accessory: The accessory.
+
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
+API_AVAILABLE(visionos(26.0))
+typedef bool (*ar_accessories_enumerator_function_t)(void *_Nullable context, ar_accessory_t accessory) AR_REFINED_FOR_SWIFT;
+
+/**
+ Enumerate a collection of reference objects.
+
+ - Parameters:
+ - accessories: The collection of accessories.
+ - context: The application-defined context parameter to pass to the function.
+ - accessories_enumerator_function: The enumerator function.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void ar_accessories_enumerate_accessories_f(ar_accessories_t accessories,
+ void *_Nullable context,
+ ar_accessories_enumerator_function_t accessories_enumerator_function) AR_REFINED_FOR_SWIFT;
+
+#pragma mark - Accessory Anchor
+
+/**
+ Create an uninitialized accessory anchor.
+
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_accessory_anchor_t`.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_accessory_anchor_t ar_accessory_anchor_create(void) AR_REFINED_FOR_SWIFT;
+
+/**
+ Returns a Boolean value that indicates whether the two accessory anchors are equal.
+
+ - Parameters:
+ - anchor: The accessory anchor to be compared.
+ - other_anchor: The other accessory anchor to be compared to.
+
+ - Returns: `true` if the accessory anchors are equal, otherwise `false`.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN bool ar_accessory_anchor_is_equal_to_accessory_anchor(ar_accessory_anchor_t _Nullable anchor,
+ ar_accessory_anchor_t _Nullable other_anchor) AR_REFINED_FOR_SWIFT;
+
+/**
+ Returns the accessory that is being tracked by the anchor.
+
+ - Parameter accessory_anchor: The accessory anchor.
+
+ - Returns: The accessory.
+*/
+API_AVAILABLE(visionos(26.0))
+
+AR_EXTERN ar_accessory_t AR_SWIFT_SENDABLE ar_accessory_anchor_get_accessory(ar_accessory_anchor_t accessory_anchor) AR_REFINED_FOR_SWIFT;
+
+/**
+ Get the tracking state of the accessory anchor.
+
+ - Parameter accessory_anchor: The accessory anchor.
+
+ - Returns: Tracking state for this anchor.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN ar_accessory_anchor_tracking_state_t ar_accessory_anchor_get_tracking_state(ar_accessory_anchor_t accessory_anchor) AR_REFINED_FOR_SWIFT;
+
+/**
+ Returns a Boolean value that indicates whether the accessory is held.
+
+ - Parameter accessory_anchor: The accessory anchor.
+
+ - Returns: `true` if the accessory is currently held, otherwise `false`.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN bool ar_accessory_anchor_is_held(ar_accessory_anchor_t accessory_anchor) AR_REFINED_FOR_SWIFT;
+
+/**
+ Get the held state of this accessory anchor.
+
+ - Parameter accessory_anchor: The accessory anchor.
+
+ - Returns: Which hand the accessory is being held in, or unknown.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN ar_accessory_chirality_t ar_accessory_anchor_get_held_chirality(ar_accessory_anchor_t accessory_anchor) AR_REFINED_FOR_SWIFT;
+
+/**
+ Get the estimated velocity of the accessory in the local coordinate system.
+
+ - Parameter accessory_anchor: The accessory anchor.
+
+ - Returns: The velocity of the accessory in `m/s`.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN simd_float3 ar_accessory_anchor_get_velocity(ar_accessory_anchor_t accessory_anchor) AR_REFINED_FOR_SWIFT;
+
+/**
+ Get the estimated angular velocity of the accessory in the local coordinate system.
+
+ - Parameter accessory_anchor: The accessory anchor.
+
+ - Returns: Angular velocity of the accessory in `rad/s`.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN simd_float3 ar_accessory_anchor_get_angular_velocity(ar_accessory_anchor_t accessory_anchor) AR_REFINED_FOR_SWIFT;
+
+#pragma mark Accessory Anchor (ar_anchor convenience getters)
+
+/**
+ Get the identifier of an anchor.
+
+ - Parameters:
+ - accessory_anchor: The anchor.
+ - out_identifier: A pointer to a UUID to fill out with the anchor identifier. Must be non-null.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void ar_accessory_anchor_get_identifier(ar_accessory_anchor_t accessory_anchor, uuid_t _Nonnull out_identifier) AR_REFINED_FOR_SWIFT;
+
+/**
+ Get the transform from an anchor to the origin coordinate system.
+
+ - Parameter accessory_anchor: The anchor.
+
+ - Note: This function will return a rendering-corrected transform and is equal to calling
+ `ar_accessory_anchor_get_origin_from_anchor_transform_with_correction` with `ar_transform_correction_rendered`.
+
+ - Returns: The origin from anchor transform.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN simd_float4x4 ar_accessory_anchor_get_origin_from_anchor_transform(ar_accessory_anchor_t accessory_anchor) AR_REFINED_FOR_SWIFT;
+
+/**
+ Get the transform from an anchor to the origin coordinate system.
+
+ - Parameters:
+ - accessory_anchor: The anchor.
+ - transform_correction: The transform correction that should be applied.
+
+ - Returns: The origin from anchor transform.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN simd_float4x4 ar_accessory_anchor_get_origin_from_anchor_transform_with_correction(
+ ar_accessory_anchor_t accessory_anchor, ar_transform_correction_t transform_correction) AR_REFINED_FOR_SWIFT;
+
+/**
+ Get the transform from an anchor to the coordinate system of a location on the accessory.
+
+ - Parameters:
+ - accessory_anchor: The anchor.
+ - location_name: The name of a location on the accessory.
+ - transform_correction: The transform correction that should be applied.
+
+ - Returns: The origin from anchor transform.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN simd_float4x4 ar_accessory_anchor_get_anchor_from_location_transform_with_correction(
+ ar_accessory_anchor_t accessory_anchor, const char *location_name, ar_transform_correction_t transform_correction) AR_REFINED_FOR_SWIFT;
+
+/**
+ Get the timestamp corresponding to the accessory anchor.
+
+ - Parameter accessory_anchor: The accessory anchor.
+
+ - Returns: The timestamp associated with the accessory anchor.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN CFTimeInterval ar_accessory_anchor_get_timestamp(ar_accessory_anchor_t accessory_anchor) AR_REFINED_FOR_SWIFT;
+
+/**
+ Determine whether an accessory anchor is tracked.
+
+ - Parameter accessory_anchor: The accessory anchor.
+
+ - Returns: `true` if the anchor is tracked, `false` otherwise.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN bool ar_accessory_anchor_is_tracked(ar_accessory_anchor_t accessory_anchor) AR_REFINED_FOR_SWIFT;
+
+#pragma mark - Accessory Anchors Collection
+
+/**
+ Get the count of accessory anchors in the collection.
+
+ - Parameter accessory_anchors: The collection of accessory anchors.
+
+ - Returns: The number of accessory anchors in the collection.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN size_t ar_accessory_anchors_get_count(ar_accessory_anchors_t accessory_anchors) AR_REFINED_FOR_SWIFT;
+
+#ifdef __BLOCKS__
+
+/**
+ Handler for enumerating a collection of accessory anchors.
+
+ - Parameter accessory_anchor: The accessory anchor.
+
+ - Returns: `true` to continue enumerating to the next accessory anchor in the collection, `false` to stop enumerating.
+ - Note: Enumeration is not thread-safe. The enumerator must not retain or release objects.
+*/
+API_AVAILABLE(visionos(26.0))
+typedef bool (^ar_accessory_anchors_enumerator_t)(ar_accessory_anchor_t accessory_anchor) AR_MT_UNSAFE AR_REFINED_FOR_SWIFT;
+
+/**
+ Enumerate a collection of accessory anchors.
+
+ - Parameters:
+ - accessory_anchors: A collection of accessory anchors.
+ - accessory_anchors_enumerator: Enumeration handler.
+
+ - Note: Enumeration is not thread-safe. The enumerator must not retain or release objects.
+*/
+API_AVAILABLE(visionos(26.0))
+
+AR_EXTERN void
+ar_accessory_anchors_enumerate_anchors(ar_accessory_anchors_t accessory_anchors,
+ ar_accessory_anchors_enumerator_t accessory_anchors_enumerator) AR_MT_UNSAFE AR_REFINED_FOR_SWIFT;
+
+#endif // __BLOCKS__
+
+/**
+ Function for enumerating a collection of accessory anchors.
+
+ - Parameters:
+ - context: The application-defined context.
+ - accessory_anchor: The accessory anchor.
+
+ - Returns: `true` to continue enumerating to the next accessory anchor in the collection, `false` to stop enumerating.
+ - Note: Enumeration is not thread-safe. The enumerator must not retain or release objects.
+*/
+API_AVAILABLE(visionos(26.0))
+typedef bool (*ar_accessory_anchors_enumerator_function_t)(void *_Nullable context,
+ ar_accessory_anchor_t accessory_anchor) AR_MT_UNSAFE AR_REFINED_FOR_SWIFT;
+
+/**
+ Enumerate a collection of acessory anchors.
+
+ - Parameters:
+ - accessory_anchors: A collection of accessory anchors.
+ - context: The application-defined context parameter to pass to the function.
+ - accessory_anchors_enumerator_function: Enumeration function.
+
+ - Note: Enumeration is not thread-safe. The enumerator must not retain or release objects.
+*/
+API_AVAILABLE(visionos(26.0))
+
+AR_EXTERN void ar_accessory_anchors_enumerate_anchors_f(ar_accessory_anchors_t accessory_anchors,
+ void *_Nullable context,
+ ar_accessory_anchors_enumerator_function_t accessory_anchors_enumerator_function)
+ AR_MT_UNSAFE AR_REFINED_FOR_SWIFT;
+
+#pragma mark - Accessory Tracking Configuration
+
+/**
+ Create an accessory tracking configuration.
+
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_accessory_tracking_configuration_t`.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN
+AR_OBJECT_RETURNS_RETAINED
+ar_accessory_tracking_configuration_t ar_accessory_tracking_configuration_create(void) AR_REFINED_FOR_SWIFT;
+
+/**
+ Set accessories to track for the configuration.
+
+ - Parameters:
+ - configuration: The configuration to set accessories for.
+ - accessories: The accessories to add to the configuration.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN
+void ar_accessory_tracking_configuration_set_accessories(ar_accessory_tracking_configuration_t configuration,
+ ar_accessories_t accessories) AR_REFINED_FOR_SWIFT;
+
+#pragma mark - Accessory Tracking Provider
+
+/**
+ Create an accessory tracking provider.
+
+ - Parameter accessory_tracking_configuration: accessory tracking configuration.
+
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_accessory_tracking_provider_t`.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_accessory_tracking_provider_t
+ar_accessory_tracking_provider_create(ar_accessory_tracking_configuration_t accessory_tracking_configuration) AR_REFINED_FOR_SWIFT;
+
+#ifdef __BLOCKS__
+
+/**
+ Handler called when there are updates to accessory anchors.
+
+ - Parameters:
+ - added_anchors: The collection of anchors that were added.
+ - updated_anchors: The collection of anchors that were updated.
+ - removed_anchors: The collection of anchors that were removed.
+*/
+API_AVAILABLE(visionos(26.0))
+typedef void (^ar_accessory_tracking_update_handler_t)(ar_accessory_anchors_t added_anchors,
+ ar_accessory_anchors_t updated_anchors,
+ ar_accessory_anchors_t removed_anchors) AR_REFINED_FOR_SWIFT;
+
+/**
+ Set the handler for receiving accessory anchor updates.
+ - Note: Routine anchor updates will be disabled unless a handler is provided to this method. This is done to save CPU time for applications which do
+ not need an anchor stream.
+ - Note: Setting this handler will override the function set using `ar_accessory_tracking_provider_set_update_handler_f`.
+ - Parameters:
+ - accessory_tracking_provider: The accessory tracking provider.
+ - accessory_tracking_updates_queue: The queue on which the handler will be called. Passing `NULL` will default to the main queue.
+ - accessory_tracking_update_handler: The handler to be called when new accessory tracking data arrives.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void ar_accessory_tracking_provider_set_update_handler(ar_accessory_tracking_provider_t accessory_tracking_provider,
+ dispatch_queue_t _Nullable accessory_tracking_updates_queue,
+ ar_accessory_tracking_update_handler_t _Nullable accessory_tracking_update_handler)
+ AR_REFINED_FOR_SWIFT;
+
+/**
+ Handler triggered when a request to update accessories has completed.
+
+ - Parameters:
+ - success: `true` if the update succeeded, `false` otherwise.
+ - error: The error that occurred, if any.
+*/
+API_AVAILABLE(visionos(27.0))
+typedef void (^ar_accessory_tracking_update_accessories_completion_handler_t)(bool success, ar_error_t _Nullable error) AR_REFINED_FOR_SWIFT;
+
+/**
+ Update the accessories being tracked by a provider.
+
+ Updates are atomic: if any accessory fails to be added, the entire request fails and
+ the provider continues tracking the original set of accessories.
+
+ Update requests are processed sequentially. If multiple requests are made while an
+ update is in progress, only the most recent request is retained and will be processed
+ next; intermediate requests are superseded and their completion handlers are called
+ with an error.
+
+ The completion handler will be called with an error when one or more accessories
+ cannot be added or the request is superseded by a more recent request.
+
+ - Parameters:
+ - accessory_tracking_provider: The accessory tracking provider.
+ - accessories: The new set of accessories to track.
+ - completion_handler: Handler triggered after the update completes.
+*/
+API_AVAILABLE(visionos(27.0))
+AR_EXTERN void ar_accessory_tracking_provider_update_accessories(ar_accessory_tracking_provider_t accessory_tracking_provider,
+ ar_accessories_t accessories,
+ ar_accessory_tracking_update_accessories_completion_handler_t completion_handler)
+ AR_REFINED_FOR_SWIFT;
+
+#endif // __BLOCKS__
+
+/**
+ Function called when there are updates to accessory anchors.
+
+ - Parameters:
+ - context: The application-defined context.
+ - added_anchors: The collection of anchors that were added.
+ - updated_anchors: The collection of anchors that were updated.
+ - removed_anchors: The collection of anchors that were removed.
+*/
+API_AVAILABLE(visionos(26.0))
+typedef void (*ar_accessory_tracking_update_handler_function_t)(void *_Nullable context,
+ ar_accessory_anchors_t added_anchors,
+ ar_accessory_anchors_t updated_anchors,
+ ar_accessory_anchors_t removed_anchors) AR_REFINED_FOR_SWIFT;
+
+/**
+ Set the function for receiving accessory tracking updates.
+
+ - Parameters:
+ - accessory_tracking_provider: The accessory tracking provider.
+ - accessory_tracking_updates_queue: The queue on which the function will be called. Passing `NULL` will default to the main queue.
+ - context: The application-defined context parameter to pass to the function.
+ - accessory_tracking_update_handler_function: The function to be called when new accessory tracking data arrives.
+
+ - Note: Setting this function will override the handler set using `ar_accessory_tracking_provider_set_update_handler`.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void ar_accessory_tracking_provider_set_update_handler_f(
+ ar_accessory_tracking_provider_t accessory_tracking_provider,
+ dispatch_queue_t _Nullable accessory_tracking_updates_queue,
+ void *_Nullable context,
+ ar_accessory_tracking_update_handler_function_t _Nullable accessory_tracking_update_handler_function) AR_REFINED_FOR_SWIFT;
+
+/**
+ Determines whether this device supports the accessory tracking provider.
+
+ - Returns: Returns `true` if the accessory tracking provider is supported on this device, `false` otherwise.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN bool ar_accessory_tracking_provider_is_supported(void) AR_REFINED_FOR_SWIFT;
+
+/**
+ Get the authorization type required by the accessory tracking provider.
+
+ - Returns: The authorization type.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN ar_authorization_type_t ar_accessory_tracking_provider_get_required_authorization_type(void) AR_REFINED_FOR_SWIFT;
+
+#pragma mark - Accessory Tracking Prediction
+
+/**
+ Retrieves the latest anchors updated with the most recent inertial data.
+
+ These anchors provide higher frequency, lower latency and slightly lower accuracy than the anchors from the update handler.
+ Use them directly or in combination with `ar_accessory_tracking_provider_predict_anchor_at_timestamp`.
+
+ - Parameter accessory_tracking_provider: An accessory tracking provider.
+
+ - Note: This collection is managed by the provider and is not safe for the caller to release. It has the same lifetime as this
+ `accessory_tracking_provider`. This collection is not thread safe.
+
+ - Returns: An `ar_accessory_anchors_t` collection of latest anchors.
+*/
+API_AVAILABLE(visionos(26.0))
+
+AR_EXTERN ar_accessory_anchors_t ar_accessory_tracking_provider_get_latest_anchors(ar_accessory_tracking_provider_t accessory_tracking_provider)
+ AR_REFINED_FOR_SWIFT AR_MT_UNSAFE;
+
+/**
+ Predict an accessory anchor to a target timestamp.
+
+ Example usage:
+ ```
+ auto timing_info = cp_drawable_get_frame_timing(drawable);
+ auto time = cp_time_to_cf_time_interval(cp_frame_timing_get_trackable_anchor_time(timing_info));
+ const BOOL success = ar_accessory_tracking_provider_predict_anchor_at_timestamp(_provider, anchor_id, timestamp, accessory_anchor);
+ ```
+
+ - Parameters:
+ - accessory_tracking_provider: An accessory tracking provider.
+ - anchor: An anchor to predict. Use `ar_accessory_tracking_provider_get_latest_anchors` to get latest anchors. Use tracked
+ anchors to predict.
+ - timestamp: The timestamp to get the accessory anchor at. The timestamp should be provided as mach absolute time in seconds.
+ - predicted_anchor: The output predicted accessory anchor.
+
+ - Note: A large time offset from latest anchor timestamp could degrade accuracy. For accuracy sensitive use cases like drawing, use a small offset or
+ the latest anchor. Use a prediction timestamp smaller than the latest anchor timestamp for interpolation.
+
+ - Returns: Whether accessory anchor prediction was successful.
+*/
+API_AVAILABLE(visionos(26.0))
+
+AR_EXTERN bool ar_accessory_tracking_provider_predict_anchor_at_timestamp(ar_accessory_tracking_provider_t accessory_tracking_provider,
+ ar_accessory_anchor_t anchor,
+ CFTimeInterval timestamp,
+ ar_accessory_anchor_t predicted_anchor) AR_REFINED_FOR_SWIFT AR_MT_UNSAFE;
+
+API_UNAVAILABLE_END; // macCatalyst
+API_UNAVAILABLE_END; // macos
+
+AR_ASSUME_NONNULL_END
+
+#endif /* accessory_tracking_h */
+#else
+#import <ARKitCore/accessory_tracking.h>
+#endif // #if (defined(USE_ARKIT_PUBLIC_HEADERS) \&\& USE_ARKIT_PUBLIC_HEADERS) || !__has_include(<ARKitCore/accessory_tracking.h>)
\ No newline at end of file
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/anchor.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/anchor.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/anchor.h 2026-04-19 01:08:31
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/anchor.h 2026-05-22 07:32:10
@@ -22,56 +22,63 @@
#pragma mark - Anchor
+/**
+ Represents the identity, location, and orientation of an object in world space.
+ */
AR_OBJECT_DECL(ar_anchor)
AR_REFINED_FOR_SWIFT
-API_AVAILABLE(visionos(1.0), macos(26.0));
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0));
/**
Get the transform from an anchor to the origin coordinate system.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return The origin from anchor transform.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Returns: The origin from anchor transform.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN simd_float4x4 ar_anchor_get_origin_from_anchor_transform(ar_anchor_t anchor) AR_REFINED_FOR_SWIFT;
/**
Get the identifier of an anchor.
- @param[in] anchor The anchor.
- @param[out] out_identifier A pointer to a UUID to fill out with the anchor identifier. Must be non-null.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Parameters:
+ - anchor: The anchor.
+ - out_identifier: A pointer to a UUID to fill out with the anchor identifier. Must be non-null.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN void ar_anchor_get_identifier(ar_anchor_t anchor, uuid_t _Nonnull out_identifier) AR_REFINED_FOR_SWIFT;
/**
Get the timestamp corresponding to an anchor.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return The timestamp associated with the anchor.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Returns: The timestamp associated with the anchor.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN CFTimeInterval ar_anchor_get_timestamp(ar_anchor_t anchor) AR_REFINED_FOR_SWIFT;
#pragma mark - Trackable Anchor
+/**
+ An anchor that can be tracked over time.
+ */
AR_OBJECT_DECL_SUBCLASS(ar_trackable_anchor, ar_anchor)
AR_REFINED_FOR_SWIFT
-API_AVAILABLE(visionos(1.0), macos(26.0));
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0));
/**
Determine whether an anchor is tracked.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return `true` if the anchor is tracked, `false` otherwise.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Returns: `true` if the anchor is tracked, `false` otherwise.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN bool ar_trackable_anchor_is_tracked(ar_trackable_anchor_t anchor) AR_REFINED_FOR_SWIFT;
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/authorization.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/authorization.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/authorization.h 2026-04-19 01:08:32
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/authorization.h 2026-05-22 07:32:11
@@ -18,7 +18,7 @@
/**
Status of an authorization for ARKit data.
*/
-API_AVAILABLE(visionos(1.0), macos(26.0))
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
OS_ENUM(ar_authorization_status, intptr_t,
// The user has not yet granted permission.
ar_authorization_status_not_determined,
@@ -31,7 +31,7 @@
/**
Types of authorization for ARKit data.
*/
-API_AVAILABLE(visionos(1.0), macos(26.0))
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
OS_OPTIONS(ar_authorization_type, uintptr_t,
ar_authorization_type_none = 0,
/**
@@ -54,67 +54,79 @@
*/
ar_authorization_type_camera_access API_AVAILABLE(visionos(2.0)) = (1 << 3),
+ /** Authorization type used when requesting:
+ - Accessory tracking
+ @see `ar_accessory_tracking_provider_t`
+ */
+ ar_authorization_type_accessory_tracking = (1 << 5),
)
AR_REFINED_FOR_SWIFT;
+/**
+ Result of an authorization request.
+ */
AR_OBJECT_DECL(ar_authorization_result)
AR_REFINED_FOR_SWIFT
-API_AVAILABLE(visionos(1.0), macos(26.0));
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0));
/**
Get the authorization type associated with an authorization result.
- @param authorization_result The authorization result.
+ - Parameter authorization_result: The authorization result.
- @return The authorization type.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Returns: The authorization type.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN ar_authorization_type_t ar_authorization_result_get_authorization_type(ar_authorization_result_t authorization_result) AR_REFINED_FOR_SWIFT;
/**
Get the authorization status associated with an authorization result.
- @param authorization_result The authorization result.
+ - Parameter authorization_result: The authorization result.
- @return The authorization status.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Returns: The authorization status.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN ar_authorization_status_t ar_authorization_result_get_status(ar_authorization_result_t authorization_result) AR_REFINED_FOR_SWIFT;
#pragma mark - Authorization Results
+/**
+ A collection of authorization results.
+ */
AR_OBJECT_DECL(ar_authorization_results)
AR_REFINED_FOR_SWIFT
-API_AVAILABLE(visionos(1.0), macos(26.0));
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0));
/**
Get the count of authorization results in a collection.
- @param authorization_results The collection of authorization results.
+ - Parameter authorization_results: The collection of authorization results.
- @return The number of authorization results in the collection.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Returns: The number of authorization results in the collection.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN size_t ar_authorization_results_get_count(ar_authorization_results_t authorization_results) AR_REFINED_FOR_SWIFT;
#ifdef __BLOCKS__
/**
Handler for enumerating a collection of authorization results.
- @param authorization_result The authorization result.
+ - Parameter authorization_result: The authorization result.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
typedef bool (^ar_authorization_results_enumerator_t)(ar_authorization_result_t authorization_result) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of authorization results.
- @param authorization_results The collection of authorization results.
- @param authorization_results_enumerator The enumerator handler.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Parameters:
+ - authorization_results: The collection of authorization results.
+ - authorization_results_enumerator: The enumerator handler.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN void
ar_authorization_results_enumerate_results(ar_authorization_results_t authorization_results,
ar_authorization_results_enumerator_t authorization_results_enumerator) AR_REFINED_FOR_SWIFT;
@@ -123,23 +135,25 @@
/**
Function for enumerating a collection of authorization results.
- @param context The application-defined context.
- @param authorization_result The authorization result.
+ - Parameters:
+ - context: The application-defined context.
+ - authorization_result: The authorization result.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
typedef bool (*ar_authorization_results_enumerator_function_t)(void *_Nullable context,
ar_authorization_result_t authorization_result) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of authorization results using a function.
- @param authorization_results The collection of authorization results.
- @param context The application-defined context parameter to pass to the function.
- @param authorization_results_enumerator_function The enumerator function.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Parameters:
+ - authorization_results: The collection of authorization results.
+ - context: The application-defined context parameter to pass to the function.
+ - authorization_results_enumerator_function: The enumerator function.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN void ar_authorization_results_enumerate_results_f(ar_authorization_results_t authorization_results,
void *_Nullable context,
ar_authorization_results_enumerator_function_t authorization_results_enumerator_function)
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/barcode_detection.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/barcode_detection.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/barcode_detection.h 2026-04-19 01:08:31
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/barcode_detection.h 2026-05-22 07:32:10
@@ -18,6 +18,7 @@
#import <ARKit/data.h>
#import <ARKit/data_provider.h>
#import <ARKit/object.h>
+#import <ARKit/transform_correction.h>
#import <dispatch/dispatch.h>
#import <os/availability.h>
@@ -26,23 +27,39 @@
AR_ASSUME_NONNULL_BEGIN
API_UNAVAILABLE_BEGIN(macos);
+API_UNAVAILABLE_BEGIN(macCatalyst);
+/**
+ An anchor that tracks a barcode's position and orientation in the physical environment.
+ */
AR_OBJECT_DECL_SUBCLASS(ar_barcode_anchor, ar_anchor)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(2.0));
+/**
+ A collection of barcode anchors.
+ */
AR_OBJECT_DECL(ar_barcode_anchors)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(2.0));
+/**
+ Configuration for barcode detection.
+ */
AR_OBJECT_DECL(ar_barcode_detection_configuration)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(2.0));
+/**
+ Callbacks for barcode detection events.
+ */
AR_OBJECT_DECL(ar_barcode_detection_callbacks)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(2.0));
+/**
+ A data provider for barcode detection.
+ */
AR_OBJECT_DECL_SUBCLASS(ar_barcode_detection_provider, ar_data_provider)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(2.0));
@@ -50,8 +67,8 @@
/**
Option set describing possible symbologies of a detected barcode.
- @note An `ar_barcode_anchor_t` has exactly one symbology. Multiple bits may be set to configure the `ar_barcode_detection_provider_t` to detect multiple symbologies.
- */
+ - Note: An `ar_barcode_anchor_t` has exactly one symbology. Multiple bits may be set to configure the `ar_barcode_detection_provider_t` to detect multiple symbologies.
+*/
API_AVAILABLE(visionos(2.0))
OS_OPTIONS(ar_barcode_detection_symbology, uint64_t,
ar_barcode_detection_symbology_none = 0,
@@ -134,45 +151,47 @@
/**
Get the symbology of a barcode anchor.
- @param barcode_anchor The barcode anchor.
+ - Parameter barcode_anchor: The barcode anchor.
- @return The barcode anchor's symbology.
- */
+ - Returns: The barcode anchor's symbology.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN ar_barcode_detection_symbology_t ar_barcode_anchor_get_symbology(ar_barcode_anchor_t barcode_anchor) AR_REFINED_FOR_SWIFT;
/**
Get the payload string value of a barcode anchor.
- @param barcode_anchor The barcode anchor.
+ - Parameter barcode_anchor: The barcode anchor.
- @note The returned value will have the same lifetime as the input barcode anchor.
- @return The string representation of the barcode anchor's payload.
- */
+ - Note: The returned value will have the same lifetime as the input barcode anchor.
+
+ - Returns: The string representation of the barcode anchor's payload.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN const char *_Nullable ar_barcode_anchor_get_payload_string_value(ar_barcode_anchor_t barcode_anchor) AR_REFINED_FOR_SWIFT;
/**
Get a copy of a barcode anchor's payload data.
- @param barcode_anchor The barcode anchor.
+ - Parameter barcode_anchor: The barcode anchor.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return A copy of the barcode anchor's payload data.
- */
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: A copy of the barcode anchor's payload data.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_data_t ar_barcode_anchor_copy_payload_data(ar_barcode_anchor_t barcode_anchor) AR_REFINED_FOR_SWIFT;
/**
Get the extent of a detected barcode's bounding box.
- @param barcode_anchor The barcode anchor.
+ - Parameter barcode_anchor: The barcode anchor.
- @note The width of the detected barcode is the length along the X-axis, prior to rotation about the Y-axis. The height of the detected barcode is the
- length along the Z-axis, prior to rotation about the Y-axis.
+ - Note: The width of the detected barcode is the length along the X-axis, prior to rotation about the Y-axis. The height of the detected barcode is
+ the length along the Z-axis, prior to rotation about the Y-axis.
- @return The extent of the detected barcode's bounding box.
- */
+ - Returns: The extent of the detected barcode's bounding box.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN simd_float3 ar_barcode_anchor_get_extent(ar_barcode_anchor_t barcode_anchor) AR_REFINED_FOR_SWIFT;
@@ -181,29 +200,43 @@
/**
Get the identifier of an anchor.
- @param[in] anchor The anchor.
- @param[out] out_identifier A pointer to a UUID to fill out with the anchor identifier. Must be non-null.
- */
+ - Parameters:
+ - anchor: The anchor.
+ - out_identifier: A pointer to a UUID to fill out with the anchor identifier. Must be non-null.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_barcode_anchor_get_identifier(ar_barcode_anchor_t anchor, uuid_t _Nonnull out_identifier) AR_REFINED_FOR_SWIFT;
/**
Get the transform from an anchor to the origin coordinate system.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return The origin from anchor transform.
- */
+ - Returns: The origin from anchor transform.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN simd_float4x4 ar_barcode_anchor_get_origin_from_anchor_transform(ar_barcode_anchor_t anchor) AR_REFINED_FOR_SWIFT;
/**
+ Get the transform from an anchor to the origin coordinate system with a transform correction option.
+
+ - Parameters:
+ - anchor: The anchor.
+ - transform_correction: The transform correction to apply.
+
+ - Returns: The origin from anchor transform with the specified correction.
+*/
+API_AVAILABLE(visionos(27.0))
+AR_EXTERN simd_float4x4 ar_barcode_anchor_get_origin_from_anchor_transform_with_correction(
+ ar_barcode_anchor_t anchor, ar_transform_correction_t transform_correction) AR_REFINED_FOR_SWIFT;
+
+/**
Get the timestamp corresponding to an anchor.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return The timestamp associated with the anchor.
- */
+ - Returns: The timestamp associated with the anchor.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN CFTimeInterval ar_barcode_anchor_get_timestamp(ar_barcode_anchor_t anchor) AR_REFINED_FOR_SWIFT;
@@ -212,10 +245,10 @@
/**
Get the count of barcode anchors in a collection.
- @param barcode_anchors The collection of barcode anchors.
+ - Parameter barcode_anchors: The collection of barcode anchors.
- @return The number of barcode anchors in the collection.
- */
+ - Returns: The number of barcode anchors in the collection.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN size_t ar_barcode_anchors_get_count(ar_barcode_anchors_t barcode_anchors) AR_REFINED_FOR_SWIFT;
@@ -223,19 +256,20 @@
/**
Handler for enumerating a collection of barcode anchors.
- @param barcode_anchor The barcode anchor.
+ - Parameter barcode_anchor: The barcode anchor.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(2.0))
typedef bool (^ar_barcode_anchors_enumerator_t)(ar_barcode_anchor_t barcode_anchor) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of barcode anchors.
- @param barcode_anchors The collection of barcode anchors.
- @param barcode_anchors_enumerator The enumerator handler.
- */
+ - Parameters:
+ - barcode_anchors: The collection of barcode anchors.
+ - barcode_anchors_enumerator: The enumerator handler.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_barcode_anchors_enumerate_anchors(ar_barcode_anchors_t barcode_anchors,
ar_barcode_anchors_enumerator_t barcode_anchors_enumerator) AR_REFINED_FOR_SWIFT;
@@ -244,21 +278,23 @@
/**
Function for enumerating a collection of barcode anchors.
- @param context The application-defined context.
- @param barcode_anchor The barcode anchor.
+ - Parameters:
+ - context: The application-defined context.
+ - barcode_anchor: The barcode anchor.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(2.0))
typedef bool (*ar_barcode_anchors_enumerator_function_t)(void *_Nullable context, ar_barcode_anchor_t barcode_anchor) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of barcode anchors using a function.
- @param barcode_anchors The collection of barcode anchors.
- @param context The application-defined context parameter to pass to the function.
- @param barcode_anchors_enumerator_function The enumerator function.
- */
+ - Parameters:
+ - barcode_anchors: The collection of barcode anchors.
+ - context: The application-defined context parameter to pass to the function.
+ - barcode_anchors_enumerator_function: The enumerator function.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void
ar_barcode_anchors_enumerate_anchors_f(ar_barcode_anchors_t barcode_anchors,
@@ -270,18 +306,20 @@
/**
Create a barcode detection configuration.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_barcode_detection_configuration_t`.
- */
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_barcode_detection_configuration_t`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_barcode_detection_configuration_t ar_barcode_detection_configuration_create(void) AR_REFINED_FOR_SWIFT;
/**
Set the desired symbologies to detect.
- @param barcode_detection_configuration The barcode detection configuration.
- @param symbology The symbologies to detect.
- */
+ - Parameters:
+ - barcode_detection_configuration: The barcode detection configuration.
+ - symbology: The symbologies to detect.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_barcode_detection_configuration_set_detection_symbology(ar_barcode_detection_configuration_t barcode_detection_configuration,
ar_barcode_detection_symbology_t symbology) AR_REFINED_FOR_SWIFT;
@@ -291,12 +329,12 @@
/**
Create a barcode detection provider.
- @param barcode_detection_configuration An instance of `ar_barcode_detection_configuration_t`.
+ - Parameter barcode_detection_configuration: An instance of `ar_barcode_detection_configuration_t`.
- @see `ar_session_t` to run this barcode detection provider.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_barcode_detection_provider_t`.
- */
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_barcode_detection_provider_t`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_barcode_detection_provider_t
ar_barcode_detection_provider_create(ar_barcode_detection_configuration_t barcode_detection_configuration) AR_REFINED_FOR_SWIFT;
@@ -304,8 +342,8 @@
/**
Determines whether this device supports the barcode detection provider.
- @return Returns `true` if the barcode detection provider is supported on this device, `false` otherwise.
- */
+ - Returns: Returns `true` if the barcode detection provider is supported on this device, `false` otherwise.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool ar_barcode_detection_provider_is_supported(void) AR_REFINED_FOR_SWIFT;
@@ -313,10 +351,11 @@
/**
Handler called when there are updates to barcode anchors.
- @param added_anchors The collection of anchors that were added.
- @param updated_anchors The collection of anchors that were updated.
- @param removed_anchors The collection of anchors that were removed.
- */
+ - Parameters:
+ - added_anchors: The collection of anchors that were added.
+ - updated_anchors: The collection of anchors that were updated.
+ - removed_anchors: The collection of anchors that were removed.
+*/
API_AVAILABLE(visionos(2.0))
typedef void (^ar_barcode_detection_update_handler_t)(ar_barcode_anchors_t added_anchors,
ar_barcode_anchors_t updated_anchors,
@@ -326,11 +365,12 @@
/**
Function called when there are updates to barcode anchors.
- @param context The application-defined context.
- @param added_anchors The collection of anchors that were added.
- @param updated_anchors The collection of anchors that were updated.
- @param removed_anchors The collection of anchors that were removed.
- */
+ - Parameters:
+ - context: The application-defined context.
+ - added_anchors: The collection of anchors that were added.
+ - updated_anchors: The collection of anchors that were updated.
+ - removed_anchors: The collection of anchors that were removed.
+*/
API_AVAILABLE(visionos(2.0))
typedef void (*ar_barcode_detection_update_handler_function_t)(void *_Nullable context,
ar_barcode_anchors_t added_anchors,
@@ -341,13 +381,14 @@
/**
Set the handler for receiving barcode detection updates.
- @param barcode_detection_provider The barcode detection provider.
- @param barcode_detection_updates_queue The queue on which the handler will be called. Passing NULL will default to the main queue.
- @param barcode_detection_update_handler Handler to be called when new anchor data arrives. Refer to `ar_barcode_detection_update_handler_t` for
- handler signature.
+ - Parameters:
+ - barcode_detection_provider: The barcode detection provider.
+ - barcode_detection_updates_queue: The queue on which the handler will be called. Passing NULL will default to the main queue.
+ - barcode_detection_update_handler: Handler to be called when new anchor data arrives. Refer to `ar_barcode_detection_update_handler_t` for
+ handler signature.
- @note Setting this handler will override the function set using `ar_barcode_detection_provider_set_update_handler_f`.
- */
+ - Note: Setting this handler will override the function set using `ar_barcode_detection_provider_set_update_handler_f`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_barcode_detection_provider_set_update_handler(ar_barcode_detection_provider_t barcode_detection_provider,
dispatch_queue_t _Nullable barcode_detection_updates_queue,
@@ -358,13 +399,14 @@
/**
Set the function for receiving barcode detection updates.
- @param barcode_detection_provider The barcode detection provider.
- @param barcode_detection_updates_queue The queue on which the handler will be called. Passing NULL will default to the main queue.
- @param context The application-defined context parameter to pass to the function.
- @param barcode_detection_update_handler_function The function to be called when new barcode detection updates arrive.
+ - Parameters:
+ - barcode_detection_provider: The barcode detection provider.
+ - barcode_detection_updates_queue: The queue on which the handler will be called. Passing `NULL` will default to the main queue.
+ - context: The application-defined context parameter to pass to the function.
+ - barcode_detection_update_handler_function: The function to be called when new barcode detection updates arrive.
- @note Setting this function will override the handler set using `ar_barcode_detection_provider_set_update_handler`.
- */
+ - Note: Setting this function will override the handler set using `ar_barcode_detection_provider_set_update_handler`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_barcode_detection_provider_set_update_handler_f(
ar_barcode_detection_provider_t barcode_detection_provider,
@@ -375,11 +417,12 @@
/**
Get the authorization type required by the barcode detection provider.
- @return The required authorization type.
- */
+ - Returns: The required authorization type.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN ar_authorization_type_t ar_barcode_detection_provider_get_required_authorization_type(void) AR_REFINED_FOR_SWIFT;
+API_UNAVAILABLE_END; // macCatalyst
API_UNAVAILABLE_END; // macos
AR_ASSUME_NONNULL_END
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/camera_frame_provider.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/camera_frame_provider.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/camera_frame_provider.h 2026-04-18 22:53:34
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/camera_frame_provider.h 2026-05-22 07:32:11
@@ -23,31 +23,53 @@
AR_ASSUME_NONNULL_BEGIN
API_UNAVAILABLE_BEGIN(macos);
+API_UNAVAILABLE_BEGIN(macCatalyst);
+/**
+ Describes a camera video format with frame rate, size, and pixel format.
+ */
AR_OBJECT_DECL(ar_camera_video_format)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(2.0));
+/**
+ A collection of camera video formats.
+ */
AR_OBJECT_DECL(ar_camera_video_formats)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(2.0));
+/**
+ A camera frame containing one or more camera frame samples.
+ */
AR_OBJECT_DECL(ar_camera_frame)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(2.0));
+/**
+ A single camera frame sample with pixel buffer and metadata.
+ */
AR_OBJECT_DECL(ar_camera_frame_sample)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(2.0));
+/**
+ A collection of camera frame samples.
+ */
AR_OBJECT_DECL(ar_camera_frame_samples)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(26.0));
+/**
+ Parameters for a camera frame including intrinsics, extrinsics, and timestamps.
+ */
AR_OBJECT_DECL(ar_camera_frame_parameters)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(2.0));
+/**
+ A data provider that delivers camera frames.
+ */
AR_OBJECT_DECL_SUBCLASS(ar_camera_frame_provider, ar_data_provider)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(2.0));
@@ -96,11 +118,12 @@
/**
Returns a bool value that indicates whether the two camera video formats are equal.
- @param camera_video_format A camera video format to be compared.
- @param other_camera_video_format The other camera video format to be compared to.
+ - Parameters:
+ - camera_video_format: A camera video format to be compared.
+ - other_camera_video_format: The other camera video format to be compared to.
- @return YES if the camera video formats are equal, otherwise NO.
- */
+ - Returns: `YES` if the camera video formats are equal, otherwise `NO`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool
ar_camera_video_format_is_equal_to_camera_video_format(ar_camera_video_format_t _Nullable camera_video_format,
@@ -109,68 +132,70 @@
/**
Get the minimum frame duration for this video format.
- @param video_format The video format.
+ - Parameter video_format: The video format.
- @return The minimum frame duration.
- */
+ - Returns: The minimum frame duration.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN float ar_camera_video_format_get_minimum_frame_duration(ar_camera_video_format_t video_format) AR_REFINED_FOR_SWIFT;
/**
Get the maximum frame duration for this video format.
- @param video_format The video format.
+ - Parameter video_format: The video format.
- @return The maximum frame duration.
- */
+ - Returns: The maximum frame duration.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN float ar_camera_video_format_get_maximum_frame_duration(ar_camera_video_format_t video_format) AR_REFINED_FOR_SWIFT;
/**
Get the frame size for this video format in pixels.
- @param video_format The video format.
+ - Parameter video_format: The video format.
- @return The frame size in pixels.
- */
+ - Returns: The frame size in pixels.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN CGSize ar_camera_video_format_get_frame_size(ar_camera_video_format_t video_format) AR_REFINED_FOR_SWIFT;
/**
Get the pixel format for this video format.
- @param video_format The video format.
- @return The pixel format.
- */
+
+ - Parameter video_format: The video format.
+
+ - Returns: The pixel format.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN OSType ar_camera_video_format_get_pixel_format(ar_camera_video_format_t video_format) AR_REFINED_FOR_SWIFT;
/**
Get the camera type for this video format.
- @param video_format The video format.
+ - Parameter video_format: The video format.
- @return The camera type.
- */
+ - Returns: The camera type.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN ar_camera_type_t ar_camera_video_format_get_camera_type(ar_camera_video_format_t video_format) AR_REFINED_FOR_SWIFT;
/**
Get the camera position for this video format.
- @param video_format The video format.
+ - Parameter video_format: The video format.
- @return The camera position.
- */
+ - Returns: The camera position.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN ar_camera_position_t ar_camera_video_format_get_camera_position(ar_camera_video_format_t video_format) AR_REFINED_FOR_SWIFT;
/**
Get the camera rectification type for this video format.
- @param video_format The video format.
+ - Parameter video_format: The video format.
- @return The camera rectification type.
- */
+ - Returns: The camera rectification type.
+*/
API_AVAILABLE(visionos(26.0))
AR_EXTERN ar_camera_rectification_type_t ar_camera_video_format_get_camera_rectification_type(ar_camera_video_format_t video_format)
AR_REFINED_FOR_SWIFT;
@@ -178,12 +203,14 @@
/**
Returns a collection of supported video formats for a given camera type and position.
- @param camera_type The camera type.
- @param camera_position The inclusive set of camera positions that the video formats must match.
+ - Parameters:
+ - camera_type: The camera type.
+ - camera_position: The inclusive set of camera positions that the video formats must match.
- @note This type supports ARC. In non-ARC files, use ar_retain() and ar_release() to retain and release the object.
- @return An instance of `ar_camera_video_formats_t`.
- */
+ - Note: This type supports ARC. In non-ARC files, use ar_retain() and ar_release() to retain and release the object.
+
+ - Returns: An instance of `ar_camera_video_formats_t`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_camera_video_formats_t
ar_camera_video_format_copy_supported_video_formats(ar_camera_type_t camera_type, ar_camera_position_t camera_position) AR_REFINED_FOR_SWIFT;
@@ -193,10 +220,10 @@
/**
Get the count of camera video formats in the collection.
- @param camera_video_formats The camera video formats collection.
+ - Parameter camera_video_formats: The camera video formats collection.
- @return The number of camera video formats in the collection.
- */
+ - Returns: The number of camera video formats in the collection.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN size_t ar_camera_video_formats_get_count(ar_camera_video_formats_t camera_video_formats) AR_REFINED_FOR_SWIFT;
@@ -204,19 +231,20 @@
/**
Handler for enumerating camera video formats.
- @param camera_video_format The camera video format.
+ - Parameter camera_video_format: The camera video format.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(2.0))
typedef bool (^ar_camera_video_format_enumerator_t)(ar_camera_video_format_t camera_video_format) AR_REFINED_FOR_SWIFT;
/**
Enumerate all supported video formats for this configuration.
- @param camera_video_formats The camera video formats collection.
- @param camera_video_formats_enumerator The enumerator handler.
- */
+ - Parameters:
+ - camera_video_formats: The camera video formats collection.
+ - camera_video_formats_enumerator: The enumerator handler.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void
ar_camera_video_formats_enumerate_video_formats(ar_camera_video_formats_t camera_video_formats,
@@ -226,11 +254,12 @@
/**
Function for enumerating camera video formats.
- @param context The application-defined context.
- @param camera_video_format The camera video format.
+ - Parameters:
+ - context: The application-defined context.
+ - camera_video_format: The camera video format.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(2.0))
typedef bool (*ar_camera_video_format_enumerator_function_t)(void *_Nullable context,
ar_camera_video_format_t camera_video_format) AR_REFINED_FOR_SWIFT;
@@ -238,10 +267,11 @@
/**
Enumerate all supported camera video formats for this configuration using a function.
- @param camera_video_formats The camera video formats collection.
- @param context The application-defined context parameter to pass to the function.
- @param camera_video_formats_enumerator_function The enumerator function.
- */
+ - Parameters:
+ - camera_video_formats: The camera video formats collection.
+ - context: The application-defined context parameter to pass to the function.
+ - camera_video_formats_enumerator_function: The enumerator function.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_camera_video_formats_enumerate_video_formats_f(
ar_camera_video_formats_t camera_video_formats,
@@ -253,11 +283,12 @@
/**
Returns a bool value that indicates whether the two camera frames are equal.
- @param camera_frame A camera frame to be compared.
- @param other_camera_frame The other camera frame to be compared to.
+ - Parameters:
+ - camera_frame: A camera frame to be compared.
+ - other_camera_frame: The other camera frame to be compared to.
- @return YES if the camera frames are equal, otherwise NO.
- */
+ - Returns: `YES` if the camera frames are equal, otherwise `NO`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool ar_camera_frame_is_equal_to_camera_frame(ar_camera_frame_t _Nullable camera_frame,
ar_camera_frame_t _Nullable other_camera_frame) AR_REFINED_FOR_SWIFT;
@@ -265,11 +296,12 @@
/**
Get the camera frame sample for a given camera position.
- @param camera_frame The camera frame.
- @param camera_position The camera position.
+ - Parameters:
+ - camera_frame: The camera frame.
+ - camera_position: The camera position.
- @return An instance of `ar_camera_frame_sample_t`.
- */
+ - Returns: An instance of `ar_camera_frame_sample_t`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN ar_camera_frame_sample_t _Nullable ar_camera_frame_get_frame_sample(ar_camera_frame_t camera_frame,
ar_camera_position_t camera_position) AR_REFINED_FOR_SWIFT;
@@ -277,20 +309,20 @@
/**
Get the primary frame sample for this camera frame.
- @param camera_frame The camera frame.
+ - Parameter camera_frame: The camera frame.
- @return An instance of `ar_camera_frame_sample_t`.
- */
+ - Returns: An instance of `ar_camera_frame_sample_t`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN ar_camera_frame_sample_t ar_camera_frame_get_primary_frame_sample(ar_camera_frame_t camera_frame) AR_REFINED_FOR_SWIFT;
/**
Get the collection of camera frame samples for this camera frame.
- @param camera_frame The camera frame.
+ - Parameter camera_frame: The camera frame.
- @return An instance of `ar_camera_frame_samples_t`.
- */
+ - Returns: An instance of `ar_camera_frame_samples_t`.
+*/
API_AVAILABLE(visionos(26.0))
AR_EXTERN ar_camera_frame_samples_t ar_camera_frame_get_frame_samples(ar_camera_frame_t camera_frame) AR_REFINED_FOR_SWIFT;
@@ -300,18 +332,20 @@
/**
Handler for enumerating camera frame samples.
- @param camera_frame_sample The camera frame sample.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Parameter camera_frame_sample: The camera frame sample.
+
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(26.0))
typedef bool (^ar_camera_frame_sample_enumerator_t)(ar_camera_frame_sample_t camera_frame_sample) AR_REFINED_FOR_SWIFT;
/**
Enumerate all camera frame samples in this collection.
- @param camera_frame_samples The collection of frame samples.
- @param camera_frame_sample_enumerator The enumerator handler.
- */
+ - Parameters:
+ - camera_frame_samples: The collection of frame samples.
+ - camera_frame_sample_enumerator: The enumerator handler.
+*/
API_AVAILABLE(visionos(26.0))
AR_EXTERN void
ar_camera_frame_samples_enumerate_frame_samples(ar_camera_frame_samples_t camera_frame_samples,
@@ -321,11 +355,12 @@
/**
Function for enumerating camera frame samples.
- @param context The application-defined context.
- @param camera_frame_sample The camera frame sample.
+ - Parameters:
+ - context: The application-defined context.
+ - camera_frame_sample: The camera frame sample.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(26.0))
typedef bool (*ar_camera_frame_sample_enumerator_function_t)(void *_Nullable context,
ar_camera_frame_sample_t camera_frame_sample) AR_REFINED_FOR_SWIFT;
@@ -333,10 +368,11 @@
/**
Enumerate all supported camera frame samples for this configuration using a function.
- @param camera_frame_samples The collection of frame samples.
- @param context The application-defined context parameter to pass to the function.
- @param camera_frame_sample_enumerator_function The enumerator function.
- */
+ - Parameters:
+ - camera_frame_samples: The collection of frame samples.
+ - context: The application-defined context parameter to pass to the function.
+ - camera_frame_sample_enumerator_function: The enumerator function.
+*/
API_AVAILABLE(visionos(26.0))
AR_EXTERN void ar_camera_frame_samples_enumerate_frame_samples_f(ar_camera_frame_samples_t camera_frame_samples,
void *_Nullable context,
@@ -346,10 +382,10 @@
/**
Get the count of camera frame samples in the collection.
- @param camera_frame_samples The collection of camera frame samples.
+ - Parameter camera_frame_samples: The collection of camera frame samples.
- @return The number of camera frame samples in the collection.
- */
+ - Returns: The number of camera frame samples in the collection.
+*/
API_AVAILABLE(visionos(26.0))
AR_EXTERN size_t ar_camera_frame_samples_get_count(ar_camera_frame_samples_t camera_frame_samples) AR_REFINED_FOR_SWIFT;
@@ -358,11 +394,12 @@
/**
Returns a bool value that indicates whether the two camera frame samples are equal.
- @param camera_frame_sample A camera frame sample to be compared.
- @param other_camera_frame_sample The other camera frame sample to be compared to.
+ - Parameters:
+ - camera_frame_sample: A camera frame sample to be compared.
+ - other_camera_frame_sample: The other camera frame sample to be compared to.
- @return YES if the camera frame samples are equal, otherwise NO.
- */
+ - Returns: `YES` if the camera frame samples are equal, otherwise `NO`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool
ar_camera_frame_sample_is_equal_to_camera_frame_sample(ar_camera_frame_sample_t _Nullable camera_frame_sample,
@@ -371,20 +408,20 @@
/**
Get the `CVPixelBufferRef` for this frame buffer.
- @param camera_frame_sample The camera frame sample.
+ - Parameter camera_frame_sample: The camera frame sample.
- @return The pixel buffer.
- */
+ - Returns: The pixel buffer.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN CVPixelBufferRef ar_camera_frame_sample_get_pixel_buffer(ar_camera_frame_sample_t camera_frame_sample) AR_REFINED_FOR_SWIFT;
/**
Get the camera frame parameters for this camera frame sample.
- @param camera_frame_sample The camera frame sample.
+ - Parameter camera_frame_sample: The camera frame sample.
- @return The camera frame parameters.
- */
+ - Returns: The camera frame parameters.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN ar_camera_frame_parameters_t ar_camera_frame_sample_get_camera_frame_parameters(ar_camera_frame_sample_t camera_frame_sample)
AR_REFINED_FOR_SWIFT;
@@ -394,11 +431,12 @@
/**
Returns a bool value that indicates whether the two camera frame parameters are equal.
- @param camera_frame_parameters Camera frame parameters to be compared.
- @param other_camera_frame_parameters The other camera frame parameters to be compared to.
+ - Parameters:
+ - camera_frame_parameters: Camera frame parameters to be compared.
+ - other_camera_frame_parameters: The other camera frame parameters to be compared to.
- @return YES if the camera frame parameters are equal, otherwise NO.
- */
+ - Returns: `YES` if the camera frame parameters are equal, otherwise `NO`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool ar_camera_frame_parameters_is_equal_to_camera_frame_parameters(ar_camera_frame_parameters_t _Nullable camera_frame_parameters,
ar_camera_frame_parameters_t _Nullable other_camera_frame_parameters)
@@ -406,66 +444,82 @@
/**
Get the camera intrinsics.
- @param camera_frame_parameters The camera frame parameters.
- @return The camera intrinsics.
- */
+
+ - Parameter camera_frame_parameters: The camera frame parameters.
+
+ - Returns: The camera intrinsics.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN simd_float3x3 ar_camera_frame_parameters_get_intrinsics(ar_camera_frame_parameters_t camera_frame_parameters) AR_REFINED_FOR_SWIFT;
/**
Get the camera extrinsics.
- @param camera_frame_parameters The camera frame parameters.
- @return The camera extrinsics.
- */
+
+ - Parameter camera_frame_parameters: The camera frame parameters.
+
+ - Returns: The camera extrinsics.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN simd_float4x4 ar_camera_frame_parameters_get_extrinsics(ar_camera_frame_parameters_t camera_frame_parameters) AR_REFINED_FOR_SWIFT;
/**
Get the frame capture timestamp.
- @param camera_frame_parameters The camera frame parameters.
- @return The frame capture timestamp as mach absolute time in seconds.
- */
+
+ - Parameter camera_frame_parameters: The camera frame parameters.
+
+ - Returns: The frame capture timestamp as mach absolute time in seconds.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN CFTimeInterval ar_camera_frame_parameters_get_capture_timestamp(ar_camera_frame_parameters_t camera_frame_parameters) AR_REFINED_FOR_SWIFT;
/**
Get the frame mid exposure timestamp.
- @param camera_frame_parameters The camera frame parameters.
- @return The frame mid exposure timestamp as mach absolute time in seconds.
- */
+
+ - Parameter camera_frame_parameters: The camera frame parameters.
+
+ - Returns: The frame mid exposure timestamp as mach absolute time in seconds.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN CFTimeInterval ar_camera_frame_parameters_get_mid_exposure_timestamp(ar_camera_frame_parameters_t camera_frame_parameters)
AR_REFINED_FOR_SWIFT;
/**
Get the white balance correlated color temperature in kelvin.
- @param camera_frame_parameters The camera frame parameters.
- @return The color temperature in kelvin.
- */
+
+ - Parameter camera_frame_parameters: The camera frame parameters.
+
+ - Returns: The color temperature in kelvin.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN uint32_t ar_camera_frame_parameters_get_color_temperature(ar_camera_frame_parameters_t camera_frame_parameters) AR_REFINED_FOR_SWIFT;
/**
Get the frame exposure duration.
- @param camera_frame_parameters The camera frame parameters.
- @return The exposure duration time in seconds.
- */
+
+ - Parameter camera_frame_parameters: The camera frame parameters.
+
+ - Returns: The exposure duration time in seconds.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN CFTimeInterval ar_camera_frame_parameters_get_exposure_duration(ar_camera_frame_parameters_t camera_frame_parameters) AR_REFINED_FOR_SWIFT;
/**
Get the camera type.
- @param camera_frame_parameters The camera frame parameters.
- @return The camera type.
- */
+
+ - Parameter camera_frame_parameters: The camera frame parameters.
+
+ - Returns: The camera type.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN ar_camera_type_t ar_camera_frame_parameters_get_camera_type(ar_camera_frame_parameters_t camera_frame_parameters) AR_REFINED_FOR_SWIFT;
/**
Get the camera position.
- @param camera_frame_parameters The camera frame parameters.
- @return The camera position.
- */
+
+ - Parameter camera_frame_parameters: The camera frame parameters.
+
+ - Returns: The camera position.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN ar_camera_position_t ar_camera_frame_parameters_get_camera_position(ar_camera_frame_parameters_t camera_frame_parameters)
AR_REFINED_FOR_SWIFT;
@@ -477,17 +531,19 @@
An enterprise license and/or entitlement is required to receive camera frames, and will otherwise be a no-op.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_camera_frame_provider_t`.
- */
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_camera_frame_provider_t`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_camera_frame_provider_t ar_camera_frame_provider_create(void) AR_REFINED_FOR_SWIFT;
#ifdef __BLOCKS__
/**
Handler for observing an updated camera frame.
- @param camera_frame The camera frame.
- */
+
+ - Parameter camera_frame: The camera frame.
+*/
API_AVAILABLE(visionos(2.0))
typedef void (^ar_camera_frame_update_handler_t)(ar_camera_frame_t camera_frame) AR_REFINED_FOR_SWIFT;
@@ -496,13 +552,15 @@
An enterprise license and/or entitlement is required to receive camera frames, and will otherwise be a no-op.
- @param camera_frame_provider The camera frame provider.
- @param camera_video_format The camera video format.
- @param camera_frame_update_queue The camera frame update queue. Passing NULL will default to the main queue.
- @param camera_frame_update_handler The camera frame update handler.
+ - Parameters:
+ - camera_frame_provider: The camera frame provider.
+ - camera_video_format: The camera video format.
+ - camera_frame_update_queue: The camera frame update queue. Passing `NULL` will default to the main queue.
+ - camera_frame_update_handler: The camera frame update handler.
- @note Setting this handler will override the function set using `ar_camera_frame_provider_set_update_handler_f` for given `ar_camera_video_format_t`.
- */
+ - Note: Setting this handler will override the function set using `ar_camera_frame_provider_set_update_handler_f` for given
+ `ar_camera_video_format_t`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void
ar_camera_frame_provider_set_update_handler(ar_camera_frame_provider_t camera_frame_provider,
@@ -514,9 +572,10 @@
/**
Function for observing an updated camera frame.
- @param context The application-defined context.
- @param camera_frame The camera frame.
- */
+ - Parameters:
+ - context: The application-defined context.
+ - camera_frame: The camera frame.
+*/
API_AVAILABLE(visionos(2.0))
typedef void (*ar_camera_frame_update_handler_function_t)(void *_Nullable context, ar_camera_frame_t camera_frame) AR_REFINED_FOR_SWIFT;
@@ -525,14 +584,15 @@
An enterprise license and/or entitlement is required to receive camera frames, and will otherwise be a no-op.
- @param camera_frame_provider The camera frame provider.
- @param camera_video_format The camera video format.
- @param camera_frame_update_queue The camera frame update queue. Passing NULL will default to the main queue.
- @param context The application-defined context parameter to pass to the function.
- @param camera_frame_update_handler_function The camera frame update handler function.
+ - Parameters:
+ - camera_frame_provider: The camera frame provider.
+ - camera_video_format: The camera video format.
+ - camera_frame_update_queue: The camera frame update queue. Passing `NULL` will default to the main queue.
+ - context: The application-defined context parameter to pass to the function.
+ - camera_frame_update_handler_function: The camera frame update handler function.
- @note Setting this function will override the handler set using `ar_camera_frame_provider_set_update_handler`.
- */
+ - Note: Setting this function will override the handler set using `ar_camera_frame_provider_set_update_handler`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_camera_frame_provider_set_update_handler_f(ar_camera_frame_provider_t camera_frame_provider,
ar_camera_video_format_t camera_video_format,
@@ -544,19 +604,20 @@
/**
Determine whether this device supports the camera frame provider.
- @return `true` if the camera frame provider is supported on this device, `false` otherwise.
- */
+ - Returns: `true` if the camera frame provider is supported on this device, `false` otherwise.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool ar_camera_frame_provider_is_supported(void) AR_REFINED_FOR_SWIFT;
/**
Get the authorization type required by the camera frame provider.
- @return The required authorization type.
- */
+ - Returns: The required authorization type.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN ar_authorization_type_t ar_camera_frame_provider_get_required_authorization_type(void) AR_REFINED_FOR_SWIFT;
+API_UNAVAILABLE_END; // macCatalyst
API_UNAVAILABLE_END; // macos
AR_ASSUME_NONNULL_END
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/camera_region.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/camera_region.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/camera_region.h 1969-12-31 19:00:00
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/camera_region.h 2026-05-22 07:32:10
@@ -0,0 +1,567 @@
+#if (defined(USE_ARKIT_PUBLIC_HEADERS) && USE_ARKIT_PUBLIC_HEADERS) || !__has_include(<ARKitCore/camera_region.h>)
+//
+// camera_region.h
+// ARKit
+//
+// Copyright © 2025 Apple Inc. All rights reserved.
+//
+
+#ifndef camera_region_h
+#define camera_region_h
+
+#import <ARKit/anchor.h>
+#import <ARKit/data_provider.h>
+#import <ARKit/error.h>
+#import <ARKit/object.h>
+#import <ARKit/transform_correction.h>
+#import <CoreVideo/CVPixelBuffer.h>
+#import <simd/simd.h>
+
+AR_ASSUME_NONNULL_BEGIN
+
+API_UNAVAILABLE_BEGIN(macos);
+API_UNAVAILABLE_BEGIN(macCatalyst);
+
+/**
+ An anchor representing a camera region with enhanced image processing.
+ */
+AR_OBJECT_DECL_SUBCLASS(ar_camera_region_anchor, ar_anchor)
+AR_REFINED_FOR_SWIFT
+API_AVAILABLE(visionos(26.0));
+
+/**
+ A collection of camera region anchors.
+ */
+AR_OBJECT_DECL(ar_camera_region_anchors)
+AR_REFINED_FOR_SWIFT
+API_AVAILABLE(visionos(26.0));
+
+/**
+ Configuration for camera region processing.
+ */
+AR_OBJECT_DECL(ar_camera_region_configuration)
+AR_REFINED_FOR_SWIFT
+API_AVAILABLE(visionos(26.0));
+
+/**
+ A data provider for camera region processing.
+ */
+AR_OBJECT_DECL_SUBCLASS(ar_camera_region_provider, ar_data_provider)
+AR_REFINED_FOR_SWIFT
+API_AVAILABLE(visionos(26.0));
+
+/**
+ Error codes specific to the camera region provider.
+ */
+API_AVAILABLE(visionos(26.0))
+OS_ENUM(ar_camera_region_error_code,
+ ar_error_code_t,
+ /// Error code indicating that a camera region anchor failed to be added.
+ ar_camera_region_error_code_add_anchor_failed = 1300,
+ /// Error code indicating that the maximum amount of camera region anchors for its respective camera enhancement have been added.
+ ar_camera_region_error_code_anchor_max_limit_reached = 1301,
+ /// Error code indicating that a camera region anchor failed to be removed.
+ ar_camera_region_error_code_remove_anchor_failed = 1302)
+AR_REFINED_FOR_SWIFT;
+
+/**
+ Enum describing camera enhancement types.
+ - Note: These will affect the frame rate of the output.
+*/
+API_AVAILABLE(visionos(26.0))
+OS_ENUM(ar_camera_region_camera_enhancement,
+ intptr_t,
+ /** Solely camera stabilization. Implicitly included in other enhancements. */
+ ar_camera_region_stabilization = 0,
+ /** Contrast & Vibrancy enhancement. */
+ ar_camera_region_contrast_and_vibrancy = 1, )
+AR_REFINED_FOR_SWIFT;
+
+#pragma mark - Camera Region Anchor
+
+/**
+ Returns a bool value that indicates whether the two camera region anchors are equal.
+
+ - Parameters:
+ - camera_region_anchor: A camera region anchor to be compared.
+ - other_camera_region_anchor: The other camera region anchor to be compared to.
+
+ - Returns: `true` if the camera region anchors are equal, `false` otherwise.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN bool
+ ar_camera_region_anchor_is_equal_to_camera_region_anchor(ar_camera_region_anchor_t _Nullable camera_region_anchor,
+ ar_camera_region_anchor_t _Nullable other_camera_region_anchor) AR_REFINED_FOR_SWIFT;
+
+/**
+ Create a camera region anchor using a transform from the anchor to the origin coordinate system, a specified size, and a camera enhancement.
+
+ - Parameters:
+ - origin_from_anchor_transform: The origin from anchor transform.
+ - width: The width of the anchor (along the X-axis), in meters.
+ - height: The height of the anchor (along the Y-axis), in meters.
+ - camera_enhancement: The desired camera enhancement.
+
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_camera_region_anchor_t`.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_camera_region_anchor_t
+ar_camera_region_anchor_create_with_parameters(simd_float4x4 origin_from_anchor_transform,
+ float width,
+ float height,
+ ar_camera_region_camera_enhancement_t camera_enhancement) AR_REFINED_FOR_SWIFT;
+
+/**
+ Get the width of a given anchor.
+
+ - Parameter camera_region_anchor: The anchor.
+
+ - Returns: The width of the anchor.
+ - Note: The width of the anchor is the length along the X-axis, in meters. This is [-width/2, width/2] from the center.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN float ar_camera_region_anchor_get_width(ar_camera_region_anchor_t camera_region_anchor) AR_REFINED_FOR_SWIFT;
+
+/**
+ Get the height of a given anchor.
+
+ - Parameter camera_region_anchor: The anchor.
+
+ - Returns: The height of the anchor.
+ - Note: The height of the anchor is the length along the Y-axis, in meters. This is [-height/2, height/2] from the center.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN float ar_camera_region_anchor_get_height(ar_camera_region_anchor_t camera_region_anchor) AR_REFINED_FOR_SWIFT;
+
+/**
+ Get the camera enhancement type for a given anchor.
+
+ - Parameter camera_region_anchor: The anchor.
+
+ - Returns: The anchor's camera enhancement.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN ar_camera_region_camera_enhancement_t ar_camera_region_anchor_get_camera_enhancement(ar_camera_region_anchor_t camera_region_anchor)
+ AR_REFINED_FOR_SWIFT;
+
+/**
+ Get the `CVPixelBufferRef` for this anchor.
+
+ - Parameter camera_region_anchor: The anchor.
+
+ - Returns: The pixel buffer, or NULL if not set. Retain and release as necessary.
+ - Note: Retaining too many pixel buffers may lead to memory issues.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN CVPixelBufferRef _Nullable ar_camera_region_anchor_get_pixel_buffer(ar_camera_region_anchor_t camera_region_anchor) AR_REFINED_FOR_SWIFT;
+
+#pragma mark - Camera Region Anchor (ar_anchor convenience getters)
+
+/**
+ Get the identifier of an anchor.
+
+ - Parameters:
+ - camera_region_anchor: The anchor.
+ - out_identifier: A pointer to a UUID to fill out with the anchor identifier. Must be non-null.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void ar_camera_region_anchor_get_identifier(ar_camera_region_anchor_t camera_region_anchor,
+ uuid_t _Nonnull out_identifier) AR_REFINED_FOR_SWIFT;
+
+/**
+ Get the transform from an anchor to the origin coordinate system.
+
+ - Parameter camera_region_anchor: The anchor.
+
+ - Returns: The transform of the anchor.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN simd_float4x4 ar_camera_region_anchor_get_origin_from_anchor_transform(ar_camera_region_anchor_t camera_region_anchor) AR_REFINED_FOR_SWIFT;
+
+/**
+ Get the transform from an anchor to the origin coordinate system.
+
+ - Parameters:
+ - camera_region_anchor: The anchor.
+ - transform_correction: The transform correction that should be applied.
+
+ - Returns: The transform of the anchor.
+*/
+API_AVAILABLE(visionos(27.0))
+AR_EXTERN simd_float4x4 ar_camera_region_anchor_get_origin_from_anchor_transform_with_correction(
+ ar_camera_region_anchor_t camera_region_anchor, ar_transform_correction_t transform_correction) AR_REFINED_FOR_SWIFT;
+
+/**
+ Get the timestamp corresponding to an anchor.
+
+ - Parameter camera_region_anchor: The anchor.
+
+ - Returns: The timestamp associated with the anchor.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN CFTimeInterval ar_camera_region_anchor_get_timestamp(ar_camera_region_anchor_t camera_region_anchor) AR_REFINED_FOR_SWIFT;
+
+#pragma mark - Camera Region Anchors Collection
+
+/**
+ Get the count of camera region anchors in a collection.
+
+ - Parameter camera_region_anchors: The collection of camera region anchors.
+
+ - Returns: The number of camera region anchors in the collection.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN size_t ar_camera_region_anchors_get_count(ar_camera_region_anchors_t camera_region_anchors) AR_REFINED_FOR_SWIFT;
+
+#ifdef __BLOCKS__
+/**
+ Handler for enumerating a collection of camera region anchors.
+
+ - Parameter camera_region_anchor: The camera region anchor.
+
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
+API_AVAILABLE(visionos(26.0))
+typedef bool (^ar_camera_region_anchors_enumerator_t)(ar_camera_region_anchor_t camera_region_anchor) AR_REFINED_FOR_SWIFT;
+
+/**
+ Enumerate a collection of camera region anchors.
+
+ - Parameters:
+ - camera_region_anchors: The collection of camera region anchors.
+ - camera_region_anchors_enumerator: The enumerator handler.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void
+ar_camera_region_anchors_enumerate_anchors(ar_camera_region_anchors_t camera_region_anchors,
+ ar_camera_region_anchors_enumerator_t camera_region_anchors_enumerator) AR_REFINED_FOR_SWIFT;
+#endif // __BLOCKS__
+
+/**
+ Function for enumerating a collection of camera region anchors.
+
+ - Parameters:
+ - context: The application-defined context.
+ - camera_region_anchor: The camera region anchor.
+
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
+API_AVAILABLE(visionos(26.0))
+typedef bool (*ar_camera_region_anchors_enumerator_function_t)(void *_Nullable context,
+ ar_camera_region_anchor_t camera_region_anchor) AR_REFINED_FOR_SWIFT;
+
+/**
+ Enumerate a collection of camera region anchors using a function.
+
+ - Parameters:
+ - camera_region_anchors: The collection of camera region anchors.
+ - context: The application-defined context parameter to pass to the function.
+ - camera_region_anchors_enumerator_function: The enumerator function.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void ar_camera_region_anchors_enumerate_anchors_f(ar_camera_region_anchors_t camera_region_anchors,
+ void *_Nullable context,
+ ar_camera_region_anchors_enumerator_function_t camera_region_anchors_enumerator_function)
+ AR_REFINED_FOR_SWIFT;
+
+#pragma mark - Camera Region Configuration
+
+/**
+ Create a camera region configuration.
+
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_camera_region_configuration_t`.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_camera_region_configuration_t ar_camera_region_configuration_create(void) AR_REFINED_FOR_SWIFT;
+
+#pragma mark - Camera Region Provider
+
+/**
+ Create a camera region provider.
+
+ - Parameter camera_region_configuration: Camera Region configuration.
+
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_camera_region_provider_t`.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_camera_region_provider_t
+ar_camera_region_provider_create(ar_camera_region_configuration_t camera_region_configuration) AR_REFINED_FOR_SWIFT;
+
+/**
+ Determine whether this device supports the camera region provider.
+
+ - Returns: `true` if the camera region provider is supported on this device, `false` otherwise.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN bool ar_camera_region_provider_is_supported(void) AR_REFINED_FOR_SWIFT;
+
+/**
+ Get the authorization type required by the camera region provider.
+
+ - Returns: The required authorization type.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN ar_authorization_type_t ar_camera_region_provider_get_required_authorization_type(void) AR_REFINED_FOR_SWIFT;
+
+#ifdef __BLOCKS__
+/**
+ Handler called when there are updates to a specific camera region anchor.
+
+ - Parameters:
+ - added_anchor: The anchor that was added.
+ - updated_anchor: The anchor that was updated.
+ - removed_anchor: The anchor that was removed.
+*/
+API_AVAILABLE(visionos(26.0))
+typedef void (^ar_camera_region_anchor_update_handler_t)(_Nullable ar_camera_region_anchor_t added_anchor,
+ _Nullable ar_camera_region_anchor_t updated_anchor,
+ _Nullable ar_camera_region_anchor_t removed_anchor) AR_REFINED_FOR_SWIFT;
+
+/**
+ Set the handler for receiving camera region updates for a specific anchor identifier.
+
+ - Parameters:
+ - camera_region_provider: The camera region provider.
+ - camera_region_anchor_identifier: The camera region anchor identifier to get updates for.
+ - camera_region_anchor_updates_queue: The queue on which the handler will be called. Passing NULL will default to the main queue.
+ - camera_region_anchor_update_handler: The handler to be called when new camera region anchor data arrives.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void ar_camera_region_provider_set_update_handler_for_anchor_with_identifier(
+ ar_camera_region_provider_t camera_region_provider,
+ uuid_t _Nonnull camera_region_anchor_identifier,
+ dispatch_queue_t _Nullable camera_region_anchor_updates_queue,
+ ar_camera_region_anchor_update_handler_t _Nullable camera_region_anchor_update_handler) AR_REFINED_FOR_SWIFT;
+#endif // __BLOCKS__
+
+/**
+ Function called when there are updates to a specific camera region anchor.
+
+ - Parameters:
+ - context: The application-defined context.
+ - added_anchor: The anchor that was added.
+ - updated_anchor: The anchor that was updated.
+ - removed_anchor: The anchor that was removed.
+*/
+API_AVAILABLE(visionos(26.0))
+typedef void (*ar_camera_region_anchor_update_handler_function_t)(void *_Nullable context,
+ ar_camera_region_anchor_t added_anchor,
+ ar_camera_region_anchor_t updated_anchor,
+ ar_camera_region_anchor_t removed_anchor) AR_REFINED_FOR_SWIFT;
+
+/**
+ Set the function for receiving camera region updates for a specific anchor identifier.
+
+ - Parameters:
+ - camera_region_provider: The camera region provider.
+ - camera_region_anchor_identifier: The camera region anchor identifier to get updates for.
+ - camera_region_anchor_updates_queue: The queue on which the function will be called. Passing NULL will default to the main queue.
+ - context: The application-defined context parameter to pass to the function.
+ - camera_region_anchor_update_handler_function: The function to be called when new camera region anchor data arrives.
+
+ - Note: Setting this function will override the handler set using `ar_camera_region_provider_set_update_handler_for_anchor_with_identifier`.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void ar_camera_region_provider_set_update_handler_for_anchor_with_identifier_f(
+ ar_camera_region_provider_t camera_region_provider,
+ uuid_t _Nonnull camera_region_anchor_identifier,
+ dispatch_queue_t _Nullable camera_region_anchor_updates_queue,
+ void *_Nullable context,
+ ar_camera_region_anchor_update_handler_function_t _Nullable camera_region_anchor_update_handler_function) AR_REFINED_FOR_SWIFT;
+
+#ifdef __BLOCKS__
+/**
+ Handler called when a request to add a camera region anchor has completed (successfully or not).
+
+ - Parameters:
+ - camera_region_anchor: The camera region anchor to be added.
+ - successful: `true` if the camera region anchor was successfully added, `false` otherwise.
+ - error: The error that occurred, if any.
+*/
+API_AVAILABLE(visionos(26.0))
+typedef void (^ar_camera_region_add_anchor_completion_handler_t)(ar_camera_region_anchor_t camera_region_anchor,
+ bool successful,
+ ar_error_t _Nullable error) AR_REFINED_FOR_SWIFT;
+
+/**
+ Add a camera region anchor to a camera region provider.
+
+ - Parameters:
+ - camera_region_provider: The camera region provider.
+ - camera_region_anchor: The camera region anchor to add.
+ - add_anchor_completion_handler: The handler to be called after the request to add the camera region anchor completes.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void ar_camera_region_provider_add_camera_region_anchor(ar_camera_region_provider_t camera_region_provider,
+ ar_camera_region_anchor_t camera_region_anchor,
+ ar_camera_region_add_anchor_completion_handler_t add_anchor_completion_handler)
+ AR_REFINED_FOR_SWIFT;
+#endif // __BLOCKS__
+
+/**
+ Function called when a request to add a camera region anchor has completed (successfully or not).
+
+ - Parameters:
+ - context: The application-defined context.
+ - camera_region_anchor: The camera region anchor to be added.
+ - successful: `true` if the camera region anchor was successfully added, `false` otherwise.
+ - error: The error that occurred, if any.
+*/
+API_AVAILABLE(visionos(26.0))
+typedef void (*ar_camera_region_add_anchor_completion_handler_function_t)(void *_Nullable context,
+ ar_camera_region_anchor_t camera_region_anchor,
+ bool successful,
+ ar_error_t _Nullable error) AR_REFINED_FOR_SWIFT;
+
+/**
+ Add a camera region anchor to an camera region provider using a function.
+
+ - Parameters:
+ - camera_region_provider: The camera region provider.
+ - camera_region_anchor: The camera region anchor to add.
+ - context: The application-defined context parameter to pass to the function.
+ - add_anchor_completion_handler_function: The function to be called after the request to add the camera region anchor completes.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void ar_camera_region_provider_add_camera_region_anchor_f(
+ ar_camera_region_provider_t camera_region_provider,
+ ar_camera_region_anchor_t camera_region_anchor,
+ void *_Nullable context,
+ ar_camera_region_add_anchor_completion_handler_function_t add_anchor_completion_handler_function) AR_REFINED_FOR_SWIFT;
+
+#ifdef __BLOCKS__
+/**
+ Handler called when a request to remove a camera region anchor has completed (successfully or not).
+
+ - Parameters:
+ - camera_region_anchor: The camera region anchor to be removed.
+ - successful: `true` if the camera region anchor was successfully removed, `false` otherwise.
+ - error: The error that occurred, if any.
+*/
+API_AVAILABLE(visionos(26.0))
+typedef void (^ar_camera_region_remove_anchor_completion_handler_t)(ar_camera_region_anchor_t camera_region_anchor,
+ bool successful,
+ ar_error_t _Nullable error) AR_REFINED_FOR_SWIFT;
+
+/**
+ Remove a camera region anchor from a camera region provider.
+
+ - Parameters:
+ - camera_region_provider: The camera region provider.
+ - camera_region_anchor: The camera region anchor.
+ - remove_anchor_completion_handler: The handler to be called after the request to remove the camera region anchor completes.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void ar_camera_region_provider_remove_camera_region_anchor(
+ ar_camera_region_provider_t camera_region_provider,
+ ar_camera_region_anchor_t camera_region_anchor,
+ ar_camera_region_remove_anchor_completion_handler_t remove_anchor_completion_handler) AR_REFINED_FOR_SWIFT;
+
+/**
+ Handler called when a request to remove a camera region anchor by its identifier has completed (successfully or not).
+
+ - Parameters:
+ - camera_region_anchor_identifier: The identifier of the camera region anchor requested to be removed.
+ - successful: `true` if the camera region anchor was successfully removed, `false` otherwise.
+ - error: The error that occurred, if any.
+*/
+API_AVAILABLE(visionos(26.0))
+typedef void (^ar_camera_region_remove_anchor_with_identifier_completion_handler_t)(uuid_t _Nonnull camera_region_anchor_identifier,
+ bool successful,
+ ar_error_t _Nullable error) AR_REFINED_FOR_SWIFT;
+
+/**
+ Remove a camera region anchor from a camera region provider by its identifier.
+
+ - Parameters:
+ - camera_region_provider: The camera region provider.
+ - camera_region_anchor_identifier: The identifier of the camera region anchor to remove.
+ - remove_anchor_with_identifier_completion_handler: The handler to be called after the request to remove the camera region anchor by its
+ identifier completes.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void ar_camera_region_provider_remove_camera_region_anchor_with_identifier(
+ ar_camera_region_provider_t camera_region_provider,
+ uuid_t _Nonnull camera_region_anchor_identifier,
+ ar_camera_region_remove_anchor_with_identifier_completion_handler_t remove_anchor_with_identifier_completion_handler) AR_REFINED_FOR_SWIFT;
+#endif // __BLOCKS__
+
+/**
+ Function called when a request to remove a camera region anchor has completed (successfully or not).
+
+ - Parameters:
+ - context: The application-defined context.
+ - camera_region_anchor: The camera region anchor to be removed.
+ - successful: `true` if the camera region anchor was successfully removed, `false` otherwise.
+ - error: The error that occurred, if any.
+*/
+API_AVAILABLE(visionos(26.0))
+typedef void (*ar_camera_region_remove_anchor_completion_handler_function_t)(void *_Nullable context,
+ ar_camera_region_anchor_t camera_region_anchor,
+ bool successful,
+ ar_error_t _Nullable error) AR_REFINED_FOR_SWIFT;
+
+/**
+ Remove a camera region anchor from a camera region provider using a function.
+
+ - Parameters:
+ - camera_region_provider: The camera region provider.
+ - camera_region_anchor: The camera region anchor to remove.
+ - context: The application-defined context parameter to pass to the function.
+ - remove_anchor_completion_handler_function: The function to be called after the request to remove the camera region anchor completes.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void ar_camera_region_provider_remove_camera_region_anchor_f(
+ ar_camera_region_provider_t camera_region_provider,
+ ar_camera_region_anchor_t camera_region_anchor,
+ void *_Nullable context,
+ ar_camera_region_remove_anchor_completion_handler_function_t remove_anchor_completion_handler_function) AR_REFINED_FOR_SWIFT;
+
+/**
+ Function called when a request to remove a camera region anchor by its identifier has completed (successfully or not).
+
+ - Parameters:
+ - context: The application-defined context.
+ - camera_region_anchor_identifier: The identifier of the camera region anchor requested to be removed.
+ - successful: `true` if the camera region anchor was successfully removed, `false` otherwise.
+ - error: The error that occurred, if any.
+*/
+API_AVAILABLE(visionos(26.0))
+typedef void (*ar_camera_region_remove_anchor_with_identifier_completion_handler_function_t)(void *_Nullable context,
+ uuid_t _Nonnull camera_region_anchor_identifier,
+ bool successful,
+ ar_error_t _Nullable error) AR_REFINED_FOR_SWIFT;
+
+/**
+ Remove a camera region anchor from a camera region provider by its identifier using a function.
+
+ - Parameters:
+ - camera_region_provider: The camera region provider.
+ - camera_region_anchor_identifier: The identifier of the camera region anchor to remove.
+ - context: The application-defined context parameter to pass to the function.
+ - remove_anchor_with_identifier_completion_handler_function: The function to be called after the request to remove the camera region anchor by
+ its identifier completes.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void ar_camera_region_provider_remove_camera_region_anchor_with_identifier_f(
+ ar_camera_region_provider_t camera_region_provider,
+ uuid_t _Nonnull camera_region_anchor_identifier,
+ void *_Nullable context,
+ ar_camera_region_remove_anchor_with_identifier_completion_handler_function_t remove_anchor_with_identifier_completion_handler_function)
+ AR_REFINED_FOR_SWIFT;
+
+API_UNAVAILABLE_END; // macCatalyst
+API_UNAVAILABLE_END; // macos
+
+AR_ASSUME_NONNULL_END
+
+#endif // camera_region_h
+#else
+#import <ARKitCore/camera_region.h>
+#endif // #if (defined(USE_ARKIT_PUBLIC_HEADERS) \&\& USE_ARKIT_PUBLIC_HEADERS) || !__has_include(<ARKitCore/camera_region.h>)
\ No newline at end of file
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/data.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/data.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/data.h 2026-04-19 01:08:31
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/data.h 2026-05-22 07:32:10
@@ -15,31 +15,35 @@
AR_ASSUME_NONNULL_BEGIN
-API_UNAVAILABLE_BEGIN(macos);
-
+/**
+ A container for binary data.
+ */
AR_OBJECT_DECL(ar_data)
AR_REFINED_FOR_SWIFT
-API_AVAILABLE(visionos(2.0));
+API_AVAILABLE(visionos(2.0))
+API_UNAVAILABLE(macos, macCatalyst);
#pragma mark - Data
/**
Get a pointer to the data's bytes.
- @return A pointer to the data's bytes.
- */
+ - Returns: A pointer to the data's bytes.
+*/
API_AVAILABLE(visionos(2.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN const void *ar_data_get_bytes(ar_data_t data) AR_REFINED_FOR_SWIFT;
/**
Get the length of the data, in bytes.
- @return The length of the data, in bytes.
- */
+ - Parameter data: The data.
+
+ - Returns: The length of the data, in bytes.
+*/
API_AVAILABLE(visionos(2.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN size_t ar_data_get_length(ar_data_t data) AR_REFINED_FOR_SWIFT;
-
-API_UNAVAILABLE_END; // macos
AR_ASSUME_NONNULL_END
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/data_provider.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/data_provider.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/data_provider.h 2026-04-18 22:53:34
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/data_provider.h 2026-06-01 00:37:42
@@ -18,18 +18,24 @@
#pragma mark - Data Provider
+/**
+ Base type for all ARKit data providers.
+ */
AR_OBJECT_DECL(ar_data_provider)
AR_REFINED_FOR_SWIFT
-API_AVAILABLE(visionos(1.0), macos(26.0));
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0));
+/**
+ A collection of data providers.
+ */
AR_OBJECT_DECL(ar_data_providers)
AR_REFINED_FOR_SWIFT
-API_AVAILABLE(visionos(1.0), macos(26.0));
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0));
/**
State of a data provider.
*/
-API_AVAILABLE(visionos(1.0), macos(26.0))
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
OS_ENUM(ar_data_provider_state, intptr_t,
ar_data_provider_state_initialized,
ar_data_provider_state_running,
@@ -40,22 +46,22 @@
/**
Get the state of a data provider.
- @param data_provider The data provider.
+ - Parameter data_provider: The data provider.
- @return The state of the data provider.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Returns: The state of the data provider.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN ar_data_provider_state_t ar_data_provider_get_state(ar_data_provider_t data_provider) AR_REFINED_FOR_SWIFT;
/**
Get the authorization type required by a data provider.
- @param data_provider The data provider.
+ - Parameter data_provider: The data provider.
- @return The authorization type required by the data provider.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Returns: The authorization type required by the data provider.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN ar_authorization_type_t ar_data_provider_get_required_authorization_type(ar_data_provider_t data_provider) AR_REFINED_FOR_SWIFT;
#pragma mark - Data Providers Collection
@@ -63,91 +69,98 @@
/**
Create an empty collection of data providers.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_data_providers_t`.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_data_providers_t`.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_data_providers_t ar_data_providers_create(void) AR_REFINED_FOR_SWIFT;
/**
Create a collection of data providers populated with given data providers.
- @param data_provider The nil-terminated list of data providers to add to a newly created collection.
+ - Parameter data_provider: The `nil`-terminated list of data providers to add to a newly created collection.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_data_providers_t`.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_data_providers_t`.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_data_providers_t ar_data_providers_create_with_data_providers(ar_data_provider_t data_provider, ...)
NS_REQUIRES_NIL_TERMINATION AR_REFINED_FOR_SWIFT;
/**
Add a data provider to a collection.
- @param data_providers The collection to expand.
- @param data_provider_to_add The data provider to add.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Parameters:
+ - data_providers: The collection to expand.
+ - data_provider_to_add: The data provider to add.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN void ar_data_providers_add_data_provider(ar_data_providers_t data_providers, ar_data_provider_t data_provider_to_add) AR_REFINED_FOR_SWIFT;
/**
Add data providers to a collection.
- @param data_providers The collection to expand.
- @param data_providers_to_add The collection of data providers to add.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Parameters:
+ - data_providers: The collection to expand.
+ - data_providers_to_add: The collection of data providers to add.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN void ar_data_providers_add_data_providers(ar_data_providers_t data_providers,
ar_data_providers_t data_providers_to_add) AR_REFINED_FOR_SWIFT;
/**
Remove a data provider from a collection.
- @param data_providers The collection from which to remove.
- @param data_provider_to_remove The data provider to remove.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Parameters:
+ - data_providers: The collection from which to remove.
+ - data_provider_to_remove: The data provider to remove.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN void ar_data_providers_remove_data_provider(ar_data_providers_t data_providers,
ar_data_provider_t data_provider_to_remove) AR_REFINED_FOR_SWIFT;
/**
Remove data providers from a collection.
- @param data_providers The collection from which to remove.
- @param data_providers_to_remove The collection of data providers to remove.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Parameters:
+ - data_providers: The collection from which to remove.
+ - data_providers_to_remove: The collection of data providers to remove.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN void ar_data_providers_remove_data_providers(ar_data_providers_t data_providers,
ar_data_providers_t data_providers_to_remove) AR_REFINED_FOR_SWIFT;
/**
Get the count of data providers in a collection.
- @param data_providers The collection of data providers.
+ - Parameter data_providers: The collection of data providers.
- @return The number of data providers in the collection.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Returns: The number of data providers in the collection.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN size_t ar_data_providers_get_count(ar_data_providers_t data_providers) AR_REFINED_FOR_SWIFT;
#ifdef __BLOCKS__
/**
Handler for enumerating a collection of data providers.
- @param data_provider The data provider.
+ - Parameter data_provider: The data provider.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
typedef bool (^ar_data_providers_enumerator_t)(ar_data_provider_t data_provider) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of data providers.
- @param data_providers The collection of data providers.
- @param data_providers_enumerator The enumerator handler.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Parameters:
+ - data_providers: The collection of data providers.
+ - data_providers_enumerator: The enumerator handler.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN void ar_data_providers_enumerate_data_providers(ar_data_providers_t data_providers,
ar_data_providers_enumerator_t data_providers_enumerator) AR_REFINED_FOR_SWIFT;
#endif // __BLOCKS__
@@ -155,22 +168,24 @@
/**
Function for enumerating a collection of data providers.
- @param context The application-defined context.
- @param data_provider The data provider.
+ - Parameters:
+ - context: The application-defined context.
+ - data_provider: The data provider.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
typedef bool (*ar_data_providers_enumerator_function_t)(void *_Nullable context, ar_data_provider_t data_provider) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of data providers using a function.
- @param data_providers The collection of data providers.
- @param context The application-defined context parameter to pass to the function.
- @param data_providers_enumerator_function The enumerator function.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Parameters:
+ - data_providers: The collection of data providers.
+ - context: The application-defined context parameter to pass to the function.
+ - data_providers_enumerator_function: The enumerator function.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN void
ar_data_providers_enumerate_data_providers_f(ar_data_providers_t data_providers,
void *_Nullable context,
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/environment_light_estimation.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/environment_light_estimation.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/environment_light_estimation.h 2026-04-18 22:53:34
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/environment_light_estimation.h 2026-05-22 07:32:10
@@ -17,6 +17,7 @@
#import <ARKit/data_provider.h>
#import <ARKit/object.h>
#import <ARKit/session.h>
+#import <ARKit/transform_correction.h>
#import <dispatch/dispatch.h>
#import <simd/types.h>
@@ -24,19 +25,32 @@
AR_ASSUME_NONNULL_BEGIN
API_UNAVAILABLE_BEGIN(macos);
+API_UNAVAILABLE_BEGIN(macCatalyst);
+/**
+ An anchor providing environment lighting information for realistic rendering.
+ */
AR_OBJECT_DECL_SUBCLASS(ar_environment_probe_anchor, ar_anchor)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(2.0));
+/**
+ A collection of environment probe anchors.
+ */
AR_OBJECT_DECL(ar_environment_probe_anchors)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(2.0));
+/**
+ Configuration for environment light estimation.
+ */
AR_OBJECT_DECL(ar_environment_light_estimation_configuration)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(2.0));
+/**
+ A data provider for environment light estimation.
+ */
AR_OBJECT_DECL_SUBCLASS(ar_environment_light_estimation_provider, ar_data_provider)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(2.0));
@@ -46,11 +60,12 @@
/**
Returns a bool value that indicates whether the two environment probe anchors are equal.
- @param environment_probe_anchor A environment probe anchor to be compared.
- @param other_environment_probe_anchor The other environment probe anchor to be compared to.
+ - Parameters:
+ - environment_probe_anchor: A environment probe anchor to be compared.
+ - other_environment_probe_anchor: The other environment probe anchor to be compared to.
- @return YES if the environment probe anchors are equal, otherwise NO.
- */
+ - Returns: `YES` if the environment probe anchors are equal, otherwise `NO`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool ar_environment_probe_anchor_is_equal_to_environment_probe_anchor(
ar_environment_probe_anchor_t _Nullable environment_probe_anchor,
@@ -60,14 +75,16 @@
/**
Get the environment texture of an environment probe anchor.
- @param environment_probe An environment probe anchor.
-
- @discussion The texture is provided as a cube using MTLTextureTypeCube,
+ The texture is provided as a cube using MTLTextureTypeCube,
containing rgb floating point linear high-dynamic range values in P3 color space.
- @note Textures could be nil if the person is not in a well-lit environment. The lifetime of this texture is tied to the lifetime of the
+
+ - Parameter environment_probe: An environment probe anchor.
+
+ - Note: Textures could be `nil` if the person is not in a well-lit environment. The lifetime of this texture is tied to the lifetime of the
`ar_environment_probe_anchor_t`.
- @return Returns a MTLTextureTypeCube.
- */
+
+ - Returns: Returns a `MTLTextureTypeCube`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN id<MTLTexture> _Nullable ar_environment_probe_anchor_get_environment_texture(ar_environment_probe_anchor_t environment_probe)
AR_REFINED_FOR_SWIFT;
@@ -76,14 +93,14 @@
/**
Get the camera scale reference of an environment probe anchor.
- @param environment_probe An environment probe anchor.
-
- @return Returns the camera scale reference of a pixel with rgb value [1,1,1] in the environment texture.
-
- @discussion The environment texture stores floating point linear high-dynamic range rgb values in P3 color space.
+ The environment texture stores floating point linear high-dynamic range rgb values in P3 color space.
In order to have a consistent brightness between texture updates, the cameraScaleReference allows you to translate the local brightness from the
current environment texture to the absolute brightness range from the camera.
- */
+
+ - Parameter environment_probe: An environment probe anchor.
+
+ - Returns: Returns the camera scale reference of a pixel with rgb value [1,1,1] in the environment texture.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN float ar_environment_probe_anchor_get_camera_scale_reference(ar_environment_probe_anchor_t environment_probe) AR_REFINED_FOR_SWIFT;
@@ -92,29 +109,43 @@
/**
Get the identifier of an anchor.
- @param[in] anchor The anchor.
- @param[out] out_identifier A pointer to a UUID to fill out with the anchor identifier. Must be non-null.
- */
+ - Parameters:
+ - anchor: The anchor.
+ - out_identifier: A pointer to a UUID to fill out with the anchor identifier. Must be non-null.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_environment_probe_anchor_get_identifier(ar_environment_probe_anchor_t anchor, uuid_t _Nonnull out_identifier) AR_REFINED_FOR_SWIFT;
/**
Get the transform from an anchor to the origin coordinate system.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return The origin from anchor transform.
- */
+ - Returns: The origin from anchor transform.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN simd_float4x4 ar_environment_probe_anchor_get_origin_from_anchor_transform(ar_environment_probe_anchor_t anchor) AR_REFINED_FOR_SWIFT;
/**
+ Get the transform from an anchor to the origin coordinate system.
+
+ - Parameters:
+ - anchor: The anchor.
+ - transform_correction: The transform correction that should be applied.
+
+ - Returns: The origin from anchor transform.
+*/
+API_AVAILABLE(visionos(27.0))
+AR_EXTERN simd_float4x4 ar_environment_probe_anchor_get_origin_from_anchor_transform_with_correction(
+ ar_environment_probe_anchor_t anchor, ar_transform_correction_t transform_correction) AR_REFINED_FOR_SWIFT;
+
+/**
Get the timestamp corresponding to an anchor.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return The timestamp associated with the anchor.
- */
+ - Returns: The timestamp associated with the anchor.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN CFTimeInterval ar_environment_probe_anchor_get_timestamp(ar_environment_probe_anchor_t anchor) AR_REFINED_FOR_SWIFT;
@@ -123,10 +154,10 @@
/**
Get the count of environment probe anchors in the collection.
- @param environment_probe_anchors The collection of environment probe anchors.
+ - Parameter environment_probe_anchors: The collection of environment probe anchors.
- @return The number of environment probe anchors in the collection.
- */
+ - Returns: The number of environment probe anchors in the collection.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN size_t ar_environment_probe_anchors_get_count(ar_environment_probe_anchors_t environment_probe_anchors) AR_REFINED_FOR_SWIFT;
@@ -134,19 +165,20 @@
/**
Handler for enumerating a collection of environment probe anchors.
- @param environment_probe_anchor The environment probe anchor.
+ - Parameter environment_probe_anchor: The environment probe anchor.
- @return Return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: Return `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(2.0))
typedef bool (^ar_environment_probe_anchors_enumerator_t)(ar_environment_probe_anchor_t environment_probe_anchor) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of environment probe anchors.
- @param environment_probe_anchors The collection of environment probe anchors.
- @param environment_probe_anchors_enumerator The enumerator handler.
- */
+ - Parameters:
+ - environment_probe_anchors: The collection of environment probe anchors.
+ - environment_probe_anchors_enumerator: The enumerator handler.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void
ar_environment_probe_anchors_enumerate_anchors(ar_environment_probe_anchors_t environment_probe_anchors,
@@ -156,11 +188,12 @@
/**
Function for enumerating a collection of environment probe anchors.
- @param context The application-defined context.
- @param environment_probe_anchor The environment probe anchor.
+ - Parameters:
+ - context: The application-defined context.
+ - environment_probe_anchor: The environment probe anchor.
- @return Return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: Return `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(2.0))
typedef bool (*ar_environment_probe_anchors_enumerator_function_t)(void *_Nullable context,
ar_environment_probe_anchor_t environment_probe_anchor) AR_REFINED_FOR_SWIFT;
@@ -168,10 +201,11 @@
/**
Enumerate a collection of environment probe anchors.
- @param environment_probe_anchors The collection of environment probe anchors.
- @param context The application-defined context parameter to pass to the function.
- @param environment_probe_anchors_enumerator_function The enumerator function.
- */
+ - Parameters:
+ - environment_probe_anchors: The collection of environment probe anchors.
+ - context: The application-defined context parameter to pass to the function.
+ - environment_probe_anchors_enumerator_function: The enumerator function.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_environment_probe_anchors_enumerate_anchors_f(
ar_environment_probe_anchors_t environment_probe_anchors,
@@ -183,9 +217,10 @@
/**
Create an environment light estimation configuration.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_environment_light_estimation_configuration_t`.
- */
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_environment_light_estimation_configuration_t`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_environment_light_estimation_configuration_t ar_environment_light_estimation_configuration_create(void)
AR_REFINED_FOR_SWIFT;
@@ -196,10 +231,11 @@
/**
Handler triggered when there are updates to environment probe anchors.
- @param added_anchors Collection of anchors that are added.
- @param updated_anchors Collection of anchors that are updated.
- @param removed_anchors Collection of anchors that are removed.
- */
+ - Parameters:
+ - added_anchors: Collection of anchors that are added.
+ - updated_anchors: Collection of anchors that are updated.
+ - removed_anchors: Collection of anchors that are removed.
+*/
API_AVAILABLE(visionos(2.0))
typedef void (^ar_environment_light_estimation_update_handler_t)(ar_environment_probe_anchors_t added_anchors,
ar_environment_probe_anchors_t updated_anchors,
@@ -209,11 +245,12 @@
/**
Function to be called when there are updates to environment probe anchors.
- @param context The application-defined context.
- @param added_anchors Collection of anchors that are added.
- @param updated_anchors Collection of anchors that are updated.
- @param removed_anchors Collection of anchors that are removed.
- */
+ - Parameters:
+ - context: The application-defined context.
+ - added_anchors: Collection of anchors that are added.
+ - updated_anchors: Collection of anchors that are updated.
+ - removed_anchors: Collection of anchors that are removed.
+*/
API_AVAILABLE(visionos(2.0))
typedef void (*ar_environment_light_estimation_update_handler_function_t)(void *_Nullable context,
ar_environment_probe_anchors_t added_anchors,
@@ -223,11 +260,12 @@
/**
Create an environment light estimation provider.
- @param environment_light_estimation_configuration Environment light estimation configuration.
+ - Parameter environment_light_estimation_configuration: Environment light estimation configuration.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_environment_light_estimation_provider_t`.
- */
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_environment_light_estimation_provider_t`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_environment_light_estimation_provider_t ar_environment_light_estimation_provider_create(
ar_environment_light_estimation_configuration_t environment_light_estimation_configuration) AR_REFINED_FOR_SWIFT;
@@ -235,8 +273,8 @@
/**
Determines whether this device supports the environment light estimation provider.
- @return Returns `true` if the environment light estimation provider is supported on this device, `false` otherwise.
- */
+ - Returns: Returns `true` if the environment light estimation provider is supported on this device, `false` otherwise.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool ar_environment_light_estimation_provider_is_supported(void) AR_REFINED_FOR_SWIFT;
@@ -244,14 +282,15 @@
/**
Set the handler for receiving environment light estimation updates.
- @param environment_light_estimation_provider Environment light estimation provider.
- @param environment_light_estimation_anchor_updates_queue Queue on which the handler will be executed,
- sending NULL will default to the main queue.
- @param environment_light_estimation_update_handler Handler to be triggered when new data
- arrives.
+ - Parameters:
+ - environment_light_estimation_provider: Environment light estimation provider.
+ - environment_light_estimation_anchor_updates_queue: Queue on which the handler will be executed,
+ sending `NULL` will default to the main queue.
+ - environment_light_estimation_update_handler: Handler to be triggered when new data
+ arrives.
- @note Setting this function will override the handler set using `ar_environment_light_estimation_provider_set_probe_update_handler_f`.
- */
+ - Note: Setting this function will override the handler set using `ar_environment_light_estimation_provider_set_probe_update_handler_f`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_environment_light_estimation_provider_set_update_handler(
ar_environment_light_estimation_provider_t environment_light_estimation_provider,
@@ -262,13 +301,14 @@
/**
Set the function for receiving environment light estimation updates.
- @param environment_light_estimation_provider Environment light estimation provider.
- @param environment_light_estimation_anchor_updates_queue Queue on which the function will be called. Passing NULL will default to the main queue.
- @param context The application-defined context parameter to pass to the function.
- @param environment_light_estimation_update_handler_function The function to be called when new data arrives.
+ - Parameters:
+ - environment_light_estimation_provider: The environment light estimation provider.
+ - environment_light_estimation_anchor_updates_queue: the queue on which the function will be called. Passing `NULL` will default to the main queue.
+ - context: The application-defined context parameter to pass to the function.
+ - environment_light_estimation_update_handler_function: The function to be called when new data arrives.
- @note Setting this function will override the handler set using `ar_environment_light_estimation_provider_set_probe_update_handler`.
- */
+ - Note: Setting this function will override the handler set using `ar_environment_light_estimation_provider_set_probe_update_handler`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_environment_light_estimation_provider_set_update_handler_f(
ar_environment_light_estimation_provider_t environment_light_estimation_provider,
@@ -279,11 +319,12 @@
/**
Get the authorization type required by the environment light estimation provider.
- @return Authorization type.
- */
+ - Returns: An authorization type.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN ar_authorization_type_t ar_environment_light_estimation_provider_get_required_authorization_type(void) AR_REFINED_FOR_SWIFT;
+API_UNAVAILABLE_END; // macCatalyst
API_UNAVAILABLE_END; // macos
AR_ASSUME_NONNULL_END
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/error.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/error.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/error.h 2026-04-19 01:08:31
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/error.h 2026-05-22 07:32:10
@@ -19,31 +19,40 @@
#pragma mark - Error
+/**
+ Represents an error in ARKit.
+ */
AR_OBJECT_DECL(ar_error)
AR_REFINED_FOR_SWIFT
-API_AVAILABLE(visionos(1.0), macos(26.0));
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0));
-API_AVAILABLE(visionos(1.0), macos(26.0)) AR_EXTERN const CFStringRef ar_error_domain AR_REFINED_FOR_SWIFT;
-API_AVAILABLE(visionos(1.0), macos(26.0)) typedef intptr_t ar_error_code_t AR_REFINED_FOR_SWIFT;
+/**
+ The error domain for ARKit errors.
+ */
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0)) AR_EXTERN const CFStringRef ar_error_domain AR_REFINED_FOR_SWIFT;
+/**
+ Error code type for ARKit errors.
+ */
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0)) typedef intptr_t ar_error_code_t AR_REFINED_FOR_SWIFT;
/**
Get the error code associated with an error.
- @param error The `ar_error_t` instance.
+ - Parameter error: The `ar_error_t` instance.
- @return The error code.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Returns: The error code.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN ar_error_code_t ar_error_get_error_code(ar_error_t error) AR_REFINED_FOR_SWIFT;
/**
Copy out a `CFErrorRef` that represents an `ar_error_t`.
- @param error The `ar_error_t` instance.
+ - Parameter error: The `ar_error_t` instance.
- @return The `CFErrorRef`. The caller is responsible for calling `CFRelease` on the returned pointer.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Returns: The `CFErrorRef`. The caller is responsible for calling `CFRelease` on the returned pointer.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN CF_RETURNS_RETAINED CFErrorRef ar_error_copy_cf_error(ar_error_t error) AR_REFINED_FOR_SWIFT;
AR_ASSUME_NONNULL_END
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/hand_skeleton.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/hand_skeleton.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/hand_skeleton.h 2026-04-18 22:53:33
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/hand_skeleton.h 2026-05-22 07:32:10
@@ -17,15 +17,21 @@
AR_ASSUME_NONNULL_BEGIN
-API_UNAVAILABLE_BEGIN(macos);
-
+/**
+ Represents a hand skeleton with joints and their transforms.
+ */
AR_OBJECT_DECL(ar_hand_skeleton)
AR_REFINED_FOR_SWIFT
-API_AVAILABLE(visionos(1.0));
+API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst);
#pragma mark - Hand Skeleton Constants
+/**
+ Joint names in the hand skeleton.
+ */
API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst)
OS_ENUM(ar_hand_skeleton_joint_name, uint64_t,
ar_hand_skeleton_joint_name_wrist = 0,
ar_hand_skeleton_joint_name_thumb_knuckle = 1,
@@ -61,44 +67,51 @@
/**
Create a hand skeleton in a neutral pose that allows access to constants like joint indices, names, counts, etc.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_hand_skeleton_t`.
- */
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_hand_skeleton_t`.
+*/
API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_hand_skeleton_t ar_hand_skeleton_create(void) AR_REFINED_FOR_SWIFT;
/**
Returns a bool value that indicates whether the two hand skeletons are equal.
- @param hand_skeleton A hand skeleton to be compared.
- @param other_hand_skeleton The other hand skeleton to be compared to.
+ - Parameters:
+ - hand_skeleton: A hand skeleton to be compared.
+ - other_hand_skeleton: The other hand skeleton to be compared to.
- @return YES if the hand skeletons are equal, otherwise NO.
- */
+ - Returns: `YES` if the hand skeletons are equal, otherwise `NO`.
+*/
API_AVAILABLE(visionos(2.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN bool ar_hand_skeleton_is_equal_to_hand_skeleton(ar_hand_skeleton_t _Nullable hand_skeleton,
ar_hand_skeleton_t _Nullable other_hand_skeleton) AR_REFINED_FOR_SWIFT;
/**
Get a joint by it's name from the hand skeleton.
- @param hand_skeleton The hand skeleton.
- @param joint_name The joint index.
+ - Parameters:
+ - hand_skeleton: The hand skeleton.
+ - joint_name: The joint index.
- @return An instance of `ar_skeleton_joint_t`.
- */
+ - Returns: An instance of `ar_skeleton_joint_t`.
+*/
API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN ar_skeleton_joint_t ar_hand_skeleton_get_joint_named(ar_hand_skeleton_t hand_skeleton,
ar_hand_skeleton_joint_name_t joint_name) AR_REFINED_FOR_SWIFT;
/**
Get the total number of joints in the hand skeleton.
- @param hand_skeleton The hand skeleton.
+ - Parameter hand_skeleton: The hand skeleton.
- @return The number of joints.
- */
+ - Returns: The number of joints.
+*/
API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN uint64_t ar_hand_skeleton_get_joint_count(ar_hand_skeleton_t hand_skeleton) AR_REFINED_FOR_SWIFT;
#ifdef __BLOCKS__
@@ -106,10 +119,12 @@
/**
Enumerate the names of joints in an `ar_hand_skeleton_t` using an enumeration block.
- @param hand_skeleton The hand skeleton.
- @param joint_enumerator The enumerator block.
- */
+ - Parameters:
+ - hand_skeleton: The hand skeleton.
+ - joint_enumerator: The enumerator block.
+*/
API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN void ar_hand_skeleton_enumerate_joints(ar_hand_skeleton_t hand_skeleton,
ar_skeleton_joint_enumerator_t joint_enumerator) AR_REFINED_FOR_SWIFT;
#endif // __BLOCKS__
@@ -117,16 +132,16 @@
/**
Enumerate the joints in an `ar_hand_skeleton_t` using a function.
- @param hand_skeleton The hand skeleton.
- @param context The application-defined context parameter to pass to the function.
- @param joint_enumerator_function The enumerator function.
- */
+ - Parameters:
+ - hand_skeleton: The hand skeleton.
+ - context: The application-defined context parameter to pass to the function.
+ - joint_enumerator_function: The enumerator function.
+*/
API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN void ar_hand_skeleton_enumerate_joints_f(ar_hand_skeleton_t hand_skeleton,
void *_Nullable context,
ar_skeleton_joint_enumerator_function_t joint_enumerator_function) AR_REFINED_FOR_SWIFT;
-
-API_UNAVAILABLE_END; // macos
AR_ASSUME_NONNULL_END
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/hand_tracking.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/hand_tracking.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/hand_tracking.h 2026-04-18 22:53:34
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/hand_tracking.h 2026-05-22 07:32:10
@@ -14,6 +14,7 @@
#import <ARKit/hand_skeleton.h>
#import <ARKit/object.h>
#import <ARKit/session.h>
+#import <ARKit/transform_correction.h>
#import <dispatch/dispatch.h>
#import <os/availability.h>
@@ -21,12 +22,11 @@
AR_ASSUME_NONNULL_BEGIN
-API_UNAVAILABLE_BEGIN(macos);
-
/**
Status enum values for the hand anchor at a specified timestamp from the provider.
*/
API_AVAILABLE(visionos(2.0))
+API_UNAVAILABLE(macos, macCatalyst)
OS_ENUM(ar_hand_anchor_query_status, intptr_t,
// The hand anchor at the specified timestamp was successfully obtained.
ar_hand_anchor_query_status_success = 0,
@@ -34,17 +34,29 @@
ar_hand_anchor_query_status_failure)
AR_REFINED_FOR_SWIFT;
+/**
+ An anchor that tracks a hand's position and skeleton.
+ */
AR_OBJECT_DECL_SUBCLASS(ar_hand_anchor, ar_trackable_anchor)
AR_REFINED_FOR_SWIFT
-API_AVAILABLE(visionos(1.0));
+API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst);
+/**
+ Configuration for hand tracking.
+ */
AR_OBJECT_DECL(ar_hand_tracking_configuration)
AR_REFINED_FOR_SWIFT
-API_AVAILABLE(visionos(1.0));
+API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst);
+/**
+ A data provider for hand tracking.
+ */
AR_OBJECT_DECL_SUBCLASS(ar_hand_tracking_provider, ar_data_provider)
AR_REFINED_FOR_SWIFT
-API_AVAILABLE(visionos(1.0));
+API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst);
#pragma mark - Hand Anchor
@@ -52,6 +64,7 @@
Enum for the chirality of a hand.
*/
API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst)
OS_ENUM(ar_hand_chirality, intptr_t,
ar_hand_chirality_right,
ar_hand_chirality_left
@@ -61,6 +74,7 @@
Enum for hand fidelity.
*/
API_AVAILABLE(visionos(26.0))
+API_UNAVAILABLE(macos, macCatalyst)
OS_ENUM(ar_hand_fidelity, intptr_t,
ar_hand_fidelity_nominal,
ar_hand_fidelity_high
@@ -69,52 +83,59 @@
/**
Create a hand anchor.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_hand_anchor_t`.
- */
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_hand_anchor_t`.
+*/
API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_hand_anchor_t ar_hand_anchor_create(void) AR_REFINED_FOR_SWIFT;
/**
Returns a bool value that indicates whether the two hand anchors are equal.
- @param anchor A hand anchor to be compared.
- @param other_anchor The other hand anchor to be compared to.
+ - Parameters:
+ - anchor: A hand anchor to be compared.
+ - other_anchor: The other hand anchor to be compared to.
- @return YES if the hand anchors are equal, otherwise NO.
- */
+ - Returns: `YES` if the hand anchors are equal, otherwise `NO`.
+*/
API_AVAILABLE(visionos(2.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN bool ar_hand_anchor_is_equal_to_hand_anchor(ar_hand_anchor_t _Nullable anchor,
ar_hand_anchor_t _Nullable other_anchor) AR_REFINED_FOR_SWIFT;
/**
Get the hand skeleton of a hand anchor.
- @param hand_anchor The hand anchor.
+ - Parameter hand_anchor: The hand anchor.
- @return The skeleton.
- */
+ - Returns: The skeleton.
+*/
API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN ar_hand_skeleton_t _Nullable ar_hand_anchor_get_hand_skeleton(ar_hand_anchor_t hand_anchor) AR_REFINED_FOR_SWIFT;
/**
Get the chirality of the hand tracked by a hand anchor.
- @param hand_anchor The hand anchor.
+ - Parameter hand_anchor: The hand anchor.
- @return The chirality of the hand.
- */
+ - Returns: The chirality of the hand.
+*/
API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN ar_hand_chirality_t ar_hand_anchor_get_chirality(ar_hand_anchor_t hand_anchor) AR_REFINED_FOR_SWIFT;
/**
Get the fidelity of the hand anchor.
- @param hand_anchor The hand anchor.
+ - Parameter hand_anchor: The hand anchor.
- @return The fidelity of the anchor.
- */
+ - Returns: The fidelity of the anchor.
+*/
API_AVAILABLE(visionos(26.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN ar_hand_fidelity_t ar_hand_anchor_get_fidelity(ar_hand_anchor_t hand_anchor) AR_REFINED_FOR_SWIFT;
#pragma mark - Hand Anchor (ar_anchor convenience getters)
@@ -122,40 +143,62 @@
/**
Get the identifier of an anchor.
- @param[in] anchor The anchor.
- @param[out] out_identifier A pointer to a UUID to fill out with the anchor identifier. Must be non-null.
- */
+ - Parameters:
+ - anchor: The anchor.
+ - out_identifier: A pointer to a UUID to fill out with the anchor identifier. Must be non-null.
+*/
API_AVAILABLE(visionos(2.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN void ar_hand_anchor_get_identifier(ar_hand_anchor_t anchor, uuid_t _Nonnull out_identifier) AR_REFINED_FOR_SWIFT;
/**
Get the transform from an anchor to the origin coordinate system.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return The origin from anchor transform.
- */
+ - Note: This function will return a rendering-corrected transform and is equal to calling
+ `ar_hand_anchor_get_origin_from_anchor_transform_with_correction` with `ar_transform_correction_rendered`.
+
+ - Returns: The origin from anchor transform.
+*/
API_AVAILABLE(visionos(2.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN simd_float4x4 ar_hand_anchor_get_origin_from_anchor_transform(ar_hand_anchor_t anchor) AR_REFINED_FOR_SWIFT;
/**
+ Get the transform from an anchor to the origin coordinate system.
+
+ - Parameters:
+ - hand_anchor: The anchor.
+ - transform_correction: The transform correction that should be applied.
+
+ - Returns: The origin from anchor transform.
+*/
+API_AVAILABLE(visionos(27.0))
+API_UNAVAILABLE(macos, macCatalyst)
+AR_EXTERN simd_float4x4 ar_hand_anchor_get_origin_from_anchor_transform_with_correction(
+ ar_hand_anchor_t hand_anchor, ar_transform_correction_t transform_correction) AR_REFINED_FOR_SWIFT;
+
+/**
Get the timestamp corresponding to an anchor.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return The timestamp associated with the anchor.
- */
+ - Returns: The timestamp associated with the anchor.
+*/
API_AVAILABLE(visionos(2.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN CFTimeInterval ar_hand_anchor_get_timestamp(ar_hand_anchor_t anchor) AR_REFINED_FOR_SWIFT;
/**
Determine whether an anchor is tracked.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return `true` if the anchor is tracked, `false` otherwise.
- */
+ - Returns: `true` if the anchor is tracked, `false` otherwise.
+*/
API_AVAILABLE(visionos(2.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN bool ar_hand_anchor_is_tracked(ar_hand_anchor_t anchor) AR_REFINED_FOR_SWIFT;
#pragma mark - Hand Tracking Configuration
@@ -164,21 +207,25 @@
/**
Handler called when there are updates to hand tracking.
- @param hand_anchor_left The latest left hand anchor.
- @param hand_anchor_right The latest right hand anchor.
- */
+ - Parameters:
+ - hand_anchor_left: The latest left hand anchor.
+ - hand_anchor_right: The latest right hand anchor.
+*/
API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst)
typedef void (^ar_hand_tracking_update_handler_t)(ar_hand_anchor_t hand_anchor_left, ar_hand_anchor_t hand_anchor_right) AR_REFINED_FOR_SWIFT;
#endif // __BLOCKS__
/**
Function to be called when there are updates to hand tracking.
- @param context The application-defined context.
- @param hand_anchor_left The latest left hand anchor.
- @param hand_anchor_right The latest right hand anchor.
- */
+ - Parameters:
+ - context: The application-defined context.
+ - hand_anchor_left: The latest left hand anchor.
+ - hand_anchor_right: The latest right hand anchor.
+*/
API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst)
typedef void (*ar_hand_tracking_update_handler_function_t)(void *_Nullable context,
ar_hand_anchor_t hand_anchor_left,
ar_hand_anchor_t hand_anchor_right) AR_REFINED_FOR_SWIFT;
@@ -186,10 +233,12 @@
/**
Create a hand tracking configuration.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_hand_tracking_configuration_t`.
- */
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_hand_tracking_configuration_t`.
+*/
API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_hand_tracking_configuration_t ar_hand_tracking_configuration_create(void) AR_REFINED_FOR_SWIFT;
#pragma mark - Hand Tracking Provider
@@ -197,12 +246,14 @@
/**
Create a hand tracking provider.
- @param hand_tracking_configuration The configuration for hand tracking.
+ - Parameter hand_tracking_configuration: The configuration for hand tracking.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_hand_tracking_provider_t`.
- */
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_hand_tracking_provider_t`.
+*/
API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_hand_tracking_provider_t
ar_hand_tracking_provider_create(ar_hand_tracking_configuration_t hand_tracking_configuration) AR_REFINED_FOR_SWIFT;
@@ -210,13 +261,15 @@
/**
Set the handler for receiving hand tracking updates.
- @param hand_tracking_provider The hand tracking provider.
- @param hand_anchor_updates_queue The queue on which the handler will be called. Passing NULL will default to the main queue.
- @param hand_tracking_update_handler The handler to be called when new data arrives.
+ - Parameters:
+ - hand_tracking_provider: The hand tracking provider.
+ - hand_anchor_updates_queue: The queue on which the handler will be called. Passing `NULL` will default to the main queue.
+ - hand_tracking_update_handler: The handler to be called when new data arrives.
- @note Setting this handler will override the function set using `ar_hand_tracking_provider_set_update_handler_f`.
- */
+ - Note: Setting this handler will override the function set using `ar_hand_tracking_provider_set_update_handler_f`.
+*/
API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN void
ar_hand_tracking_provider_set_update_handler(ar_hand_tracking_provider_t hand_tracking_provider,
dispatch_queue_t _Nullable hand_anchor_updates_queue,
@@ -226,14 +279,16 @@
/**
Set the function for receiving hand tracking updates.
- @param hand_tracking_provider The hand tracking provider.
- @param hand_anchor_updates_queue The queue on which the function will be called. Passing NULL will default to the main queue.
- @param context The application-defined context parameter to pass to the function.
- @param hand_tracking_update_handler_function The function to be called when new data arrives.
+ - Parameters:
+ - hand_tracking_provider: The hand tracking provider.
+ - hand_anchor_updates_queue: The queue on which the function will be called. Passing NULL will default to the main queue.
+ - context: The application-defined context parameter to pass to the function.
+ - hand_tracking_update_handler_function: The function to be called when new data arrives.
- @note Setting this function will override the handler set using `ar_hand_tracking_provider_set_update_handler`.
- */
+ - Note: Setting this function will override the handler set using `ar_hand_tracking_provider_set_update_handler`.
+*/
API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN void ar_hand_tracking_provider_set_update_handler_f(
ar_hand_tracking_provider_t hand_tracking_provider,
dispatch_queue_t _Nullable hand_anchor_updates_queue,
@@ -243,34 +298,38 @@
/**
Determine whether this device supports the hand tracking provider.
- @return `true` if the hand tracking provider is supported on this device, `false` otherwise.
- */
+ - Returns: `true` if the hand tracking provider is supported on this device, `false` otherwise.
+*/
API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN bool ar_hand_tracking_provider_is_supported(void) AR_REFINED_FOR_SWIFT;
/**
Fill the given `ar_hand_anchor_t` instances with the latest hand tracking data. Subsequent calls will continue returning the latest hand tracking
+
data. New anchor data will be returned when the hand tracking data is updated.
- @note For apps compiled with a visionOS 1.0 SDK, subsequent calls to this function will not update the given `ar_hand_anchor_t` instances, and will
+
+ - Note: For apps compiled with a visionOS 1.0 SDK, subsequent calls to this function will not update the given `ar_hand_anchor_t` instances, and will
return `false` until the latest hand tracking data has arrived.
- @param hand_tracking_provider The hand tracking provider.
- @param hand_anchor_left The `ar_hand_anchor_t` instance for the left hand to be updated.
- @param hand_anchor_right The `ar_hand_anchor_t` instance for the right hand to be updated.
+ - Parameters:
+ - hand_tracking_provider: The hand tracking provider.
+ - hand_anchor_left: The `ar_hand_anchor_t` instance for the left hand to be updated.
+ - hand_anchor_right: The `ar_hand_anchor_t` instance for the right hand to be updated.
- @return `true` on success while the `hand_tracking_provider` is running, `false` otherwise.
- */
+ - Returns: `true` on success while the `hand_tracking_provider` is running, `false` otherwise.
+*/
API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN bool ar_hand_tracking_provider_get_latest_anchors(ar_hand_tracking_provider_t hand_tracking_provider,
ar_hand_anchor_t hand_anchor_left,
ar_hand_anchor_t hand_anchor_right) AR_REFINED_FOR_SWIFT;
/**
- Fill the given `ar_hand_anchor_t` instances with the best estimated tracking data given the provided `timestamp`.
The provided `timestamp`when rendering should be obtained from `cp_frame_timing_get_trackable_anchor_time`.
- @code
+ ```objc
cp_time_t anchor_prediction_time = cp_frame_timing_get_trackable_anchor_time(timing);
CFTimeInterval anchor_prediction_time_seconds = cp_time_to_cf_time_interval(anchor_prediction_time);
@@ -283,14 +342,18 @@
if (ar_trackable_anchor_is_tracked(hand_anchor_right)) {
...
}
- @endcode
+ ```
- @param hand_tracking_provider The hand tracking provider.
- @param timestamp Target timestamp, mach absolute time in seconds.
- @param[out] hand_anchor_left The anchor instance for the left hand to be updated.
- @param[out] hand_anchor_right The anchor instance for the right hand to be updated.
- */
+ - Parameters:
+ - hand_tracking_provider: The hand tracking provider.
+ - timestamp: Target timestamp, mach absolute time in seconds.
+ - hand_anchor_left: The anchor instance for the left hand to be updated.
+ - hand_anchor_right: The anchor instance for the right hand to be updated.
+
+ - Returns: Whether the query was successful or not.
+*/
API_AVAILABLE(visionos(2.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN
ar_hand_anchor_query_status_t ar_hand_tracking_provider_query_anchors_at_timestamp(ar_hand_tracking_provider_t hand_tracking_provider,
CFTimeInterval timestamp,
@@ -300,12 +363,11 @@
/**
Get the authorization type required by the hand tracking provider.
- @return The required authorization type.
- */
+ - Returns: The required authorization type.
+*/
API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN ar_authorization_type_t ar_hand_tracking_provider_get_required_authorization_type(void) AR_REFINED_FOR_SWIFT;
-
-API_UNAVAILABLE_END; // macos
AR_ASSUME_NONNULL_END
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/identifiers.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/identifiers.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/identifiers.h 2026-04-19 01:08:31
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/identifiers.h 2026-05-22 07:32:10
@@ -14,7 +14,11 @@
AR_ASSUME_NONNULL_BEGIN
API_UNAVAILABLE_BEGIN(macos);
+API_UNAVAILABLE_BEGIN(macCatalyst);
+/**
+ A collection of UUID identifiers.
+ */
AR_OBJECT_DECL(ar_identifiers)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(2.0));
@@ -24,11 +28,12 @@
/**
Returns a bool value that indicates whether the two collections of identifiers are equal.
- @param identifiers A collection of identifiers to be compared.
- @param other_identifiers The other collection of identifiers to be compared to.
+ - Parameters:
+ - identifiers: A collection of identifiers to be compared.
+ - other_identifiers: The other collection of identifiers to be compared to.
- @return YES if the collections of identifiers are equal, otherwise NO.
- */
+ - Returns: YES if the collections of identifiers are equal, otherwise NO.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool ar_identifiers_is_equal_to_identifiers(ar_identifiers_t _Nullable identifiers,
ar_identifiers_t _Nullable other_identifiers) AR_REFINED_FOR_SWIFT;
@@ -36,10 +41,10 @@
/**
Get the count of identifiers in a collection.
- @param identifiers The collection of identifiers.
+ - Parameter identifiers: The collection of identifiers.
- @return The number of identifiers in the collection.
- */
+ - Returns: The number of identifiers in the collection.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN size_t ar_identifiers_get_count(ar_identifiers_t identifiers) AR_REFINED_FOR_SWIFT;
@@ -47,21 +52,22 @@
/**
Handler for enumerating a collection of identifiers.
- @param identifier The identifier.
+ - Parameter identifier: The identifier.
- @note The `identifier` will have the same lifetime as the scope of the enumerator.
+ - Note: The `identifier` will have the same lifetime as the scope of the enumerator.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(2.0))
typedef bool (^ar_identifiers_enumerator_t)(uuid_t _Nonnull identifier) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of identifiers.
- @param identifiers The collection of identifiers.
- @param identifiers_enumerator The enumerator handler.
- */
+ - Parameters:
+ - identifiers: The collection of identifiers.
+ - identifiers_enumerator: The enumerator handler.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_identifiers_enumerate_identifiers(ar_identifiers_t identifiers,
ar_identifiers_enumerator_t identifiers_enumerator) AR_REFINED_FOR_SWIFT;
@@ -71,26 +77,29 @@
/**
Function for enumerating a collection of identifiers.
- @param context The application-defined context.
- @param identifier The identifier.
+ - Parameters:
+ - context: The application-defined context.
+ - identifier: The identifier.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(2.0))
typedef bool (*ar_identifiers_enumerator_function_t)(void *_Nullable context, uuid_t _Nonnull identifier) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of identifiers using a function.
- @param identifiers The collection of identifiers.
- @param context The application-defined context parameter to pass to the function.
- @param identifiers_enumerator_function The enumerator function.
- */
+ - Parameters:
+ - identifiers: The collection of identifiers.
+ - context: The application-defined context parameter to pass to the function.
+ - identifiers_enumerator_function: The enumerator function.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_identifiers_enumerate_identifiers_f(ar_identifiers_t identifiers,
void *_Nullable context,
ar_identifiers_enumerator_function_t identifiers_enumerator_function) AR_REFINED_FOR_SWIFT;
+API_UNAVAILABLE_END; // macCatalyst
API_UNAVAILABLE_END; // macos
AR_ASSUME_NONNULL_END
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/image_tracking.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/image_tracking.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/image_tracking.h 2026-04-18 22:53:34
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/image_tracking.h 2026-06-01 00:37:41
@@ -13,6 +13,7 @@
#import <ARKit/data_provider.h>
#import <ARKit/object.h>
#import <ARKit/session.h>
+#import <ARKit/transform_correction.h>
#import <CoreVideo/CVPixelBuffer.h>
#import <ImageIO/CGImageProperties.h>
@@ -23,27 +24,46 @@
AR_ASSUME_NONNULL_BEGIN
API_UNAVAILABLE_BEGIN(macos);
+API_UNAVAILABLE_BEGIN(macCatalyst);
+/**
+ An anchor that tracks an image's position and orientation in the physical environment.
+ */
AR_OBJECT_DECL_SUBCLASS(ar_image_anchor, ar_trackable_anchor)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(1.0));
+/**
+ A collection of image anchors.
+ */
AR_OBJECT_DECL(ar_image_anchors)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(1.0));
+/**
+ A reference image that can be detected and tracked.
+ */
AR_OBJECT_DECL(ar_reference_image)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(1.0));
+/**
+ A collection of reference images.
+ */
AR_OBJECT_DECL(ar_reference_images)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(1.0));
+/**
+ Configuration for image tracking.
+ */
AR_OBJECT_DECL(ar_image_tracking_configuration)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(1.0));
+/**
+ A data provider for image tracking.
+ */
AR_OBJECT_DECL_SUBCLASS(ar_image_tracking_provider, ar_data_provider)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(1.0));
@@ -53,11 +73,12 @@
/**
Returns a bool value that indicates whether the two image anchors are equal.
- @param anchor A image anchor to be compared.
- @param other_anchor The other image anchor to be compared to.
+ - Parameters:
+ - anchor: A image anchor to be compared.
+ - other_anchor: The other image anchor to be compared to.
- @return YES if the image anchors are equal, otherwise NO.
- */
+ - Returns: YES if the image anchors are equal, otherwise NO.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool ar_image_anchor_is_equal_to_image_anchor(ar_image_anchor_t _Nullable anchor,
ar_image_anchor_t _Nullable other_anchor) AR_REFINED_FOR_SWIFT;
@@ -65,21 +86,22 @@
/**
Get the estimated scale factor from an image anchor.
- @param image_anchor The image anchor.
+ - Parameter image_anchor: The image anchor.
- @return The factor between estimated physical size and provided size.
- */
+ - Returns: The factor between estimated physical size and provided size.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN float ar_image_anchor_get_estimated_scale_factor(ar_image_anchor_t image_anchor) AR_REFINED_FOR_SWIFT;
/**
Get the underlying tracked reference image from an image anchor.
- @param image_anchor The image anchor to get the reference image from.
+ - Parameter image_anchor: The image anchor to get the reference image from.
- @note This type supports ARC.
- @return An instance of `ar_reference_image_t`.
- */
+ - Note: This type supports ARC.
+
+ - Returns: An instance of `ar_reference_image_t`.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN ar_reference_image_t ar_image_anchor_get_reference_image(ar_image_anchor_t image_anchor) AR_REFINED_FOR_SWIFT;
@@ -88,39 +110,53 @@
/**
Get the identifier of an anchor.
- @param[in] anchor The anchor.
- @param[out] out_identifier A pointer to a UUID to fill out with the anchor identifier. Must be non-null.
- */
+ - Parameters:
+ - anchor: The anchor.
+ - out_identifier: A pointer to a UUID to fill out with the anchor identifier. Must be non-null.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_image_anchor_get_identifier(ar_image_anchor_t anchor, uuid_t _Nonnull out_identifier) AR_REFINED_FOR_SWIFT;
/**
Get the transform from an anchor to the origin coordinate system.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return The origin from anchor transform.
- */
+ - Returns: The origin from anchor transform.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN simd_float4x4 ar_image_anchor_get_origin_from_anchor_transform(ar_image_anchor_t anchor) AR_REFINED_FOR_SWIFT;
/**
+ Get the transform from an anchor to the origin coordinate system.
+
+ - Parameters:
+ - image_anchor: The anchor.
+ - transform_correction: The transform correction that should be applied.
+
+ - Returns: The origin from anchor transform.
+*/
+API_AVAILABLE(visionos(27.0))
+AR_EXTERN simd_float4x4 ar_image_anchor_get_origin_from_anchor_transform_with_correction(
+ ar_image_anchor_t image_anchor, ar_transform_correction_t transform_correction) AR_REFINED_FOR_SWIFT;
+
+/**
Get the timestamp corresponding to an anchor.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return The timestamp associated with the anchor.
- */
+ - Returns: The timestamp associated with the anchor.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN CFTimeInterval ar_image_anchor_get_timestamp(ar_image_anchor_t anchor) AR_REFINED_FOR_SWIFT;
/**
Determine whether an anchor is tracked.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return `true` if the anchor is tracked, `false` otherwise.
- */
+ - Returns: `true` if the anchor is tracked, `false` otherwise.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool ar_image_anchor_is_tracked(ar_image_anchor_t anchor) AR_REFINED_FOR_SWIFT;
@@ -129,10 +165,10 @@
/**
Get the count of image anchors in a collection.
- @param image_anchors The collection of image anchors.
+ - Parameter image_anchors: The collection of image anchors.
- @return The number of image anchors in the collection.
- */
+ - Returns: The number of image anchors in the collection.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN size_t ar_image_anchors_get_count(ar_image_anchors_t image_anchors) AR_REFINED_FOR_SWIFT;
@@ -140,19 +176,20 @@
/**
Handler for enumerating a collection of image anchors.
- @param image_anchor The image anchor.
+ - Parameter image_anchor: The image anchor.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(1.0))
typedef bool (^ar_image_anchors_enumerator_t)(ar_image_anchor_t image_anchor) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of image anchors.
- @param image_anchors The collection of image anchors.
- @param image_anchors_enumerator The enumerator handler.
- */
+ - Parameters:
+ - image_anchors: The collection of image anchors.
+ - image_anchors_enumerator: The enumerator handler.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN void ar_image_anchors_enumerate_anchors(ar_image_anchors_t image_anchors,
ar_image_anchors_enumerator_t image_anchors_enumerator) AR_REFINED_FOR_SWIFT;
@@ -161,21 +198,23 @@
/**
Function for enumerating a collection of image anchors.
- @param context The application-defined context.
- @param image_anchor The image anchor.
+ - Parameters:
+ - context: The application-defined context.
+ - image_anchor: The image anchor.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(1.0))
typedef bool (*ar_image_anchors_enumerator_function_t)(void *_Nullable context, ar_image_anchor_t image_anchor) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of image anchors using a function.
- @param image_anchors The collection of image anchors.
- @param context The application-defined context parameter to pass to the function.
- @param image_anchors_enumerator_function The enumerator function.
- */
+ - Parameters:
+ - image_anchors: The collection of image anchors.
+ - context: The application-defined context parameter to pass to the function.
+ - image_anchors_enumerator_function: The enumerator function.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN void ar_image_anchors_enumerate_anchors_f(ar_image_anchors_t image_anchors,
void *_Nullable context,
@@ -186,13 +225,15 @@
/**
Create a reference image from a `CVPixelBufferRef`.
- @param pixelBuffer The reference image as `CVPixelBuffer`.
- @param orientation The image orientation.
- @param physicalWidth The width of the physical object, in meters.
+ - Parameters:
+ - pixelBuffer: The reference image as `CVPixelBuffer`.
+ - orientation: The image orientation.
+ - physicalWidth: The width of the physical object, in meters.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_reference_image_t`.
- */
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_reference_image_t`.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_reference_image_t ar_reference_image_create_from_pixel_buffer(CVPixelBufferRef pixelBuffer,
CGImagePropertyOrientation orientation,
@@ -201,13 +242,15 @@
/**
Create a reference image from a `CGImageRef`.
- @param image The reference image as `CGImageRef`.
- @param orientation The image orientation.
- @param physicalWidth The width of the physical object, in meters.
+ - Parameters:
+ - image: The reference image as `CGImageRef`.
+ - orientation: The image orientation.
+ - physicalWidth: The width of the physical object, in meters.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_reference_image_t`.
- */
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_reference_image_t`.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_reference_image_t ar_reference_image_create_from_cgimage(CGImageRef image,
CGImagePropertyOrientation orientation,
@@ -216,11 +259,12 @@
/**
Returns a bool value that indicates whether the two reference images are equal.
- @param reference_image A reference image to be compared.
- @param other_reference_image The other reference image to be compared to.
+ - Parameters:
+ - reference_image: A reference image to be compared.
+ - other_reference_image: The other reference image to be compared to.
- @return YES if the reference images are equal, otherwise NO.
- */
+ - Returns: `YES` if the reference images are equal, otherwise `NO`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool ar_reference_image_is_equal_to_reference_image(ar_reference_image_t _Nullable reference_image,
ar_reference_image_t _Nullable other_reference_image) AR_REFINED_FOR_SWIFT;
@@ -228,52 +272,55 @@
/**
Set a reference image's name.
- @param reference_image The reference image.
- @param name The name to identify the reference image with, or NULL to reset the name.
- */
+ - Parameters:
+ - reference_image: The reference image.
+ - name: The name to identify the reference image with, or `NULL` to reset the name.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN void ar_reference_image_set_name(ar_reference_image_t reference_image, const char *_Nullable name) AR_REFINED_FOR_SWIFT;
/**
Get a reference image's name.
- @param reference_image The reference image.
+ - Parameter reference_image: The reference image.
- @note The returned value will have the same lifetime as the input `ar_reference_image_t`.
- @return The name of the reference image, or NULL if no name is set.
- */
+ - Note: The returned value will have the same lifetime as the input `ar_reference_image_t`.
+
+ - Returns: The name of the reference image, or `NULL` if no name is set.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN const char *_Nullable ar_reference_image_get_name(ar_reference_image_t reference_image) AR_REFINED_FOR_SWIFT;
/**
Get a reference image's resource group name.
- @param reference_image The reference image.
+ - Parameter reference_image: The reference image.
- @note The returned value will have the same lifetime as the input `ar_reference_image_t`.
- @return The resource group name of the reference image, or NULL if it is not set. It will only be set if the reference image was loaded from a
+ - Note: The returned value will have the same lifetime as the input `ar_reference_image_t`.
+
+ - Returns: The resource group name of the reference image, or `NULL` if it is not set. It will only be set if the reference image was loaded from a
resource group.
- */
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN const char *_Nullable ar_reference_image_get_resource_group_name(ar_reference_image_t reference_image) AR_REFINED_FOR_SWIFT;
/**
Get the width of a reference image, in meters.
- @param reference_image The reference image.
+ - Parameter reference_image: The reference image.
- @return The physical width of the reference image, in meters.
- */
+ - Returns: The physical width of the reference image, in meters.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN float ar_reference_image_get_physical_width(ar_reference_image_t reference_image) AR_REFINED_FOR_SWIFT;
/**
Get the height of a reference image, in meters.
- @param reference_image The reference image.
+ - Parameter reference_image: The reference image.
- @return The physical height of the image, in meters.
- */
+ - Returns: The physical height of the image, in meters.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN float ar_reference_image_get_physical_height(ar_reference_image_t reference_image) AR_REFINED_FOR_SWIFT;
@@ -282,21 +329,24 @@
/**
Create an empty collection of reference images.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_reference_images_t`.
- */
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_reference_images_t`.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_reference_images_t ar_reference_images_create(void) AR_REFINED_FOR_SWIFT;
/**
Load reference images from a bundle into a new collection.
- @param group_name The group to load images from.
- @param bundle The bundle to load. If NULL, the main bundle will be loaded.
+ - Parameters:
+ - group_name: The group to load images from.
+ - bundle: The bundle to load. If `NULL`, the main bundle will be loaded.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_reference_images_t`.
- */
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_reference_images_t`.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_reference_images_t
ar_reference_images_load_reference_images_in_group(const char *group_name, CFBundleRef _Nullable bundle) AR_REFINED_FOR_SWIFT;
@@ -304,32 +354,34 @@
/**
Add a reference image to a collection.
- @discussion The image must be unique. A duplicate of any existing image in the collection will not be added.
+ The image must be unique. A duplicate of any existing image in the collection will not be added.
- @param reference_images The collection of reference images to expand.
- @param image_to_add The reference image to add.
- */
+ - Parameters:
+ - reference_images: The collection of reference images to expand.
+ - image_to_add: The reference image to add.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN void ar_reference_images_add_image(ar_reference_images_t reference_images, ar_reference_image_t image_to_add) AR_REFINED_FOR_SWIFT;
/**
Add reference images to a collection.
- @discussion The images must be unique. Duplicates of any existing image in the collection will not be added.
+ The images must be unique. Duplicates of any existing image in the collection will not be added.
- @param reference_images The collection of reference images to expand.
- @param images_to_add The collection of reference images to add.
- */
+ - Parameters:
+ - reference_images: The collection of reference images to expand.
+ - images_to_add: The collection of reference images to add.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN void ar_reference_images_add_images(ar_reference_images_t reference_images, ar_reference_images_t images_to_add) AR_REFINED_FOR_SWIFT;
/**
Get the count of reference images in the collection.
- @param reference_images The collection of reference images.
+ - Parameter reference_images: The collection of reference images.
- @return The number of reference images in the collection.
- */
+ - Returns: The number of reference images in the collection.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN size_t ar_reference_images_get_count(ar_reference_images_t reference_images) AR_REFINED_FOR_SWIFT;
@@ -337,19 +389,20 @@
/**
Handler for enumerating a collection of reference images.
- @param reference_image The reference image.
+ - Parameter reference_image: The reference image.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(1.0))
typedef bool (^ar_reference_images_enumerator_t)(ar_reference_image_t reference_image) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of reference images.
- @param reference_images The collection of reference images.
- @param reference_images_enumerator The enumerator handler.
- */
+ - Parameters:
+ - reference_images: The collection of reference images.
+ - reference_images_enumerator: The enumerator handler.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN void ar_reference_images_enumerate_images(ar_reference_images_t reference_images,
ar_reference_images_enumerator_t reference_images_enumerator) AR_REFINED_FOR_SWIFT;
@@ -358,21 +411,23 @@
/**
Function for enumerating a collection of reference images.
- @param context The application-defined context.
- @param reference_image The reference image.
+ - Parameters:
+ - context: The application-defined context.
+ - reference_image: The reference image.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(1.0))
typedef bool (*ar_reference_images_enumerator_function_t)(void *_Nullable context, ar_reference_image_t reference_image) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of reference images using a function.
- @param reference_images The collection of reference images.
- @param context The application-defined context parameter to pass to the function.
- @param reference_images_enumerator_function The enumerator function.
- */
+ - Parameters:
+ - reference_images: The collection of reference images.
+ - context: The application-defined context parameter to pass to the function.
+ - reference_images_enumerator_function: The enumerator function.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN void
ar_reference_images_enumerate_images_f(ar_reference_images_t reference_images,
@@ -384,19 +439,22 @@
/**
Create an image tracking configuration.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_image_tracking_configuration_t`.
- */
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_image_tracking_configuration_t`.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_image_tracking_configuration_t ar_image_tracking_configuration_create(void) AR_REFINED_FOR_SWIFT;
/**
Add reference images to the set of images to be tracked. The image tracking configuration can run without any reference images, but will not detect
+
anything.
- @param image_tracking_configuration The configuration for image tracking.
- @param reference_images The reference images to add.
- */
+ - Parameters:
+ - image_tracking_configuration: The configuration for image tracking.
+ - reference_images: The reference images to add.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN void ar_image_tracking_configuration_add_reference_images(ar_image_tracking_configuration_t image_tracking_configuration,
ar_reference_images_t reference_images) AR_REFINED_FOR_SWIFT;
@@ -406,11 +464,12 @@
/**
Create an image tracking provider.
- @param image_tracking_configuration The configuration for image tracking.
+ - Parameter image_tracking_configuration: The configuration for image tracking.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_image_tracking_provider_t`.
- */
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_image_tracking_provider_t`.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_image_tracking_provider_t
ar_image_tracking_provider_create(ar_image_tracking_configuration_t image_tracking_configuration) AR_REFINED_FOR_SWIFT;
@@ -419,10 +478,11 @@
/**
Handler called when there are updates to image anchors.
- @param added_anchors The collection of anchors that were added.
- @param updated_anchors The collection of anchors that were updated.
- @param removed_anchors The collection of anchors that were removed.
- */
+ - Parameters:
+ - added_anchors: The collection of anchors that were added.
+ - updated_anchors: The collection of anchors that were updated.
+ - removed_anchors: The collection of anchors that were removed.
+*/
API_AVAILABLE(visionos(1.0))
typedef void (^ar_image_tracking_update_handler_t)(ar_image_anchors_t added_anchors,
ar_image_anchors_t updated_anchors,
@@ -431,12 +491,13 @@
/**
Set the handler for receiving image tracking updates.
- @param image_tracking_provider The image tracking provider.
- @param image_tracking_updates_queue The queue on which the handler will be called. Passing NULL will default to the main queue.
- @param image_tracking_update_handler The handler to be called when new image tracking data arrives.
+ - Parameters:
+ - image_tracking_provider: The image tracking provider.
+ - image_tracking_updates_queue: The queue on which the handler will be called. Passing NULL will default to the main queue.
+ - image_tracking_update_handler: The handler to be called when new image tracking data arrives.
- @note Setting this handler will override the function set using `ar_image_tracking_provider_set_update_handler_f`.
- */
+ - Note: Setting this handler will override the function set using `ar_image_tracking_provider_set_update_handler_f`.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN void
ar_image_tracking_provider_set_update_handler(ar_image_tracking_provider_t image_tracking_provider,
@@ -447,11 +508,12 @@
/**
Function called when there are updates to image anchors.
- @param context The application-defined context.
- @param added_anchors The collection of anchors that were added.
- @param updated_anchors The collection of anchors that were updated.
- @param removed_anchors The collection of anchors that were removed.
- */
+ - Parameters:
+ - context: The application-defined context.
+ - added_anchors: The collection of anchors that were added.
+ - updated_anchors: The collection of anchors that were updated.
+ - removed_anchors: The collection of anchors that were removed.
+*/
API_AVAILABLE(visionos(1.0))
typedef void (*ar_image_tracking_update_handler_function_t)(void *_Nullable context,
ar_image_anchors_t added_anchors,
@@ -461,13 +523,14 @@
/**
Set the function for receiving image tracking updates.
- @param image_tracking_provider The image tracking provider.
- @param image_tracking_updates_queue The queue on which the function will be called. Passing NULL will default to the main queue.
- @param context The application-defined context parameter to pass to the function.
- @param image_tracking_update_handler_function The function to be called when new image tracking data arrives.
+ - Parameters:
+ - image_tracking_provider: The image tracking provider.
+ - image_tracking_updates_queue: The queue on which the function will be called. Passing `NULL` will default to the main queue.
+ - context: The application-defined context parameter to pass to the function.
+ - image_tracking_update_handler_function: The function to be called when new image tracking data arrives.
- @note Setting this function will override the handler set using `ar_image_tracking_provider_set_update_handler`.
- */
+ - Note: Setting this function will override the handler set using `ar_image_tracking_provider_set_update_handler`.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN void ar_image_tracking_provider_set_update_handler_f(
ar_image_tracking_provider_t image_tracking_provider,
@@ -478,11 +541,11 @@
/**
Copy all image anchors.
- @param image_tracking_provider The image tracking provider.
+ - Parameter image_tracking_provider: The image tracking provider.
- @return The collection of all image anchors. This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the
- object.
- */
+ - Returns: The collection of all image anchors. This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release
+ the object.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_image_anchors_t
ar_image_tracking_provider_copy_all_image_anchors(ar_image_tracking_provider_t image_tracking_provider) AR_REFINED_FOR_SWIFT;
@@ -490,19 +553,20 @@
/**
Determine whether this device supports the image tracking provider.
- @return `true` if the image tracking provider is supported on this device, `false` otherwise.
- */
+ - Returns: `true` if the image tracking provider is supported on this device, `false` otherwise.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN bool ar_image_tracking_provider_is_supported(void) AR_REFINED_FOR_SWIFT;
/**
Get the authorization type required by the image tracking provider.
- @return The required authorization type.
- */
+ - Returns: The required authorization type.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN ar_authorization_type_t ar_image_tracking_provider_get_required_authorization_type(void) AR_REFINED_FOR_SWIFT;
+API_UNAVAILABLE_END; // macCatalyst
API_UNAVAILABLE_END; // macos
AR_ASSUME_NONNULL_END
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/object.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/object.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/object.h 2026-04-19 01:08:32
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/object.h 2026-05-22 07:32:10
@@ -84,16 +84,16 @@
/**
Increment the reference count of an ARKit.framework object.
- @param object ARKit.framework object.
- */
+ - Parameter object: An ARKit.framework object.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN __SWIFT_UNAVAILABLE_MSG("Can't be used with ARC") void *_Nullable ar_retain(void *_Nullable object) AR_REFINED_FOR_SWIFT;
/**
Decrement the reference count of an ARKit.framework object.
- @param object ARKit.framework object.
- */
+ - Parameter object: An ARKit.framework object.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN __SWIFT_UNAVAILABLE_MSG("Can't be used with ARC") void ar_release(void *_Nullable object) AR_REFINED_FOR_SWIFT;
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/object_tracking.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/object_tracking.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/object_tracking.h 2026-04-19 01:08:31
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/object_tracking.h 2026-06-01 00:37:41
@@ -13,6 +13,7 @@
#import <ARKit/data_provider.h>
#import <ARKit/error.h>
#import <ARKit/object.h>
+#import <ARKit/transform_correction.h>
#import <dispatch/dispatch.h>
#import <os/availability.h>
@@ -21,6 +22,7 @@
AR_ASSUME_NONNULL_BEGIN
API_UNAVAILABLE_BEGIN(macos);
+API_UNAVAILABLE_BEGIN(macCatalyst);
/** An axis-aligned bounding box for the extent of an object. */
AR_OBJECT_DECL(ar_object_axis_aligned_bounding_box)
@@ -43,6 +45,12 @@
AR_SWIFT_SENDABLE
API_AVAILABLE(visionos(2.0));
+/** Defines a configuration for an individual reference object. */
+AR_OBJECT_DECL(ar_reference_object_configuration)
+AR_REFINED_FOR_SWIFT
+AR_SWIFT_SENDABLE
+API_AVAILABLE(visionos(27.0));
+
/** A collection of reference objects. */
AR_OBJECT_DECL(ar_reference_objects)
AR_REFINED_FOR_SWIFT
@@ -63,11 +71,12 @@
/**
Returns a bool value that indicates whether the two bounding boxes are equal.
- @param bounding_box A bounding box to be compared.
- @param other_bounding_box The other bounding box to be compared to.
+ - Parameters:
+ - bounding_box: A bounding box to be compared.
+ - other_bounding_box: The other bounding box to be compared to.
- @return YES if the bounding boxes are equal, otherwise NO.
- */
+ - Returns: `YES` if the bounding boxes are equal, otherwise `NO`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool ar_object_axis_aligned_bounding_box_is_equal_to_bounding_box(ar_object_axis_aligned_bounding_box_t _Nullable bounding_box,
ar_object_axis_aligned_bounding_box_t _Nullable other_bounding_box)
@@ -76,8 +85,9 @@
/**
Get minimum X, Y, Z coordinates for the bounding box.
- @param bounding_box The bounding box.
- @return Minimum X, Y, and Z.
+ - Parameter bounding_box: The bounding box.
+
+ - Returns: Minimum X, Y, and Z.
*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN simd_float3 ar_object_axis_aligned_bounding_box_get_min(ar_object_axis_aligned_bounding_box_t bounding_box) AR_REFINED_FOR_SWIFT;
@@ -85,21 +95,30 @@
/**
Get maximum X, Y, Z coordinates for the bounding box.
- @param bounding_box The bounding box.
- @return Maximum X, Y, and Z.
+ - Parameter bounding_box: The bounding box.
+
+ - Returns: Maximum X, Y, and Z.
*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN simd_float3 ar_object_axis_aligned_bounding_box_get_max(ar_object_axis_aligned_bounding_box_t bounding_box) AR_REFINED_FOR_SWIFT;
/**
Get center coordinates for the bounding box.
- */
+
+ - Parameter bounding_box: The bounding box.
+
+ - Returns: The center coordinates.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN simd_float3 ar_object_axis_aligned_bounding_box_get_center(ar_object_axis_aligned_bounding_box_t bounding_box) AR_REFINED_FOR_SWIFT;
/**
Get extent for the bounding box.
- */
+
+ - Parameter bounding_box: The bounding box.
+
+ - Returns: The extent.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN simd_float3 ar_object_axis_aligned_bounding_box_get_extent(ar_object_axis_aligned_bounding_box_t bounding_box) AR_REFINED_FOR_SWIFT;
@@ -108,11 +127,12 @@
/**
Returns a bool value that indicates whether the two object anchors are equal.
- @param object_anchor An object anchor to be compared.
- @param other_object_anchor The other object anchor to be compared to.
+ - Parameters:
+ - object_anchor: An object anchor to be compared.
+ - other_object_anchor: The other object anchor to be compared to.
- @return YES if the object anchors are equal, otherwise NO.
- */
+ - Returns: `YES` if the object anchors are equal, otherwise `NO`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool ar_object_anchor_is_equal_to_object_anchor(ar_object_anchor_t _Nullable object_anchor,
ar_object_anchor_t _Nullable other_object_anchor) AR_REFINED_FOR_SWIFT;
@@ -120,8 +140,9 @@
/**
Get bounding box for the object. Aligned with frame defining object's center and axes.
- @param object_anchor The object anchor.
- @return The bounding box.
+ - Parameter object_anchor: The object anchor.
+
+ - Returns: The bounding box.
*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN ar_object_axis_aligned_bounding_box_t ar_object_anchor_get_bounding_box(ar_object_anchor_t object_anchor) AR_REFINED_FOR_SWIFT;
@@ -129,10 +150,10 @@
/**
Get the underlying tracked reference object from an object anchor.
- @param object_anchor The object anchor used for getting the reference object.
+ - Parameter object_anchor: The object anchor used for getting the reference object.
- @return The `ar_reference_object_t` from the anchor.
- */
+ - Returns: The `ar_reference_object_t` from the anchor.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN ar_reference_object_t AR_SWIFT_SENDABLE ar_object_anchor_get_reference_object(ar_object_anchor_t object_anchor) AR_REFINED_FOR_SWIFT;
@@ -141,10 +162,10 @@
/**
Get the count of object anchors in a collection.
- @param object_anchors The collection of object anchors.
+ - Parameter object_anchors: The collection of object anchors.
- @return The number of object anchors in the collection.
- */
+ - Returns: The number of object anchors in the collection.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN size_t ar_object_anchors_get_count(ar_object_anchors_t object_anchors) AR_REFINED_FOR_SWIFT;
@@ -153,39 +174,53 @@
/**
Get the identifier of an anchor.
- @param[in] anchor The anchor.
- @param[out] out_identifier A pointer to a UUID to fill out with the anchor identifier. Must be non-null.
- */
+ - Parameters:
+ - anchor: The anchor.
+ - out_identifier: A pointer to a UUID to fill out with the anchor identifier. Must be non-null.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_object_anchor_get_identifier(ar_object_anchor_t anchor, uuid_t _Nonnull out_identifier) AR_REFINED_FOR_SWIFT;
/**
Get the transform from an anchor to the origin coordinate system.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return The origin from anchor transform.
- */
+ - Returns: The origin from anchor transform.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN simd_float4x4 ar_object_anchor_get_origin_from_anchor_transform(ar_object_anchor_t anchor) AR_REFINED_FOR_SWIFT;
/**
+ Get the transform from an anchor to the origin coordinate system.
+
+ - Parameters:
+ - object_anchor: The anchor.
+ - transform_correction: The transform correction that should be applied.
+
+ - Returns: The origin from anchor transform.
+*/
+API_AVAILABLE(visionos(27.0))
+AR_EXTERN simd_float4x4 ar_object_anchor_get_origin_from_anchor_transform_with_correction(
+ ar_object_anchor_t object_anchor, ar_transform_correction_t transform_correction) AR_REFINED_FOR_SWIFT;
+
+/**
Get the timestamp corresponding to an anchor.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return The timestamp associated with the anchor.
- */
+ - Returns: The timestamp associated with the anchor.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN CFTimeInterval ar_object_anchor_get_timestamp(ar_object_anchor_t anchor) AR_REFINED_FOR_SWIFT;
/**
Determine whether an anchor is tracked.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return `true` if the anchor is tracked, `false` otherwise.
- */
+ - Returns: `true` if the anchor is tracked, `false` otherwise.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool ar_object_anchor_is_tracked(ar_object_anchor_t anchor) AR_REFINED_FOR_SWIFT;
@@ -194,19 +229,20 @@
/**
Handler for enumerating a collection of object anchors.
- @param object_anchor The object anchor.
+ - Parameter object_anchor: The object anchor.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(2.0))
typedef bool (^ar_object_anchors_enumerator_t)(ar_object_anchor_t object_anchor) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of object anchors.
- @param object_anchors The collection of object anchors.
- @param object_anchors_enumerator The enumerator handler.
- */
+ - Parameters:
+ - object_anchors: The collection of object anchors.
+ - object_anchors_enumerator: The enumerator handler.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_object_anchors_enumerate_anchors(ar_object_anchors_t object_anchors,
ar_object_anchors_enumerator_t object_anchors_enumerator) AR_REFINED_FOR_SWIFT;
@@ -216,21 +252,23 @@
/**
Function for enumerating a collection of object anchors.
- @param context The application-defined context.
- @param object_anchor The object anchor.
+ - Parameters:
+ - context: The application-defined context.
+ - object_anchor: The object anchor.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(2.0))
typedef bool (*ar_object_anchors_enumerator_function_t)(void *_Nullable context, ar_object_anchor_t object_anchor) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of object anchors.
- @param object_anchors The collection of object anchors.
- @param context The application-defined context parameter to pass to the function.
- @param object_anchors_enumerator_function The enumerator function.
- */
+ - Parameters:
+ - object_anchors: The collection of object anchors.
+ - context: The application-defined context parameter to pass to the function.
+ - object_anchors_enumerator_function: The enumerator function.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_object_anchors_enumerate_anchors_f(ar_object_anchors_t object_anchors,
void *_Nullable context,
@@ -241,39 +279,46 @@
/**
Returns a bool value that indicates whether the two reference objects are equal.
- @param reference_object A reference object to be compared.
- @param other_reference_object The other reference object to be compared to.
+ - Parameters:
+ - reference_object: A reference object to be compared.
+ - other_reference_object: The other reference object to be compared to.
- @return YES if the reference objects are equal, otherwise NO.
- */
+ - Returns: `YES` if the reference objects are equal, otherwise `NO`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool ar_reference_object_is_equal_to_reference_object(ar_reference_object_t _Nullable reference_object,
ar_reference_object_t _Nullable other_reference_object) AR_REFINED_FOR_SWIFT;
/**
Get identifier for the reference object.
- @param reference_object Reference object.
- @param[out] out_uuid Object to fill with UUID.
- */
+
+ - Parameters:
+ - reference_object: Reference object.
+ - out_uuid: Object to fill with UUID.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_reference_object_get_identifier(ar_reference_object_t reference_object, uuid_t _Nonnull out_uuid) AR_REFINED_FOR_SWIFT;
/**
Get the input file path used to load the reference object.
- @param reference_object Reference object.
- @note The returned value will have the same lifetime as the `ar_reference_object_t`.
- @return The input file path.
- */
+
+ - Parameter reference_object: Reference object.
+
+ - Note: The returned value will have the same lifetime as the `ar_reference_object_t`.
+ - Returns: The input file path.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN
CF_RETURNS_NOT_RETAINED CFURLRef _Nullable ar_reference_object_get_input_file_path(ar_reference_object_t reference_object) AR_REFINED_FOR_SWIFT;
/**
Get path to a copy of the USDZ file for the object, if the object has one.
- @param reference_object Reference object.
- @note The returned value will have the same lifetime as the `ar_reference_object_t`.
- @return The path to the USDZ file.
- */
+
+ - Parameter reference_object: Reference object.
+
+ - Note: The returned value will have the same lifetime as the `ar_reference_object_t`.
+ - Returns: The path to the USDZ file.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN
CF_RETURNS_NOT_RETAINED CFURLRef _Nullable ar_reference_object_get_usdz_file_path(ar_reference_object_t reference_object) AR_REFINED_FOR_SWIFT;
@@ -281,25 +326,78 @@
/**
Get a reference object's name.
- @param reference_object The reference object.
+ - Parameter reference_object: The reference object.
- @note The returned value will have the same lifetime as the input `ar_reference_object_t`.
- @return The name of the reference object, or NULL if no name is set.
- */
+ - Note: The returned value will have the same lifetime as the input `ar_reference_object_t`.
+
+ - Returns: The name of the reference object, or `NULL` if no name is set.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN const char *ar_reference_object_get_name(ar_reference_object_t reference_object) AR_REFINED_FOR_SWIFT;
+#pragma mark - Reference Object Configuration
+
+/**
+ Create a reference object configuration.
+
+ - Note: Default values are set as follows: - `is_high_frame_rate_tracking_enabled`: `false`
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_reference_object_configuration_t`.
+*/
+API_AVAILABLE(visionos(27.0))
+AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_reference_object_configuration_t ar_reference_object_configuration_create(void) AR_REFINED_FOR_SWIFT;
+
+/**
+ Returns a bool value that indicates whether the two reference object configurations are equal.
+
+ - Parameters:
+ - reference_object_configuration: A reference object configuration to be compared.
+ - other_reference_object_configuration: The other reference object configuration to be compared to.
+
+ - Returns: `YES` if the reference object configurations are equal, otherwise `NO`.
+*/
+API_AVAILABLE(visionos(27.0))
+AR_EXTERN bool ar_reference_object_configuration_is_equal_to_reference_object_configuration(
+ ar_reference_object_configuration_t _Nullable reference_object_configuration,
+ ar_reference_object_configuration_t _Nullable other_reference_object_configuration) AR_REFINED_FOR_SWIFT;
+
+/**
+ Sets whether high-frame-rate tracking is enabled on this configuration.
+
+ - Parameters:
+ - reference_object_configuration: The configuration.
+ - high_frame_rate_tracking_enabled: Whether to enable high frame rate tracking.
+*/
+API_AVAILABLE(visionos(27.0))
+AR_EXTERN void ar_reference_object_configuration_enable_high_frame_rate_tracking(ar_reference_object_configuration_t reference_object_configuration,
+ bool high_frame_rate_tracking_enabled) AR_REFINED_FOR_SWIFT;
+
+/**
+ Checks whether high-frame-rate tracking is enabled on this configuration.
+
+ - Parameter reference_object_configuration: The configuration.
+
+ - Returns: The enablement status.
+*/
+API_AVAILABLE(visionos(27.0))
+AR_EXTERN bool ar_reference_object_configuration_is_high_frame_rate_tracking_enabled(
+ ar_reference_object_configuration_t reference_object_configuration) AR_REFINED_FOR_SWIFT;
+
+#pragma mark - Reference Object Loading
+
#ifdef __BLOCKS__
/**
Handler triggered when a request to load a reference object from a URL has completed.
- @param url URL for the reference object that was being loaded.
- @param success `true` if loading succeeded, `false` otherwise.
- @param error The error that occurred, if any. The returned error supports ARC. In non-ARC files, use `ar_release()` to release the error.
- @param reference_object An instance of `ar_reference_object_t` (NULL if loading failed). The returned object supports ARC. In non-ARC files, use
- `ar_release()` to release it.
- */
+ - Parameters:
+ - url: The URL for the reference object that was being loaded.
+ - success: `true` if loading succeeded, `false` otherwise.
+ - error: The error that occurred, if any.
+ - reference_object: An instance of `ar_reference_object_t` (`NULL` if loading failed). The returned object supports ARC. In non-ARC files, use
+ `ar_release()` to release it.
+*/
API_AVAILABLE(visionos(2.0))
typedef void (^ar_reference_object_url_load_completion_handler_t)(CFURLRef url,
bool success,
@@ -309,25 +407,41 @@
/**
Load a reference object from a URL.
- @param url URL pointing to the reference object to load on the file system.
- @param completion_handler Handler triggered after the request to load an object completes.
- */
+ - Parameters:
+ - url: The URL pointing to the reference object to load on the file system.
+ - completion_handler: Handler triggered after the request to load an object completes.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_reference_object_load_from_url(CFURLRef url,
ar_reference_object_url_load_completion_handler_t completion_handler) AR_REFINED_FOR_SWIFT;
+/**
+ Load a reference object from a URL.
+
+ - Parameters:
+ - url: The URL pointing to the reference object to load on the file system.
+ - configuration: Reference object configuration to use.
+ - completion_handler: Handler triggered after the request to load an object completes.
+*/
+API_AVAILABLE(visionos(27.0))
+AR_EXTERN void
+ar_reference_object_load_from_url_with_configuration(CFURLRef url,
+ ar_reference_object_configuration_t configuration,
+ ar_reference_object_url_load_completion_handler_t completion_handler) AR_REFINED_FOR_SWIFT;
+
#endif // __BLOCKS__
/**
Function called when a request to load a reference object from a URL has completed.
- @param context The application-defined context.
- @param url URL for the reference object that was being loaded.
- @param success `true` if loading succeeded, `false` otherwise.
- @param error The error that occurred, if any. The returned error supports ARC. In non-ARC files, use `ar_release()` to release the error.
- @param reference_object An instance of `ar_reference_object_t` (NULL if loading failed). The returned object supports ARC. In non-ARC files, use
- `ar_release()` to release it.
- */
+ - Parameters:
+ - context: The application-defined context.
+ - url: The URL for the reference object that was being loaded.
+ - success: `true` if loading succeeded, `false` otherwise.
+ - error: The error that occurred, if any.
+ - reference_object: An instance of `ar_reference_object_t` (NULL if loading failed). The returned object supports ARC. In non-ARC files, use
+ `ar_release()` to release it.
+*/
API_AVAILABLE(visionos(2.0))
typedef void (*ar_reference_object_url_load_completion_handler_function_t)(void *_Nullable context,
CFURLRef url,
@@ -338,27 +452,46 @@
/**
Load a reference object from a URL.
- @param url URL pointing to the reference object to load on the file system.
- @param completion_handler_function The function to be called after the request to load an object completes.
- */
+ - Parameters:
+ - url: The URL pointing to the reference object to load on the file system.
+ - context: The application-defined context.
+ - completion_handler_function: The function to be called after the request to load an object completes.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void
ar_reference_object_load_from_url_f(CFURLRef url,
void *_Nullable context,
ar_reference_object_url_load_completion_handler_function_t completion_handler_function) AR_REFINED_FOR_SWIFT;
+/**
+ Load a reference object from a URL.
+
+ - Parameters:
+ - url: The URL pointing to the reference object to load on the file system.
+ - configuration: Reference object configuration to use.
+ - context: The application-defined context.
+ - completion_handler_function: Handler triggered after the request to load an object completes.
+*/
+API_AVAILABLE(visionos(27.0))
+AR_EXTERN void ar_reference_object_load_from_url_with_configuration_f(
+ CFURLRef url,
+ ar_reference_object_configuration_t configuration,
+ void *_Nullable context,
+ ar_reference_object_url_load_completion_handler_function_t completion_handler_function) AR_REFINED_FOR_SWIFT;
+
#ifdef __BLOCKS__
/**
Handler triggered when a request to load a reference object from a bundle has completed.
- @param name Name of reference object that was being loaded from bundle.
- @param bundle Bundle used for loading the reference object.
- @param success `true` if loading succeeded, `false` otherwise.
- @param error The error that occurred, if any. The returned error supports ARC. In non-ARC files, use `ar_release()` to release the error.
- @param reference_object An instance of `ar_reference_object_t` (NULL if loading failed). The returned object supports ARC. In non-ARC files, use
- `ar_release()` to release it.
- */
+ - Parameters:
+ - name: The name of reference object that was being loaded from bundle.
+ - bundle: The bundle used for loading the reference object.
+ - success: `true` if loading succeeded, `false` otherwise.
+ - error: The error that occurred, if any.
+ - reference_object: An instance of `ar_reference_object_t` (`NULL` if loading failed). The returned object supports ARC. In non-ARC files, use
+ `ar_release()` to release it.
+*/
API_AVAILABLE(visionos(2.0))
typedef void (^ar_reference_object_bundle_load_completion_handler_t)(const char *name,
CFBundleRef _Nullable bundle,
@@ -369,28 +502,46 @@
/**
Load a reference object from a bundle.
- @param name Name of reference object to load from bundle.
- @param bundle Bundle used for loading the reference object. The main bundle is used if NULL.
- @param completion_handler Handler triggered after the request to load an object completes.
- */
+ - Parameters:
+ - name: The name of reference object to load from bundle.
+ - bundle: The bundle used for loading the reference object. The main bundle is used if `NULL`.
+ - completion_handler: Handler triggered after the request to load an object completes.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_reference_object_load_with_name(const char *name,
CFBundleRef _Nullable bundle,
ar_reference_object_bundle_load_completion_handler_t completion_handler) AR_REFINED_FOR_SWIFT;
+/**
+ Load a reference object from a bundle.
+
+ - Parameters:
+ - name: The name of reference object to load from bundle.
+ - bundle: Bundle used for loading the reference object. The main bundle is used if NULL.
+ - configuration: Reference object configuration to use.
+ - completion_handler: Handler triggered after the request to load an object completes.
+*/
+API_AVAILABLE(visionos(27.0))
+AR_EXTERN void
+ar_reference_object_load_with_name_and_configuration(const char *name,
+ CFBundleRef _Nullable bundle,
+ ar_reference_object_configuration_t configuration,
+ ar_reference_object_bundle_load_completion_handler_t completion_handler) AR_REFINED_FOR_SWIFT;
+
#endif // __BLOCKS__
/**
Function called when a request to load a reference object from a bundle has completed.
- @param context The application-defined context.
- @param name Name of reference object that was being loaded from bundle.
- @param bundle Bundle used for loading the reference object.
- @param success `true` if loading succeeded, `false` otherwise.
- @param error The error that occurred, if any. The returned error supports ARC. In non-ARC files, use `ar_release()` to release the error.
- @param reference_object An instance of `ar_reference_object_t` (NULL if loading failed). The returned object supports ARC. In non-ARC files, use
- `ar_release()` to release it.
- */
+ - Parameters:
+ - context: The application-defined context.
+ - name: The name of reference object that was being loaded from bundle.
+ - bundle: The bundle used for loading the reference object.
+ - success: `true` if loading succeeded, `false` otherwise.
+ - error: The error that occurred, if any.
+ - reference_object: An instance of `ar_reference_object_t` (`NULL` if loading failed). The returned object supports ARC. In non-ARC files, use
+ `ar_release()` to release it.
+*/
API_AVAILABLE(visionos(2.0))
typedef void (*ar_reference_object_bundle_load_completion_handler_function_t)(void *_Nullable context,
const char *name,
@@ -402,11 +553,12 @@
/**
Load a reference object from a bundle.
- @param name Name of reference object to load from bundle.
- @param bundle Bundle used for loading the reference object. The main bundle is used if NULL.
- @param context The application-defined context parameter to pass to the function.
- @param completion_handler_function The function to be called after the request to load an object completes.
- */
+ - Parameters:
+ - name: The name of reference object to load from bundle.
+ - bundle: The bundle used for loading the reference object. The main bundle is used if `NULL`.
+ - context: The application-defined context parameter to pass to the function.
+ - completion_handler_function: The function to be called after the request to load an object completes.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void
ar_reference_object_load_with_name_f(const char *name,
@@ -414,46 +566,67 @@
void *_Nullable context,
ar_reference_object_bundle_load_completion_handler_function_t completion_handler_function) AR_REFINED_FOR_SWIFT;
+/**
+ Load a reference object from a bundle.
+
+ - Parameters:
+ - name: The name of reference object to load from bundle.
+ - bundle: Bundle used for loading the reference object. The main bundle is used if NULL.
+ - configuration: Reference object configuration to use.
+ - context: The application-defined context.
+ - completion_handler_function: Handler triggered after the request to load an object completes.
+*/
+API_AVAILABLE(visionos(27.0))
+AR_EXTERN void ar_reference_object_load_with_name_and_configuration_f(
+ const char *name,
+ CFBundleRef _Nullable bundle,
+ ar_reference_object_configuration_t configuration,
+ void *_Nullable context,
+ ar_reference_object_bundle_load_completion_handler_function_t completion_handler_function) AR_REFINED_FOR_SWIFT;
+
#pragma mark - Reference objects collection
/**
Create an empty collection of reference objects.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_reference_objects_t`.
- */
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_reference_objects_t`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_reference_objects_t ar_reference_objects_create(void) AR_REFINED_FOR_SWIFT;
/**
Add a reference object to a collection.
- @discussion The object must be unique. A duplicate of any existing object in the collection will not be added.
+ The object must be unique. A duplicate of any existing object in the collection will not be added.
- @param reference_objects The collection of reference objects to expand.
- @param object_to_add The reference object to add.
- */
+ - Parameters:
+ - reference_objects: The collection of reference objects to expand.
+ - object_to_add: The reference object to add.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_reference_objects_add_object(ar_reference_objects_t reference_objects, ar_reference_object_t object_to_add) AR_REFINED_FOR_SWIFT;
/**
Add reference objects to a collection.
- @discussion The objects must be unique. Duplicates of any existing object in the collection will not be added.
+ The objects must be unique. Duplicates of any existing object in the collection will not be added.
- @param reference_objects The collection of reference objects to expand.
- @param objects_to_add The collection of reference objects to add.
- */
+ - Parameters:
+ - reference_objects: The collection of reference objects to expand.
+ - objects_to_add: The collection of reference objects to add.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_reference_objects_add_objects(ar_reference_objects_t reference_objects, ar_reference_objects_t objects_to_add) AR_REFINED_FOR_SWIFT;
/**
Get the count of reference objects in the collection.
- @param reference_objects The collection of reference objects.
+ - Parameter reference_objects: The collection of reference objects.
- @return The number of reference objects in the collection.
- */
+ - Returns: The number of reference objects in the collection.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN size_t ar_reference_objects_get_count(ar_reference_objects_t reference_objects) AR_REFINED_FOR_SWIFT;
@@ -462,19 +635,20 @@
/**
Handler for enumerating a collection of reference objects.
- @param reference_object The reference object.
+ - Parameter reference_object: The reference object.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(2.0))
typedef bool (^ar_reference_objects_enumerator_t)(ar_reference_object_t reference_object) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of reference objects.
- @param reference_objects The collection of reference objects.
- @param reference_objects_enumerator The enumerator handler.
- */
+ - Parameters:
+ - reference_objects: The collection of reference objects.
+ - reference_objects_enumerator: The enumerator handler.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_reference_objects_enumerate_objects(ar_reference_objects_t reference_objects,
ar_reference_objects_enumerator_t reference_objects_enumerator) AR_REFINED_FOR_SWIFT;
@@ -484,21 +658,23 @@
/**
Function for enumerating a collection of reference objects.
- @param context The application-defined context.
- @param reference_object The reference object.
+ - Parameters:
+ - context: The application-defined context.
+ - reference_object: The reference object.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(2.0))
typedef bool (*ar_reference_objects_enumerator_function_t)(void *_Nullable context, ar_reference_object_t reference_object) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of reference objects.
- @param reference_objects The collection of reference objects.
- @param context The application-defined context parameter to pass to the function.
- @param reference_objects_enumerator_function The enumerator function.
- */
+ - Parameters:
+ - reference_objects: The collection of reference objects.
+ - context: The application-defined context parameter to pass to the function.
+ - reference_objects_enumerator_function: The enumerator function.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void
ar_reference_objects_enumerate_objects_f(ar_reference_objects_t reference_objects,
@@ -510,25 +686,26 @@
/**
Create an object tracking configuration.
- @note Default values are set for configuration parameters as follows:
+ - Note: Default values are set for configuration parameters as follows:
- `maximum_trackable_instances`: 10
- `maximum_instances_per_reference_object`: 1
- `detection_rate`: 2 Hz
- `stationary_object_tracking_rate`: 5 Hz
- `moving_object_tracking_rate`: 5 Hz
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_object_tracking_configuration_t`.
- */
+ - Returns: An instance of `ar_object_tracking_configuration_t`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_object_tracking_configuration_t ar_object_tracking_configuration_create(void) AR_REFINED_FOR_SWIFT;
/**
Add reference objects to the set of objects to be tracked. Object tracking will run without any reference objects, but will detect nothing.
- @param object_tracking_configuration The configuration for object tracking.
- @param reference_objects The reference objects to add.
- */
+ - Parameters:
+ - object_tracking_configuration: The configuration for object tracking.
+ - reference_objects: The reference objects to add.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_object_tracking_configuration_add_reference_objects(ar_object_tracking_configuration_t object_tracking_configuration,
ar_reference_objects_t reference_objects) AR_REFINED_FOR_SWIFT;
@@ -540,18 +717,21 @@
The app must include the following entitlement:
com.apple.developer.arkit.object-tracking-parameter-adjustment.allow
- @param object_tracking_configuration The object tracking configuration.
- @param maximum_trackable_instances The number to set.
- */
+ - Parameters:
+ - object_tracking_configuration: The object tracking configuration.
+ - maximum_trackable_instances: The number to set.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_object_tracking_configuration_set_maximum_trackable_instances(ar_object_tracking_configuration_t object_tracking_configuration,
int maximum_trackable_instances) AR_REFINED_FOR_SWIFT;
/**
Get the number to be configured for the maximum number of reference object instances to track.
- @param object_tracking_configuration The object tracking configuration.
- @return The configured number.
- */
+
+ - Parameter object_tracking_configuration: The object tracking configuration.
+
+ - Returns: The configured number.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN int ar_object_tracking_configuration_get_maximum_trackable_instances(ar_object_tracking_configuration_t object_tracking_configuration)
AR_REFINED_FOR_SWIFT;
@@ -563,9 +743,10 @@
The app must include the following entitlement:
com.apple.developer.arkit.object-tracking-parameter-adjustment.allow
- @param object_tracking_configuration The object tracking configuration.
- @param maximum_instances_per_reference_object The number to set.
- */
+ - Parameters:
+ - object_tracking_configuration: The object tracking configuration.
+ - maximum_instances_per_reference_object: The number to set.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void
ar_object_tracking_configuration_set_maximum_instances_per_reference_object(ar_object_tracking_configuration_t object_tracking_configuration,
@@ -573,9 +754,11 @@
/**
Get the number to be configured for the maximum number of instances of each reference object type to track.
- @param object_tracking_configuration The object tracking configuration.
- @return The configured number.
- */
+
+ - Parameter object_tracking_configuration: The object tracking configuration.
+
+ - Returns: The configured number.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN int ar_object_tracking_configuration_get_maximum_instances_per_reference_object(
ar_object_tracking_configuration_t object_tracking_configuration) AR_REFINED_FOR_SWIFT;
@@ -587,18 +770,21 @@
The app must include the following entitlement:
com.apple.developer.arkit.object-tracking-parameter-adjustment.allow.
- @param object_tracking_configuration The object tracking configuration.
- @param detection_rate The frequency to set, in Hz. Clamped between 0 and 30 Hz.
- */
+ - Parameters:
+ - object_tracking_configuration: The object tracking configuration.
+ - detection_rate: The frequency to set, in Hz. Clamped between 0 and 30 Hz.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_object_tracking_configuration_set_detection_rate(ar_object_tracking_configuration_t object_tracking_configuration,
float detection_rate) AR_REFINED_FOR_SWIFT;
/**
Get the frequency to be configured for running object detection.
- @param object_tracking_configuration The object tracking configuration.
- @return The frequency, in Hz.
- */
+
+ - Parameter object_tracking_configuration: The object tracking configuration.
+
+ - Returns: The frequency, in Hz.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN float
ar_object_tracking_configuration_get_detection_rate(ar_object_tracking_configuration_t object_tracking_configuration) AR_REFINED_FOR_SWIFT;
@@ -610,19 +796,22 @@
The app must include the following entitlement:
com.apple.developer.arkit.object-tracking-parameter-adjustment.allow
- @param object_tracking_configuration The object tracking configuration.
- @param stationary_object_tracking_rate The frequency to set, in Hz. Clamped between 0 and 30 Hz.
- */
-API_AVAILABLE(visionos(2.0))
+ - Parameters:
+ - object_tracking_configuration: The object tracking configuration.
+ - stationary_object_tracking_rate: The frequency to set, in Hz. Clamped between 0 and 30 Hz.
+*/
+API_DEPRECATED("Use ar_reference_object_configuration_enable_high_frame_rate_tracking.", visionos(2.0, 27.0))
AR_EXTERN void ar_object_tracking_configuration_set_stationary_object_tracking_rate(ar_object_tracking_configuration_t object_tracking_configuration,
float stationary_object_tracking_rate) AR_REFINED_FOR_SWIFT;
/**
Get the frequency to be configured for object tracking to run for a stationary object.
- @param object_tracking_configuration The object tracking configuration.
- @return The frequency, in Hz.
- */
-API_AVAILABLE(visionos(2.0))
+
+ - Parameter object_tracking_configuration: The object tracking configuration.
+
+ - Returns: The frequency, in Hz.
+*/
+API_DEPRECATED("Use ar_reference_object_configuration_is_high_frame_rate_tracking_enabled.", visionos(2.0, 27.0))
AR_EXTERN float ar_object_tracking_configuration_get_stationary_object_tracking_rate(ar_object_tracking_configuration_t object_tracking_configuration)
AR_REFINED_FOR_SWIFT;
@@ -633,24 +822,30 @@
The app must include the following entitlement:
com.apple.developer.arkit.object-tracking-parameter-adjustment.allow.
- @param object_tracking_configuration The object tracking configuration.
- @param moving_object_tracking_rate The frequency to set, in Hz. Clamped between 0 and 30 Hz.
- */
-API_AVAILABLE(visionos(2.0))
+ - Parameters:
+ - object_tracking_configuration: The object tracking configuration.
+ - moving_object_tracking_rate: The frequency to set, in Hz. Clamped between 0 and 30 Hz.
+*/
+API_DEPRECATED("Use ar_reference_object_configuration_enable_high_frame_rate_tracking.", visionos(2.0, 27.0))
AR_EXTERN void ar_object_tracking_configuration_set_moving_object_tracking_rate(ar_object_tracking_configuration_t object_tracking_configuration,
float moving_object_tracking_rate) AR_REFINED_FOR_SWIFT;
/**
Get the frequency to be configured for object tracking to run for a moving object.
- @param object_tracking_configuration The object tracking configuration.
- @return The frequency, in Hz.
- */
-API_AVAILABLE(visionos(2.0))
+
+ - Parameter object_tracking_configuration: The object tracking configuration.
+
+ - Returns: The frequency, in Hz.
+*/
+API_DEPRECATED("Use ar_reference_object_configuration_is_high_frame_rate_tracking_enabled.", visionos(2.0, 27.0))
AR_EXTERN float ar_object_tracking_configuration_get_moving_object_tracking_rate(ar_object_tracking_configuration_t object_tracking_configuration)
AR_REFINED_FOR_SWIFT;
#pragma mark - Object tracking provider
+/**
+ Error codes specific to object tracking.
+ */
API_AVAILABLE(visionos(2.0))
OS_ENUM(ar_object_tracking_error_code, ar_error_code_t,
/// Error code indicating that a reference object failed to load.
@@ -661,11 +856,12 @@
/**
Create an object tracking provider.
- @param object_tracking_configuration The configuration for object tracking.
+ - Parameter object_tracking_configuration: The configuration for object tracking.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_object_tracking_provider_t`.
- */
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_object_tracking_provider_t`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_object_tracking_provider_t
ar_object_tracking_provider_create(ar_object_tracking_configuration_t object_tracking_configuration) AR_REFINED_FOR_SWIFT;
@@ -675,10 +871,11 @@
/**
Handler called when there are updates to object anchors.
- @param added_anchors The collection of anchors that were added.
- @param updated_anchors The collection of anchors that were updated.
- @param removed_anchors The collection of anchors that were removed.
- */
+ - Parameters:
+ - added_anchors: The collection of anchors that were added.
+ - updated_anchors: The collection of anchors that were updated.
+ - removed_anchors: The collection of anchors that were removed.
+*/
API_AVAILABLE(visionos(2.0))
typedef void (^ar_object_tracking_update_handler_t)(ar_object_anchors_t added_anchors,
ar_object_anchors_t updated_anchors,
@@ -687,12 +884,13 @@
/**
Set the handler for receiving object tracking updates.
- @param object_tracking_provider The object tracking provider.
- @param object_tracking_updates_queue The queue on which the handler will be called. Passing NULL will default to the main queue.
- @param object_tracking_update_handler The handler to be called when new object tracking data arrives.
+ - Parameters:
+ - object_tracking_provider: The object tracking provider.
+ - object_tracking_updates_queue: The queue on which the handler will be called. Passing `NULL` will default to the main queue.
+ - object_tracking_update_handler: The handler to be called when new object tracking data arrives.
- @note Setting this handler will override the function set using `ar_object_tracking_provider_set_update_handler_f`.
- */
+ - Note: Setting this handler will override the function set using `ar_object_tracking_provider_set_update_handler_f`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void
ar_object_tracking_provider_set_update_handler(ar_object_tracking_provider_t object_tracking_provider,
@@ -704,11 +902,12 @@
/**
Function called when there are updates to object anchors.
- @param context The application-defined context.
- @param added_anchors The collection of anchors that were added.
- @param updated_anchors The collection of anchors that were updated.
- @param removed_anchors The collection of anchors that were removed.
- */
+ - Parameters:
+ - context: The application-defined context.
+ - added_anchors: The collection of anchors that were added.
+ - updated_anchors: The collection of anchors that were updated.
+ - removed_anchors: The collection of anchors that were removed.
+*/
API_AVAILABLE(visionos(2.0))
typedef void (*ar_object_tracking_update_handler_function_t)(void *_Nullable context,
ar_object_anchors_t added_anchors,
@@ -718,13 +917,14 @@
/**
Set the handler for receiving object tracking updates.
- @param object_tracking_provider The object tracking provider.
- @param object_tracking_updates_queue The queue on which the handler will be called. Passing NULL will default to the main queue.
- @param context The application-defined context parameter to pass to the function.
- @param object_tracking_update_handler_function The function to be called when new object tracking data arrives.
+ - Parameters:
+ - object_tracking_provider: The object tracking provider.
+ - object_tracking_updates_queue: The queue on which the handler will be called. Passing `NULL` will default to the main queue.
+ - context: The application-defined context parameter to pass to the function.
+ - object_tracking_update_handler_function: The function to be called when new object tracking data arrives.
- @note Setting this handler will override the function set using `ar_object_tracking_provider_set_update_handler`.
- */
+ - Note: Setting this handler will override the function set using `ar_object_tracking_provider_set_update_handler`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_object_tracking_provider_set_update_handler_f(
ar_object_tracking_provider_t object_tracking_provider,
@@ -735,11 +935,11 @@
/**
Copy all object anchors.
- @param object_tracking_provider The object tracking provider.
+ - Parameter object_tracking_provider: The object tracking provider.
- @return The collection of all object anchors. This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release
+ - Returns: The collection of all object anchors. This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release
the object.
- */
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_object_anchors_t
ar_object_tracking_provider_copy_all_object_anchors(ar_object_tracking_provider_t object_tracking_provider) AR_REFINED_FOR_SWIFT;
@@ -747,19 +947,20 @@
/**
Determine whether this device supports the object tracking provider.
- @return `true` if the object tracking provider is supported on this device, `false` otherwise.
- */
+ - Returns: `true` if the object tracking provider is supported on this device, `false` otherwise.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool ar_object_tracking_provider_is_supported(void) AR_REFINED_FOR_SWIFT;
/**
Get the authorization type required by the object tracking provider.
- @return The required authorization type.
- */
+ - Returns: The required authorization type.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN ar_authorization_type_t ar_object_tracking_provider_get_required_authorization_type(void) AR_REFINED_FOR_SWIFT;
+API_UNAVAILABLE_END; // macCatalyst
API_UNAVAILABLE_END; // macos
AR_ASSUME_NONNULL_END
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/plane_detection.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/plane_detection.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/plane_detection.h 2026-04-19 01:08:32
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/plane_detection.h 2026-05-22 07:32:11
@@ -14,6 +14,7 @@
#import <ARKit/object.h>
#import <ARKit/scene_reconstruction.h>
#import <ARKit/session.h>
+#import <ARKit/transform_correction.h>
#import <dispatch/dispatch.h>
#import <os/availability.h>
@@ -22,36 +23,57 @@
AR_ASSUME_NONNULL_BEGIN
API_UNAVAILABLE_BEGIN(macos);
+API_UNAVAILABLE_BEGIN(macCatalyst);
+/**
+ An anchor that tracks a detected plane's position and geometry.
+ */
AR_OBJECT_DECL_SUBCLASS(ar_plane_anchor, ar_anchor)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(1.0));
+/**
+ A collection of plane anchors.
+ */
AR_OBJECT_DECL(ar_plane_anchors)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(1.0));
+/**
+ Describes the geometry of a detected plane including vertices and extent.
+ */
AR_OBJECT_DECL(ar_plane_geometry)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(1.0));
+/**
+ Describes the bounding rectangle of a detected plane.
+ */
AR_OBJECT_DECL(ar_plane_extent)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(1.0));
+/**
+ Configuration for plane detection.
+ */
AR_OBJECT_DECL(ar_plane_detection_configuration)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(1.0));
+/**
+ A data provider for plane detection.
+ */
AR_OBJECT_DECL_SUBCLASS(ar_plane_detection_provider, ar_data_provider)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(1.0));
/**
Option set describing possible orientation alignments of a detected plane.
+
- @note An `ar_plane_anchor_t` has exactly one alignment. Multiple bits may be set to receive various planes from an `ar_plane_detection_provider_t`.
- */
+
+ - Note: An `ar_plane_anchor_t` has exactly one alignment. Multiple bits may be set to receive various planes from an `ar_plane_detection_provider_t`.
+*/
API_AVAILABLE(visionos(1.0))
OS_OPTIONS(ar_plane_alignment, intptr_t,
@@ -112,10 +134,11 @@
/**
Handler called when there are updates to plane anchors.
- @param added_anchors The collection of anchors that were added.
- @param updated_anchors The collection of anchors that were updated.
- @param removed_anchors The collection of anchors that were removed.
- */
+ - Parameters:
+ - added_anchors: The collection of anchors that were added.
+ - updated_anchors: The collection of anchors that were updated.
+ - removed_anchors: The collection of anchors that were removed.
+*/
API_AVAILABLE(visionos(1.0))
typedef void (^ar_plane_detection_update_handler_t)(ar_plane_anchors_t added_anchors,
ar_plane_anchors_t updated_anchors,
@@ -125,11 +148,12 @@
/**
Function called when there are updates to plane anchors.
- @param context The application-defined context.
- @param added_anchors The collection of anchors that were added.
- @param updated_anchors The collection of anchors that were updated.
- @param removed_anchors The collection of anchors that were removed.
- */
+ - Parameters:
+ - context: The application-defined context.
+ - added_anchors: The collection of anchors that were added.
+ - updated_anchors: The collection of anchors that were updated.
+ - removed_anchors: The collection of anchors that were removed.
+*/
API_AVAILABLE(visionos(1.0))
typedef void (*ar_plane_detection_update_handler_function_t)(void *_Nullable context,
ar_plane_anchors_t added_anchors,
@@ -141,19 +165,21 @@
/**
Create a plane detection configuration.
- @note The alignment is set to `ar_plane_alignment_horizontal | ar_plane_alignment_vertical` by default.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_plane_detection_configuration_t`.
- */
+ - Note: The alignment is set to `ar_plane_alignment_horizontal | ar_plane_alignment_vertical` by default.
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_plane_detection_configuration_t`.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_plane_detection_configuration_t ar_plane_detection_configuration_create(void) AR_REFINED_FOR_SWIFT;
/**
Set the desired alignment of planes to detect.
- @param plane_detection_configuration The configuration for plane detection.
- @param alignment The plane alignments to detect.
- */
+ - Parameters:
+ - plane_detection_configuration: The configuration for plane detection.
+ - alignment: The plane alignments to detect.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN void ar_plane_detection_configuration_set_alignment(ar_plane_detection_configuration_t plane_detection_configuration,
ar_plane_alignment_t alignment) AR_REFINED_FOR_SWIFT;
@@ -163,11 +189,12 @@
/**
Returns a bool value that indicates whether the two plane anchors are equal.
- @param anchor A plane anchor to be compared.
- @param other_anchor The other plane anchor to be compared to.
+ - Parameters:
+ - anchor: A plane anchor to be compared.
+ - other_anchor: The other plane anchor to be compared to.
- @return YES if the plane anchors are equal, otherwise NO.
- */
+ - Returns: `YES` if the plane anchors are equal, otherwise `NO`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool ar_plane_anchor_is_equal_to_plane_anchor(ar_plane_anchor_t _Nullable anchor,
ar_plane_anchor_t _Nullable other_anchor) AR_REFINED_FOR_SWIFT;
@@ -175,40 +202,40 @@
/**
Get the alignment of a plane anchor.
- @param plane_anchor The plane anchor.
+ - Parameter plane_anchor: The plane anchor.
- @return The anchor's plane alignment.
- */
+ - Returns: The anchor's plane alignment.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN ar_plane_alignment_t ar_plane_anchor_get_alignment(ar_plane_anchor_t plane_anchor) AR_REFINED_FOR_SWIFT;
/**
Get the geometry of a plane anchor.
- @param plane_anchor The plane anchor.
+ - Parameter plane_anchor: The plane anchor.
- @return An instance of `ar_plane_geometry_t`.
- */
+ - Returns: An instance of `ar_plane_geometry_t`.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN ar_plane_geometry_t ar_plane_anchor_get_geometry(ar_plane_anchor_t plane_anchor) AR_REFINED_FOR_SWIFT;
/**
Get the classification of a plane anchor.
- @param plane_anchor The plane anchor.
+ - Parameter plane_anchor: The plane anchor.
- @return The plane anchor's classification.
- */
+ - Returns: The plane anchor's classification.
+*/
AR_EXTERN ar_plane_classification_t ar_plane_anchor_get_plane_classification(ar_plane_anchor_t plane_anchor)
API_DEPRECATED_WITH_REPLACEMENT("ar_plane_anchor_get_surface_classification", visionos(1.0, 26.0)) AR_REFINED_FOR_SWIFT;
/**
Get the surface classification of a plane anchor.
- @param plane_anchor The plane anchor.
+ - Parameter plane_anchor: The plane anchor.
- @return The plane anchor's surface classification.
- */
+ - Returns: The plane anchor's surface classification.
+*/
API_AVAILABLE(visionos(26.0))
AR_EXTERN ar_surface_classification_t ar_plane_anchor_get_surface_classification(ar_plane_anchor_t plane_anchor) AR_REFINED_FOR_SWIFT;
@@ -217,29 +244,43 @@
/**
Get the identifier of an anchor.
- @param[in] anchor The anchor.
- @param[out] out_identifier A pointer to a UUID to fill out with the anchor identifier. Must be non-null.
- */
+ - Parameters:
+ - anchor: The anchor.
+ - out_identifier: A pointer to a UUID to fill out with the anchor identifier. Must be non-null.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_plane_anchor_get_identifier(ar_plane_anchor_t anchor, uuid_t _Nonnull out_identifier) AR_REFINED_FOR_SWIFT;
/**
Get the transform from an anchor to the origin coordinate system.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return The origin from anchor transform.
- */
+ - Returns: The origin from anchor transform.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN simd_float4x4 ar_plane_anchor_get_origin_from_anchor_transform(ar_plane_anchor_t anchor) AR_REFINED_FOR_SWIFT;
/**
+ Get the transform from an anchor to the origin coordinate system.
+
+ - Parameters:
+ - anchor: The anchor.
+ - transform_correction: The transform correction that should be applied.
+
+ - Returns: The origin from anchor transform.
+*/
+API_AVAILABLE(visionos(27.0))
+AR_EXTERN simd_float4x4 ar_plane_anchor_get_origin_from_anchor_transform_with_correction(
+ ar_plane_anchor_t anchor, ar_transform_correction_t transform_correction) AR_REFINED_FOR_SWIFT;
+
+/**
Get the timestamp corresponding to an anchor.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return The timestamp associated with the anchor.
- */
+ - Returns: The timestamp associated with the anchor.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN CFTimeInterval ar_plane_anchor_get_timestamp(ar_plane_anchor_t anchor) AR_REFINED_FOR_SWIFT;
@@ -248,11 +289,12 @@
/**
Returns a bool value that indicates whether the two plane geometries are equal.
- @param plane_geometry A plane geometry to be compared.
- @param other_plane_geometry The other plane geometry to be compared to.
+ - Parameters:
+ - plane_geometry: A plane geometry to be compared.
+ - other_plane_geometry: The other plane geometry to be compared to.
- @return YES if the plane geometries are equal, otherwise NO.
- */
+ - Returns: `YES` if the plane geometries are equal, otherwise `NO`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool ar_plane_geometry_is_equal_to_plane_geometry(ar_plane_geometry_t _Nullable plane_geometry,
ar_plane_geometry_t _Nullable other_plane_geometry) AR_REFINED_FOR_SWIFT;
@@ -260,30 +302,30 @@
/**
Get the mesh vertices of a plane geometry.
- @param plane_geometry The plane geometry.
+ - Parameter plane_geometry: The plane geometry.
- @return An instance of `ar_geometry_source_t`.
- */
+ - Returns: An instance of `ar_geometry_source_t`.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN ar_geometry_source_t ar_plane_geometry_get_mesh_vertices(ar_plane_geometry_t plane_geometry) AR_REFINED_FOR_SWIFT;
/**
Get the mesh faces of a plane geometry.
- @param plane_geometry The plane geometry.
+ - Parameter plane_geometry: The plane geometry.
- @return An instance of `ar_geometry_element_t`.
- */
+ - Returns: An instance of `ar_geometry_element_t`.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN ar_geometry_element_t ar_plane_geometry_get_mesh_faces(ar_plane_geometry_t plane_geometry) AR_REFINED_FOR_SWIFT;
/**
Get the extent of a plane geometry.
- @param plane_geometry The plane geometry.
+ - Parameter plane_geometry: The plane geometry.
- @return An instance of `ar_plane_extent_t`.
- */
+ - Returns: An instance of `ar_plane_extent_t`.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN ar_plane_extent_t ar_plane_geometry_get_plane_extent(ar_plane_geometry_t plane_geometry) AR_REFINED_FOR_SWIFT;
@@ -292,11 +334,12 @@
/**
Returns a bool value that indicates whether the two plane extents are equal.
- @param plane_extent A plane extent to be compared.
- @param other_plane_extent The other plane extent to be compared to.
+ - Parameters:
+ - plane_extent: A plane extent to be compared.
+ - other_plane_extent: The other plane extent to be compared to.
- @return YES if the plane extents are equal, otherwise NO.
- */
+ - Returns: `YES` if the plane extents are equal, otherwise `NO`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool ar_plane_extent_is_equal_to_plane_extent(ar_plane_extent_t _Nullable plane_extent,
ar_plane_extent_t _Nullable other_plane_extent) AR_REFINED_FOR_SWIFT;
@@ -304,30 +347,30 @@
/**
Get the width of a plane extent.
- @param plane_extent The plane extent.
+ - Parameter plane_extent: The plane extent.
- @return The width of the plane extent.
- */
+ - Returns: The width of the plane extent.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN float ar_plane_extent_get_width(ar_plane_extent_t plane_extent) AR_REFINED_FOR_SWIFT;
/**
Get the height of the plane extent.
- @param plane_extent The plane extent.
+ - Parameter plane_extent: The plane extent.
- @return The height of the plane extent.
- */
+ - Returns: The height of the plane extent.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN float ar_plane_extent_get_height(ar_plane_extent_t plane_extent) AR_REFINED_FOR_SWIFT;
/**
Get the transform from a plane extent to the plane anchor’s coordinate system.
- @param plane_extent The plane extent.
+ - Parameter plane_extent: The plane extent.
- @return The transform from the plane extent to the plane anchor's coordinate system.
- */
+ - Returns: The transform from the plane extent to the plane anchor's coordinate system.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN simd_float4x4 ar_plane_extent_get_plane_anchor_from_plane_extent_transform(ar_plane_extent_t plane_extent) AR_REFINED_FOR_SWIFT;
@@ -336,10 +379,10 @@
/**
Get the count of plane anchors in a collection.
- @param plane_anchors The collection of plane anchors.
+ - Parameter plane_anchors: The collection of plane anchors.
- @return The number of plane anchors in the collection.
- */
+ - Returns: The number of plane anchors in the collection.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN size_t ar_plane_anchors_get_count(ar_plane_anchors_t plane_anchors) AR_REFINED_FOR_SWIFT;
@@ -347,19 +390,20 @@
/**
Handler for enumerating a collection of plane anchors.
- @param plane_anchor The plane anchor.
+ - Parameter plane_anchor: The plane anchor.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(1.0))
typedef bool (^ar_plane_anchors_enumerator_t)(ar_plane_anchor_t plane_anchor) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of plane anchors.
- @param plane_anchors The collection of plane anchors.
- @param plane_anchors_enumerator The enumerator handler.
- */
+ - Parameters:
+ - plane_anchors: The collection of plane anchors.
+ - plane_anchors_enumerator: The enumerator handler.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN void ar_plane_anchors_enumerate_anchors(ar_plane_anchors_t plane_anchors,
ar_plane_anchors_enumerator_t plane_anchors_enumerator) AR_REFINED_FOR_SWIFT;
@@ -368,21 +412,23 @@
/**
Function for enumerating a collection of plane anchors.
- @param context The application-defined context.
- @param plane_anchor The plane anchor.
+ - Parameters:
+ - context: The application-defined context.
+ - plane_anchor: The plane anchor.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(1.0))
typedef bool (*ar_plane_anchors_enumerator_function_t)(void *_Nullable context, ar_plane_anchor_t plane_anchor) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of plane anchors using a function.
- @param plane_anchors The collection of plane anchors.
- @param context The application-defined context parameter to pass to the function.
- @param plane_anchors_enumerator_function The enumerator function.
- */
+ - Parameters:
+ - plane_anchors: The collection of plane anchors.
+ - context: The application-defined context parameter to pass to the function.
+ - plane_anchors_enumerator_function: The enumerator function.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN void ar_plane_anchors_enumerate_anchors_f(ar_plane_anchors_t plane_anchors,
void *_Nullable context,
@@ -393,11 +439,12 @@
/**
Create a plane detection provider.
- @param plane_detection_configuration The configuration for plane detection.
+ - Parameter plane_detection_configuration: The configuration for plane detection.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_plane_detection_provider_t`.
- */
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_plane_detection_provider_t`.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_plane_detection_provider_t
ar_plane_detection_provider_create(ar_plane_detection_configuration_t plane_detection_configuration) AR_REFINED_FOR_SWIFT;
@@ -406,12 +453,13 @@
/**
Set the handler for receiving plane detection updates.
- @param plane_detection_provider The plane detection provider.
- @param plane_detection_updates_queue The plane detection update queue. Passing NULL will default to the main queue.
- @param plane_detection_update_handler The plane detection update handler.
+ - Parameters:
+ - plane_detection_provider: The plane detection provider.
+ - plane_detection_updates_queue: The plane detection update queue. Passing `NULL` will default to the main queue.
+ - plane_detection_update_handler: The plane detection update handler.
- @note Setting this handler will override the function set using `ar_plane_detection_provider_set_update_handler_f`.
- */
+ - Note: Setting this handler will override the function set using `ar_plane_detection_provider_set_update_handler_f`.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN void
ar_plane_detection_provider_set_update_handler(ar_plane_detection_provider_t plane_detection_provider,
@@ -422,13 +470,14 @@
/**
Set the function for receiving plane detection updates.
- @param plane_detection_provider The plane detection provider.
- @param plane_detection_updates_queue The plane detection update queue. Passing NULL will default to the main queue.
- @param context The application-defined context parameter to pass to the function.
- @param plane_detection_update_handler_function The plane detection update handler function.
+ - Parameters:
+ - plane_detection_provider: The plane detection provider.
+ - plane_detection_updates_queue: The plane detection update queue. Passing `NULL` will default to the main queue.
+ - context: The application-defined context parameter to pass to the function.
+ - plane_detection_update_handler_function: The plane detection update handler function.
- @note Setting this function will override the handler set using `ar_plane_detection_provider_set_update_handler`.
- */
+ - Note: Setting this function will override the handler set using `ar_plane_detection_provider_set_update_handler`.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN void ar_plane_detection_provider_set_update_handler_f(
ar_plane_detection_provider_t plane_detection_provider,
@@ -439,11 +488,11 @@
/**
Copy all plane anchors.
- @param plane_detection_provider The plane detection provider.
+ - Parameter plane_detection_provider: The plane detection provider.
- @return The collection of all plane anchors. This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the
- object.
- */
+ - Returns: The collection of all plane anchors. This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release
+ the object.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_plane_anchors_t
ar_plane_detection_provider_copy_all_plane_anchors(ar_plane_detection_provider_t plane_detection_provider) AR_REFINED_FOR_SWIFT;
@@ -451,19 +500,20 @@
/**
Determine whether this device supports the plane detection provider.
- @return `true` if the plane detection provider is supported on this device, `false` otherwise.
- */
+ - Returns: `true` if the plane detection provider is supported on this device, `false` otherwise.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN bool ar_plane_detection_provider_is_supported(void) AR_REFINED_FOR_SWIFT;
/**
Get the authorization type required by the plane detection provider.
- @return The required authorization type.
- */
+ - Returns: The required authorization type.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN ar_authorization_type_t ar_plane_detection_provider_get_required_authorization_type(void) AR_REFINED_FOR_SWIFT;
+API_UNAVAILABLE_END; // macCatalyst
API_UNAVAILABLE_END; // macos
AR_ASSUME_NONNULL_END
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/room_tracking.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/room_tracking.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/room_tracking.h 2026-04-18 22:53:34
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/room_tracking.h 2026-05-22 07:32:10
@@ -14,6 +14,7 @@
#import <ARKit/identifiers.h>
#import <ARKit/object.h>
#import <ARKit/scene_reconstruction.h>
+#import <ARKit/transform_correction.h>
#import <dispatch/dispatch.h>
#import <os/availability.h>
@@ -22,19 +23,32 @@
AR_ASSUME_NONNULL_BEGIN
API_UNAVAILABLE_BEGIN(macos);
+API_UNAVAILABLE_BEGIN(macCatalyst);
+/**
+ An anchor representing a physical room.
+ */
AR_OBJECT_DECL_SUBCLASS(ar_room_anchor, ar_anchor)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(2.0));
+/**
+ A collection of room anchors.
+ */
AR_OBJECT_DECL(ar_room_anchors)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(2.0));
+/**
+ Configuration for room tracking.
+ */
AR_OBJECT_DECL(ar_room_tracking_configuration)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(2.0));
+/**
+ A data provider for room tracking.
+ */
AR_OBJECT_DECL_SUBCLASS(ar_room_tracking_provider, ar_data_provider)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(2.0));
@@ -44,11 +58,12 @@
/**
Returns a bool value that indicates whether the two room anchors are equal.
- @param room_anchor A room anchor to be compared.
- @param other_room_anchor The other room anchor to be compared to.
+ - Parameters:
+ - room_anchor: A room anchor to be compared.
+ - other_room_anchor: The other room anchor to be compared to.
- @return YES if the room anchors are equal, otherwise NO.
- */
+ - Returns: `YES` if the room anchors are equal, otherwise `NO`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool ar_room_anchor_is_equal_to_room_anchor(ar_room_anchor_t _Nullable room_anchor,
ar_room_anchor_t _Nullable other_room_anchor) AR_REFINED_FOR_SWIFT;
@@ -56,33 +71,34 @@
/**
Determine if the room anchor represents the current room the person is in.
- @param room_anchor The room anchor.
+ - Parameter room_anchor: The room anchor.
- @return `true` if the person is in the given room, `false` otherwise.
- */
+ - Returns: `true` if the person is in the given room, `false` otherwise.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool ar_room_anchor_is_current_room(ar_room_anchor_t room_anchor) AR_REFINED_FOR_SWIFT;
/**
Get a mesh representation of the room.
- @param room_anchor The room anchor.
+ - Parameter room_anchor: The room anchor.
- @return A mesh geometry that represents the geometry of the room.
- */
+ - Returns: A mesh geometry that represents the geometry of the room.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN ar_mesh_geometry_t ar_room_anchor_get_geometry(ar_room_anchor_t room_anchor) AR_REFINED_FOR_SWIFT;
/**
Get disjoint mesh geometries of a given classification.
- @param room_anchor The room anchor.
- @param classification Classification of the mesh geometry.
+ - Parameters:
+ - room_anchor: The room anchor.
+ - classification: Classification of the mesh geometry.
- @note Only `ar_mesh_classification_wall` and `ar_mesh_classification_floor` is supported.
+ - Note: Only `ar_mesh_classification_wall` and `ar_mesh_classification_floor` is supported.
- @return A collection of mesh geometries where each geometry represents a disjoint mesh of type `classification`.
- */
+ - Returns: A collection of mesh geometries where each geometry represents a disjoint mesh of type `classification`.
+*/
AR_EXTERN ar_mesh_geometries_t ar_room_anchor_get_mesh_geometries_for_classification(ar_room_anchor_t room_anchor,
ar_mesh_classification_t classification)
API_DEPRECATED_WITH_REPLACEMENT("ar_room_anchor_get_mesh_geometries_for_surface_classification", visionos(2.0, 26.0)) AR_REFINED_FOR_SWIFT;
@@ -90,13 +106,14 @@
/**
Get disjoint mesh geometries of a given surface classification.
- @param room_anchor The room anchor.
- @param classification Classification of the surface.
+ - Parameters:
+ - room_anchor: The room anchor.
+ - classification: Classification of the surface.
- @note Only `ar_surface_classification_wall` and `ar_surface_classification_floor` are supported.
+ - Note: Only `ar_surface_classification_wall` and `ar_surface_classification_floor` are supported.
- @return A collection of mesh geometries where each geometry represents a disjoint mesh of type `classification`.
- */
+ - Returns: A collection of mesh geometries where each geometry represents a disjoint mesh of type `classification`.
+*/
API_AVAILABLE(visionos(26.0))
AR_EXTERN ar_mesh_geometries_t ar_room_anchor_get_mesh_geometries_for_surface_classification(
ar_room_anchor_t room_anchor, ar_surface_classification_t classification) AR_REFINED_FOR_SWIFT;
@@ -104,11 +121,12 @@
/**
Determine if the room contains the given point.
- @param room_anchor The room anchor.
- @param point The point to query in the application's coordinate space.
+ - Parameters:
+ - room_anchor: The room anchor.
+ - point: The point to query in the application's coordinate space.
- @return Returns `true` if `room_anchor` contains `point`.
- */
+ - Returns: Returns `true` if `room_anchor` contains `point`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool ar_room_anchor_contains_point(ar_room_anchor_t room_anchor, simd_float3 point) AR_REFINED_FOR_SWIFT;
@@ -117,29 +135,43 @@
/**
Get the identifier of a room anchor.
- @param[in] room_anchor The room anchor.
- @param[out] out_identifier A pointer to a UUID to fill out with the anchor identifier. Must be non-null.
- */
+ - Parameters:
+ - room_anchor: The room anchor.
+ - out_identifier: A pointer to a UUID to fill out with the anchor identifier. Must be non-null.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_room_anchor_get_identifier(ar_room_anchor_t room_anchor, uuid_t _Nonnull out_identifier) AR_REFINED_FOR_SWIFT;
/**
Get the transform from a room anchor to the origin coordinate system.
- @param room_anchor The room anchor.
+ - Parameter room_anchor: The room anchor.
- @return The origin from room anchor transform.
- */
+ - Returns: The origin from room anchor transform.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN simd_float4x4 ar_room_anchor_get_origin_from_anchor_transform(ar_room_anchor_t room_anchor) AR_REFINED_FOR_SWIFT;
/**
+ Get the transform from a room anchor to the origin coordinate system.
+
+ - Parameters:
+ - room_anchor: The room anchor.
+ - transform_correction: The transform correction that should be applied.
+
+ - Returns: The origin from room anchor transform.
+*/
+API_AVAILABLE(visionos(27.0))
+AR_EXTERN simd_float4x4 ar_room_anchor_get_origin_from_anchor_transform_with_correction(
+ ar_room_anchor_t room_anchor, ar_transform_correction_t transform_correction) AR_REFINED_FOR_SWIFT;
+
+/**
Get the timestamp corresponding to when the room anchor was updated.
- @param room_anchor The room anchor.
+ - Parameter room_anchor: The room anchor.
- @return The timestamp associated with the room anchor.
- */
+ - Returns: The timestamp associated with the room anchor.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN CFTimeInterval ar_room_anchor_get_timestamp(ar_room_anchor_t room_anchor) AR_REFINED_FOR_SWIFT;
@@ -148,10 +180,10 @@
/**
Get the count of room anchors in a collection.
- @param room_anchors The collection of room anchors.
+ - Parameter room_anchors: The collection of room anchors.
- @return The number of room anchors in the collection.
- */
+ - Returns: The number of room anchors in the collection.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN size_t ar_room_anchors_get_count(ar_room_anchors_t room_anchors) AR_REFINED_FOR_SWIFT;
@@ -159,19 +191,20 @@
/**
Handler for enumerating a collection of room anchors.
- @param room_anchor The room anchor.
+ - Parameter room_anchor: The room anchor.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(2.0))
typedef bool (^ar_room_anchors_enumerator_t)(ar_room_anchor_t room_anchor) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of room anchors.
- @param room_anchors The collection of room anchors.
- @param room_anchors_enumerator The enumerator handler.
- */
+ - Parameters:
+ - room_anchors: The collection of room anchors.
+ - room_anchors_enumerator: The enumerator handler.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_room_anchors_enumerate_anchors(ar_room_anchors_t room_anchors,
ar_room_anchors_enumerator_t room_anchors_enumerator) AR_REFINED_FOR_SWIFT;
@@ -180,21 +213,23 @@
/**
Function for enumerating a collection of room anchors.
- @param context The application-defined context.
- @param room_anchor The room anchor.
+ - Parameters:
+ - context: The application-defined context.
+ - room_anchor: The room anchor.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(2.0))
typedef bool (*ar_room_anchors_enumerator_function_t)(void *_Nullable context, ar_room_anchor_t room_anchor) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of room anchors using a function.
- @param room_anchors The collection of room anchors.
- @param context The application-defined context parameter to pass to the function.
- @param room_anchors_enumerator_function The enumerator function.
- */
+ - Parameters:
+ - room_anchors: The collection of room anchors.
+ - context: The application-defined context parameter to pass to the function.
+ - room_anchors_enumerator_function: The enumerator function.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_room_anchors_enumerate_anchors_f(ar_room_anchors_t room_anchors,
void *_Nullable context,
@@ -206,10 +241,11 @@
/**
Handler called when there are updates to room anchors.
- @param added_anchors The collection of anchors that were added.
- @param updated_anchors The collection of anchors that were updated.
- @param removed_anchors The collection of anchors that were removed.
- */
+ - Parameters:
+ - added_anchors: The collection of anchors that were added.
+ - updated_anchors: The collection of anchors that were updated.
+ - removed_anchors: The collection of anchors that were removed.
+*/
API_AVAILABLE(visionos(2.0))
typedef void (^ar_room_tracking_update_handler_t)(ar_room_anchors_t added_anchors,
ar_room_anchors_t updated_anchors,
@@ -219,11 +255,12 @@
/**
Function called when there are updates to room anchors.
- @param context The application-defined context.
- @param added_anchors The collection of anchors that were added.
- @param updated_anchors The collection of anchors that were updated.
- @param removed_anchors The collection of anchors that were removed.
- */
+ - Parameters:
+ - context: The application-defined context.
+ - added_anchors: The collection of anchors that were added.
+ - updated_anchors: The collection of anchors that were updated.
+ - removed_anchors: The collection of anchors that were removed.
+*/
API_AVAILABLE(visionos(2.0))
typedef void (*ar_room_tracking_update_handler_function_t)(void *_Nullable context,
ar_room_anchors_t added_anchors,
@@ -235,20 +272,22 @@
/**
Create a room tracking configuration.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_room_tracking_configuration_t`.
- */
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_room_tracking_configuration_t`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_room_tracking_configuration_t ar_room_tracking_configuration_create(void) AR_REFINED_FOR_SWIFT;
/**
Create a room tracking provider.
- @param room_tracking_configuration The configuration for room tracking.
+ - Parameter room_tracking_configuration: The configuration for room tracking.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_room_tracking_provider_t`.
- */
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_room_tracking_provider_t`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_room_tracking_provider_t
ar_room_tracking_provider_create(ar_room_tracking_configuration_t room_tracking_configuration) AR_REFINED_FOR_SWIFT;
@@ -257,12 +296,13 @@
/**
Set the handler for receiving room tracking updates.
- @param room_tracking_provider The room tracking provider.
- @param room_tracking_updates_queue The room tracking update queue. Passing NULL will default to the main queue.
- @param room_tracking_update_handler The room tracking update handler.
+ - Parameters:
+ - room_tracking_provider: The room tracking provider.
+ - room_tracking_updates_queue: The room tracking update queue. Passing `NULL` will default to the main queue.
+ - room_tracking_update_handler: The room tracking update handler.
- @note Setting this handler will override the function set using `ar_room_tracking_provider_set_update_handler_f`.
- */
+ - Note: Setting this handler will override the function set using `ar_room_tracking_provider_set_update_handler_f`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void
ar_room_tracking_provider_set_update_handler(ar_room_tracking_provider_t room_tracking_provider,
@@ -273,13 +313,14 @@
/**
Set the function for receiving room tracking updates.
- @param room_tracking_provider The room tracking provider.
- @param room_tracking_updates_queue The room tracking update queue. Passing NULL will default to the main queue.
- @param context The application-defined context parameter to pass to the function.
- @param room_tracking_update_handler_function The room tracking update handler function.
+ - Parameters:
+ - room_tracking_provider: The room tracking provider.
+ - room_tracking_updates_queue: The room tracking update queue. Passing `NULL` will default to the main queue.
+ - context: The application-defined context parameter to pass to the function.
+ - room_tracking_update_handler_function: The room tracking update handler function.
- @note Setting this function will override the handler set using `ar_room_tracking_provider_set_update_handler`.
- */
+ - Note: Setting this function will override the handler set using `ar_room_tracking_provider_set_update_handler`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_room_tracking_provider_set_update_handler_f(
ar_room_tracking_provider_t room_tracking_provider,
@@ -290,11 +331,11 @@
/**
Copy the room anchor that the person is currently inside.
- @param room_tracking_provider The room tracking provider.
+ - Parameter room_tracking_provider: The room tracking provider.
- @return The room anchor that represents the room the person is in and NULL if no room is currently being tracked as current. This type supports ARC.
- In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- */
+ - Returns: The room anchor that represents the room the person is in and `NULL` if no room is currently being tracked as current. This type supports
+ ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_room_anchor_t _Nullable ar_room_tracking_provider_copy_current_room_anchor(
ar_room_tracking_provider_t room_tracking_provider) AR_REFINED_FOR_SWIFT;
@@ -302,11 +343,11 @@
/**
Copy all room anchors.
- @param room_tracking_provider The room tracking provider.
+ - Parameter room_tracking_provider: The room tracking provider.
- @return The collection of all room anchors. This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the
- object.
- */
+ - Returns: The collection of all room anchors. This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release
+ the object.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_room_anchors_t
ar_room_tracking_provider_copy_all_room_anchors(ar_room_tracking_provider_t room_tracking_provider) AR_REFINED_FOR_SWIFT;
@@ -314,41 +355,40 @@
/**
Get the identifiers of all plane anchors in a room anchor.
- @param room_anchor The room anchor.
+ - Parameter room_anchor: The room anchor.
- @return The identifiers of planes in the room anchor.
- @see ar_plane_detection_provider_t
- */
+ - Returns: The identifiers of planes in the room anchor.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN ar_identifiers_t ar_room_anchor_get_plane_anchor_identifiers(ar_room_anchor_t room_anchor) AR_REFINED_FOR_SWIFT;
/**
Get the identifiers of all scene reconstruction mesh anchors in a room anchor.
- @param room_anchor The room anchor.
+ - Parameter room_anchor: The room anchor.
- @return The identifiers of meshes in the room anchor.
- @see ar_scene_reconstruction_provider_t
- */
+ - Returns: The identifiers of meshes in the room anchor.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN ar_identifiers_t ar_room_anchor_get_mesh_anchor_identifiers(ar_room_anchor_t room_anchor) AR_REFINED_FOR_SWIFT;
/**
Determine whether this device supports the room tracking provider.
- @return `true` if the room tracking provider is supported on this device, `false` otherwise.
- */
+ - Returns: `true` if the room tracking provider is supported on this device, `false` otherwise.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool ar_room_tracking_provider_is_supported(void) AR_REFINED_FOR_SWIFT;
/**
Get the authorization type required by the room tracking provider.
- @return The required authorization type.
- */
+ - Returns: The required authorization type.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN ar_authorization_type_t ar_room_tracking_provider_get_required_authorization_type(void) AR_REFINED_FOR_SWIFT;
+API_UNAVAILABLE_END; // macCatalyst
API_UNAVAILABLE_END; // macos
AR_ASSUME_NONNULL_END
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/scene_reconstruction.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/scene_reconstruction.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/scene_reconstruction.h 2026-04-18 22:53:34
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/scene_reconstruction.h 2026-05-22 07:32:10
@@ -17,6 +17,7 @@
#import <ARKit/data_provider.h>
#import <ARKit/object.h>
#import <ARKit/session.h>
+#import <ARKit/transform_correction.h>
#import <os/availability.h>
#import <simd/simd.h>
@@ -24,35 +25,60 @@
AR_ASSUME_NONNULL_BEGIN
API_UNAVAILABLE_BEGIN(macos);
+API_UNAVAILABLE_BEGIN(macCatalyst);
+/**
+ An anchor that represents a reconstructed mesh from the physical environment.
+ */
AR_OBJECT_DECL_SUBCLASS(ar_mesh_anchor, ar_anchor)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(1.0));
+/**
+ Describes the geometry of a mesh including vertices, normals, and faces.
+ */
AR_OBJECT_DECL(ar_mesh_geometry)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(1.0));
+/**
+ A collection of mesh geometries.
+ */
AR_OBJECT_DECL(ar_mesh_geometries)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(2.0));
+/**
+ Describes a source of geometry data such as vertices or normals.
+ */
AR_OBJECT_DECL(ar_geometry_source)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(1.0));
+/**
+ Describes geometry index data organized as primitives like triangles or lines.
+ */
AR_OBJECT_DECL(ar_geometry_element)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(1.0));
+/**
+ A collection of mesh anchors.
+ */
AR_OBJECT_DECL(ar_mesh_anchors)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(1.0));
+/**
+ Configuration for scene reconstruction.
+ */
AR_OBJECT_DECL(ar_scene_reconstruction_configuration)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(1.0));
+/**
+ A data provider for scene reconstruction.
+ */
AR_OBJECT_DECL_SUBCLASS(ar_scene_reconstruction_provider, ar_data_provider)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(1.0));
@@ -118,11 +144,12 @@
/**
Returns a bool value that indicates whether the two geometry elements are equal.
- @param geometry_element A geometry element to be compared.
- @param other_geometry_element The other geometry element to be compared to.
+ - Parameters:
+ - geometry_element: A geometry element to be compared.
+ - other_geometry_element: The other geometry element to be compared to.
- @return YES if the geometry elements are equal, otherwise NO.
- */
+ - Returns: `YES` if the geometry elements are equal, otherwise `NO`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool ar_geometry_element_is_equal_to_geometry_element(ar_geometry_element_t _Nullable geometry_element,
ar_geometry_element_t _Nullable other_geometry_element) AR_REFINED_FOR_SWIFT;
@@ -131,10 +158,10 @@
/**
Get a Metal buffer containing index data that defines a geometry element.
- @param geometry_element The geometry element.
+ - Parameter geometry_element: The geometry element.
- @return A Metal buffer.
- */
+ - Returns: A Metal buffer.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN id<MTLBuffer> ar_geometry_element_get_buffer(ar_geometry_element_t geometry_element) AR_REFINED_FOR_SWIFT;
#endif // __OBJC__
@@ -142,43 +169,42 @@
/**
Get the count of primitives in a geometry element.
- @param geometry_element The geometry element.
+ - Parameter geometry_element: The geometry element.
- @return The number of primitives in the geometry element.
- */
+ - Returns: The number of primitives in the geometry element.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN size_t ar_geometry_element_get_count(ar_geometry_element_t geometry_element) AR_REFINED_FOR_SWIFT;
/**
Get the number of bytes per index value in a geometry element.
- @param geometry_element The geometry element.
+ - Parameter geometry_element: The geometry element.
- @return The bytes per index value.
- */
+ - Returns: The bytes per index value.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN size_t ar_geometry_element_get_bytes_per_index(ar_geometry_element_t geometry_element) AR_REFINED_FOR_SWIFT;
/**
Get the index count per primitive of a geometry element.
- @see `ar_geometry_primitive_type_t`
- @discussion This is based on the primitive type. For `ar_geometry_primitive_type_triangle` the value is 3.
+ This is based on the primitive type. For `ar_geometry_primitive_type_triangle` the value is `3`.
- @param geometry_element The geometry element.
+ - Parameter geometry_element: The geometry element.
- @return The number of indices for each of the geometry element's primitives.
- */
+ - Returns: The number of indices for each of the geometry element's primitives.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN size_t ar_geometry_element_get_index_count_per_primitive(ar_geometry_element_t geometry_element) AR_REFINED_FOR_SWIFT;
/**
Get the primitive type of a geometry element.
- @param geometry_element The geometry element.
+ - Parameter geometry_element: The geometry element.
- @return The geometry element's primitive type.
- */
+ - Returns: The geometry element's primitive type.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN ar_geometry_primitive_type_t ar_geometry_element_get_primitive_type(ar_geometry_element_t geometry_element) AR_REFINED_FOR_SWIFT;
@@ -187,11 +213,12 @@
/**
Returns a bool value that indicates whether the two geometry sources are equal.
- @param geometry_source A geometry source to be compared.
- @param other_geometry_source The other geometry source to be compared to.
+ - Parameters:
+ - geometry_source: A geometry source to be compared.
+ - other_geometry_source: The other geometry source to be compared to.
- @return YES if the geometry sources are equal, otherwise NO.
- */
+ - Returns: `YES` if the geometry sources are equal, otherwise `NO`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool ar_geometry_source_is_equal_to_geometry_source(ar_geometry_source_t _Nullable geometry_source,
ar_geometry_source_t _Nullable other_geometry_source) AR_REFINED_FOR_SWIFT;
@@ -200,10 +227,10 @@
/**
Get a Metal buffer containing per-vector data for a geometry source.
- @param geometry_source The geometry source.
+ - Parameter geometry_source: The geometry source.
- @return A Metal buffer containing per-vector data.
- */
+ - Returns: A Metal buffer containing per-vector data.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN id<MTLBuffer> ar_geometry_source_get_buffer(ar_geometry_source_t geometry_source) AR_REFINED_FOR_SWIFT;
#endif // __OBJC__
@@ -211,10 +238,10 @@
/**
Get the count of vectors in a geometry source.
- @param geometry_source The geometry source.
+ - Parameter geometry_source: The geometry source.
- @return The number of vectors in the geometry source.
- */
+ - Returns: The number of vectors in the geometry source.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN size_t ar_geometry_source_get_count(ar_geometry_source_t geometry_source) AR_REFINED_FOR_SWIFT;
@@ -222,10 +249,10 @@
/**
Get the type of per-vector data in a geometry source.
- @param geometry_source The geometry source.
+ - Parameter geometry_source: The geometry source.
- @return The format of the vertex data.
- */
+ - Returns: The format of the vertex data.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN MTLVertexFormat ar_geometry_source_get_format(ar_geometry_source_t geometry_source) AR_REFINED_FOR_SWIFT;
#endif // __OBJC__
@@ -233,28 +260,30 @@
/**
Get the count of scalar components in each vector of a geometry source.
- @param geometry_source The geometry source.
+ - Parameter geometry_source: The geometry source.
- @return The number of scalar components in each vector of the geometry source.
- */
+ - Returns: The number of scalar components in each vector of the geometry source.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN size_t ar_geometry_source_get_components_per_vector(ar_geometry_source_t geometry_source) AR_REFINED_FOR_SWIFT;
/**
Get the offset (in bytes) from the beginning of a geometry source's Metal buffer.
- @param geometry_source The geometry source.
- */
+ - Parameter geometry_source: The geometry source.
+
+ - Returns: The offset in bytes.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN size_t ar_geometry_source_get_offset(ar_geometry_source_t geometry_source) AR_REFINED_FOR_SWIFT;
/**
Get the number of bytes from a vector to the next one in a geometry source's Metal buffer.
- @param geometry_source The geometry source.
+ - Parameter geometry_source: The geometry source.
- @return The stride between vectors, in bytes.
- */
+ - Returns: The stride between vectors, in bytes.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN size_t ar_geometry_source_get_stride(ar_geometry_source_t geometry_source) AR_REFINED_FOR_SWIFT;
@@ -263,11 +292,12 @@
/**
Returns a bool value that indicates whether the two mesh geometries are equal.
- @param mesh_geometry A mesh geometry to be compared.
- @param other_mesh_geometry The other mesh geometry to be compared to.
+ - Parameters:
+ - mesh_geometry: A mesh geometry to be compared.
+ - other_mesh_geometry: The other mesh geometry to be compared to.
- @return YES if the mesh geometries are equal, otherwise NO.
- */
+ - Returns: `YES` if the mesh geometries are equal, otherwise `NO`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool ar_mesh_geometry_is_equal_to_mesh_geometry(ar_mesh_geometry_t _Nullable mesh_geometry,
ar_mesh_geometry_t _Nullable other_mesh_geometry) AR_REFINED_FOR_SWIFT;
@@ -275,40 +305,40 @@
/**
Get the vertices of a mesh geometry.
- @param mesh_geometry The mesh geometry.
+ - Parameter mesh_geometry: The mesh geometry.
- @return An instance of `ar_geometry_source_t`.
- */
+ - Returns: An instance of `ar_geometry_source_t`.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN ar_geometry_source_t ar_mesh_geometry_get_vertices(ar_mesh_geometry_t mesh_geometry) AR_REFINED_FOR_SWIFT;
/**
Get the normals of a mesh geometry.
- @param mesh_geometry The mesh geometry.
+ - Parameter mesh_geometry: The mesh geometry.
- @return An instance of `ar_geometry_source_t`.
- */
+ - Returns: An instance of `ar_geometry_source_t`.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN ar_geometry_source_t ar_mesh_geometry_get_normals(ar_mesh_geometry_t mesh_geometry) AR_REFINED_FOR_SWIFT;
/**
Get the faces of a mesh geometry.
- @param mesh_geometry The mesh geometry.
+ - Parameter mesh_geometry: The mesh geometry.
- @return An instance of `ar_geometry_element_t`.
- */
+ - Returns: An instance of `ar_geometry_element_t`.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN ar_geometry_element_t ar_mesh_geometry_get_faces(ar_mesh_geometry_t mesh_geometry) AR_REFINED_FOR_SWIFT;
/**
Get the classification for each face of a mesh geometry.
- @param mesh_geometry The mesh geometry.
+ - Parameter mesh_geometry: The mesh geometry.
- @return An instance of `ar_geometry_source_t`.
- */
+ - Returns: An instance of `ar_geometry_source_t`.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN ar_geometry_source_t _Nullable ar_mesh_geometry_get_classification(ar_mesh_geometry_t mesh_geometry) AR_REFINED_FOR_SWIFT;
@@ -317,10 +347,10 @@
/**
Get the count of mesh geometries in a collection.
- @param mesh_geometries The collection of mesh geometries.
+ - Parameter mesh_geometries: The collection of mesh geometries.
- @return The number of mesh geometries in the collection.
- */
+ - Returns: The number of mesh geometries in the collection.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN size_t ar_mesh_geometries_get_count(ar_mesh_geometries_t mesh_geometries) AR_REFINED_FOR_SWIFT;
@@ -328,19 +358,20 @@
/**
Handler for enumerating a collection of mesh geometries.
- @param mesh_geometry The mesh geometry.
+ - Parameter mesh_geometry: The mesh geometry.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(2.0))
typedef bool (^ar_mesh_geometries_enumerator_t)(ar_mesh_geometry_t mesh_geometry) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of mesh geometries.
- @param mesh_geometries The collection of mesh geometries.
- @param mesh_geometries_enumerator The enumerator handler.
- */
+ - Parameters:
+ - mesh_geometries: The collection of mesh geometries.
+ - mesh_geometries_enumerator: The enumerator handler.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_mesh_geometries_enumerate_geometries(ar_mesh_geometries_t mesh_geometries,
ar_mesh_geometries_enumerator_t mesh_geometries_enumerator) AR_REFINED_FOR_SWIFT;
@@ -349,21 +380,23 @@
/**
Function for enumerating a collection of mesh geometries.
- @param context The application-defined context.
- @param mesh_geometry The mesh geometry.
+ - Parameters:
+ - context: The application-defined context.
+ - mesh_geometry: The mesh geometry.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(2.0))
typedef bool (*ar_mesh_geometries_enumerator_function_t)(void *_Nullable context, ar_mesh_geometry_t mesh_geometry) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of mesh geometries using a function.
- @param mesh_geometries The collection of mesh geometries.
- @param context The application-defined context parameter to pass to the function.
- @param mesh_geometries_enumerator_function The enumerator function.
- */
+ - Parameters:
+ - mesh_geometries: The collection of mesh geometries.
+ - context: The application-defined context parameter to pass to the function.
+ - mesh_geometries_enumerator_function: The enumerator function.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void
ar_mesh_geometries_enumerate_geometries_f(ar_mesh_geometries_t mesh_geometries,
@@ -375,11 +408,12 @@
/**
Returns a bool value that indicates whether the two mesh anchors are equal.
- @param mesh_anchor A mesh anchor to be compared.
- @param other_mesh_anchor The other mesh anchor to be compared to.
+ - Parameters:
+ - mesh_anchor: A mesh anchor to be compared.
+ - other_mesh_anchor: The other mesh anchor to be compared to.
- @return YES if the mesh anchors are equal, otherwise NO.
- */
+ - Returns: `YES` if the mesh anchors are equal, otherwise `NO`.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN bool ar_mesh_anchor_is_equal_to_mesh_anchor(ar_mesh_anchor_t _Nullable mesh_anchor,
ar_mesh_anchor_t _Nullable other_mesh_anchor) AR_REFINED_FOR_SWIFT;
@@ -387,10 +421,10 @@
/**
Get the geometry of the mesh in a mesh anchor's coordinate system.
- @param mesh_anchor The mesh anchor.
+ - Parameter mesh_anchor: The mesh anchor.
- @return An instance of `ar_mesh_geometry_t`.
- */
+ - Returns: An instance of `ar_mesh_geometry_t`.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN ar_mesh_geometry_t ar_mesh_anchor_get_geometry(ar_mesh_anchor_t mesh_anchor) AR_REFINED_FOR_SWIFT;
@@ -399,29 +433,43 @@
/**
Get the identifier of an anchor.
- @param[in] anchor The anchor.
- @param[out] out_identifier A pointer to a UUID to fill out with the anchor identifier. Must be non-null.
- */
+ - Parameters:
+ - anchor: The anchor.
+ - out_identifier: A pointer to a UUID to fill out with the anchor identifier. Must be non-null.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN void ar_mesh_anchor_get_identifier(ar_mesh_anchor_t anchor, uuid_t _Nonnull out_identifier) AR_REFINED_FOR_SWIFT;
/**
Get the transform from an anchor to the origin coordinate system.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return The origin from anchor transform.
- */
+ - Returns: The origin from anchor transform.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN simd_float4x4 ar_mesh_anchor_get_origin_from_anchor_transform(ar_mesh_anchor_t anchor) AR_REFINED_FOR_SWIFT;
/**
+ Get the transform from an anchor to the origin coordinate system.
+
+ - Parameters:
+ - anchor: The anchor.
+ - transform_correction: The transform correction that should be applied.
+
+ - Returns: The origin from anchor transform.
+*/
+API_AVAILABLE(visionos(27.0))
+AR_EXTERN simd_float4x4 ar_mesh_anchor_get_origin_from_anchor_transform_with_correction(
+ ar_mesh_anchor_t anchor, ar_transform_correction_t transform_correction) AR_REFINED_FOR_SWIFT;
+
+/**
Get the timestamp corresponding to an anchor.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return The timestamp associated with the anchor.
- */
+ - Returns: The timestamp associated with the anchor.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN CFTimeInterval ar_mesh_anchor_get_timestamp(ar_mesh_anchor_t anchor) AR_REFINED_FOR_SWIFT;
@@ -430,10 +478,10 @@
/**
Get the count of mesh anchors in a collection.
- @param mesh_anchors The collection of mesh anchors.
+ - Parameter mesh_anchors: The collection of mesh anchors.
- @return The number of mesh anchors in the collection.
- */
+ - Returns: The number of mesh anchors in the collection.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN size_t ar_mesh_anchors_get_count(ar_mesh_anchors_t mesh_anchors) AR_REFINED_FOR_SWIFT;
@@ -441,19 +489,20 @@
/**
Handler for enumerating a collection of mesh anchors.
- @param mesh_anchor The mesh anchor.
+ - Parameter mesh_anchor: The mesh anchor.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(1.0))
typedef bool (^ar_mesh_anchors_enumerator_t)(ar_mesh_anchor_t mesh_anchor) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of mesh anchors.
- @param mesh_anchors The collection of mesh anchors.
- @param mesh_anchors_enumerator The enumerator handler.
- */
+ - Parameters:
+ - mesh_anchors: The collection of mesh anchors.
+ - mesh_anchors_enumerator: The enumerator handler.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN void ar_mesh_anchors_enumerate_anchors(ar_mesh_anchors_t mesh_anchors,
ar_mesh_anchors_enumerator_t mesh_anchors_enumerator) AR_REFINED_FOR_SWIFT;
@@ -462,21 +511,23 @@
/**
Function for enumerating a collection of mesh anchors.
- @param context The application-defined context.
- @param mesh_anchor The mesh anchor.
+ - Parameters:
+ - context: The application-defined context.
+ - mesh_anchor: The mesh anchor.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(1.0))
typedef bool (*ar_mesh_anchors_enumerator_function_t)(void *_Nullable context, ar_mesh_anchor_t mesh_anchor) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of mesh anchors using a function.
- @param mesh_anchors The collection of mesh anchors.
- @param context The application-defined context parameter to pass to the function.
- @param mesh_anchors_enumerator_function The enumerator function.
- */
+ - Parameters:
+ - mesh_anchors: The collection of mesh anchors.
+ - context: The application-defined context parameter to pass to the function.
+ - mesh_anchors_enumerator_function: The enumerator function.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN void ar_mesh_anchors_enumerate_anchors_f(ar_mesh_anchors_t mesh_anchors,
void *_Nullable context,
@@ -484,6 +535,9 @@
#pragma mark - Scene Reconstruction Configuration
+/**
+ Scene reconstruction modes.
+ */
API_AVAILABLE(visionos(1.0))
OS_OPTIONS(ar_scene_reconstruction_mode,
uint64_t,
@@ -498,10 +552,11 @@
/**
Handler called when there are updates to mesh anchors.
- @param added_anchors The collection of anchors that were added.
- @param updated_anchors The collection of anchors that were updated.
- @param removed_anchors The collection of anchors that were removed.
- */
+ - Parameters:
+ - added_anchors: The collection of anchors that were added.
+ - updated_anchors: The collection of anchors that were updated.
+ - removed_anchors: The collection of anchors that were removed.
+*/
API_AVAILABLE(visionos(1.0))
typedef void (^ar_scene_reconstruction_update_handler_t)(ar_mesh_anchors_t added_anchors,
ar_mesh_anchors_t updated_anchors,
@@ -511,11 +566,12 @@
/**
Function called when there are updates to mesh anchors.
- @param context The application-defined context.
- @param added_anchors The collection of anchors that were added.
- @param updated_anchors The collection of anchors that were updated.
- @param removed_anchors The collection of anchors that were removed.
- */
+ - Parameters:
+ - context: The application-defined context.
+ - added_anchors: The collection of anchors that were added.
+ - updated_anchors: The collection of anchors that were updated.
+ - removed_anchors: The collection of anchors that were removed.
+*/
API_AVAILABLE(visionos(1.0))
typedef void (*ar_scene_reconstruction_update_handler_function_t)(void *_Nullable context,
ar_mesh_anchors_t added_anchors,
@@ -525,19 +581,20 @@
/**
Create a scene reconstruction configuration.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_scene_reconstruction_configuration_t`.
- */
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_scene_reconstruction_configuration_t`.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_scene_reconstruction_configuration_t ar_scene_reconstruction_configuration_create(void) AR_REFINED_FOR_SWIFT;
/**
Get the scene reconstruction mode.
- @param scene_reconstruction_configuration The configuration for scene reconstruction.
+ - Parameter scene_reconstruction_configuration: The configuration for scene reconstruction.
- @return The scene reconstruction mode for the configuration.
- */
+ - Returns: The scene reconstruction mode for the configuration.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN ar_scene_reconstruction_mode_t ar_scene_reconstruction_configuration_get_scene_reconstruction_mode(
ar_scene_reconstruction_configuration_t scene_reconstruction_configuration) AR_REFINED_FOR_SWIFT;
@@ -545,9 +602,10 @@
/**
Set the scene reconstruction mode.
- @param scene_reconstruction_configuration The configuration for scene reconstruction.
- @param scene_reconstruction_mode The scene reconstruction mode to set.
- */
+ - Parameters:
+ - scene_reconstruction_configuration: The configuration for scene reconstruction.
+ - scene_reconstruction_mode: The scene reconstruction mode to set.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN void
ar_scene_reconstruction_configuration_set_scene_reconstruction_mode(ar_scene_reconstruction_configuration_t scene_reconstruction_configuration,
@@ -558,11 +616,12 @@
/**
Create a scene reconstruction provider.
- @param scene_reconstruction_configuration The configuration for scene reconstruction.
+ - Parameter scene_reconstruction_configuration: The configuration for scene reconstruction.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_scene_reconstruction_provider_t`.
- */
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_scene_reconstruction_provider_t`.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_scene_reconstruction_provider_t
ar_scene_reconstruction_provider_create(ar_scene_reconstruction_configuration_t scene_reconstruction_configuration) AR_REFINED_FOR_SWIFT;
@@ -571,12 +630,13 @@
/**
Set the handler for receiving scene reconstruction updates.
- @param scene_reconstruction_provider The scene reconstruction provider.
- @param scene_reconstruction_updates_queue The queue on which the handler will be executed. Passing NULL will default to the main queue.
- @param scene_reconstruction_update_handler The handler to be called when new scene reconstruction data arrives.
+ - Parameters:
+ - scene_reconstruction_provider: The scene reconstruction provider.
+ - scene_reconstruction_updates_queue: The queue on which the handler will be executed. Passing `NULL` will default to the main queue.
+ - scene_reconstruction_update_handler: The handler to be called when new scene reconstruction data arrives.
- @note Setting this handler will override the function set using `ar_scene_reconstruction_provider_set_update_handler_f`.
- */
+ - Note: Setting this handler will override the function set using `ar_scene_reconstruction_provider_set_update_handler_f`.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN void ar_scene_reconstruction_provider_set_update_handler(
ar_scene_reconstruction_provider_t scene_reconstruction_provider,
@@ -587,13 +647,14 @@
/**
Set the function for receiving scene reconstruction updates.
- @param scene_reconstruction_provider The scene reconstruction provider.
- @param scene_reconstruction_updates_queue The queue on which the function will be called. Passing NULL will default to the main queue.
- @param context The application-defined context parameter to pass to the function.
- @param scene_reconstruction_update_handler_function The function to be called when new scene reconstruction data arrives.
+ - Parameters:
+ - scene_reconstruction_provider: The scene reconstruction provider.
+ - scene_reconstruction_updates_queue: The queue on which the function will be called. Passing `NULL` will default to the main queue.
+ - context: The application-defined context parameter to pass to the function.
+ - scene_reconstruction_update_handler_function: The function to be called when new scene reconstruction data arrives.
- @note Setting this function will override the handler set using `ar_scene_reconstruction_provider_set_update_handler`.
- */
+ - Note: Setting this function will override the handler set using `ar_scene_reconstruction_provider_set_update_handler`.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN void ar_scene_reconstruction_provider_set_update_handler_f(
ar_scene_reconstruction_provider_t scene_reconstruction_provider,
@@ -604,11 +665,11 @@
/**
Copy all mesh anchors.
- @param scene_reconstruction_provider The scene reconstruction provider.
+ - Parameter scene_reconstruction_provider: The scene reconstruction provider.
- @return The collection of all mesh anchors. This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the
- object.
- */
+ - Returns: The collection of all mesh anchors. This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release
+ the object.
+*/
API_AVAILABLE(visionos(2.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_mesh_anchors_t
ar_scene_reconstruction_provider_copy_all_mesh_anchors(ar_scene_reconstruction_provider_t scene_reconstruction_provider) AR_REFINED_FOR_SWIFT;
@@ -616,19 +677,20 @@
/**
Determine whether this device supports the scene reconstruction provider.
- @return `true` if the scene reconstruction provider is supported on this device, `false` otherwise.
- */
+ - Returns: `true` if the scene reconstruction provider is supported on this device, `false` otherwise.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN bool ar_scene_reconstruction_provider_is_supported(void) AR_REFINED_FOR_SWIFT;
/**
Get the authorization type required by the scene reconstruction provider.
- @return The required authorization type.
- */
+ - Returns: The required authorization type.
+*/
API_AVAILABLE(visionos(1.0))
AR_EXTERN ar_authorization_type_t ar_scene_reconstruction_provider_get_required_authorization_type(void) AR_REFINED_FOR_SWIFT;
+API_UNAVAILABLE_END; // macCatalyst
API_UNAVAILABLE_END; // macos
AR_ASSUME_NONNULL_END
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/session.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/session.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/session.h 2026-04-19 01:08:31
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/session.h 2026-05-22 07:32:10
@@ -21,38 +21,50 @@
#pragma mark - Device
+/**
+ Represents a physical device that a session can be run on.
+ */
AR_OBJECT_DECL(ar_device)
API_UNAVAILABLE(visionos)
-API_AVAILABLE(macos(26.0));
+API_AVAILABLE(macos(26.0), macCatalyst(16.0));
#pragma mark - Session
+/**
+ An ARKit session that manages data providers and authorization.
+ */
AR_OBJECT_DECL(ar_session)
AR_REFINED_FOR_SWIFT
-API_AVAILABLE(visionos(1.0), macos(26.0));
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0));
/**
Create an ARKit session.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_session_t`.
- */
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_session_t`.
+*/
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_session_t ar_session_create(void) AR_REFINED_FOR_SWIFT;
/**
Create a session connected to the specified device.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @param device The device to connect to.
- @return An instance of `ar_session_t`.
- */
-API_AVAILABLE(macos(26.0))
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Parameter device: The device to connect to.
+
+ - Returns: An instance of `ar_session_t`.
+*/
+API_AVAILABLE(macos(26.0), macCatalyst(16.0))
API_UNAVAILABLE(visionos)
-AR_EXTERN ar_session_t ar_session_create_with_device(ar_device_t device) AR_REFINED_FOR_SWIFT;
+AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_session_t ar_session_create_with_device(ar_device_t device) AR_REFINED_FOR_SWIFT;
-API_AVAILABLE(visionos(1.0), macos(26.0))
+/**
+ Session error codes.
+ */
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
OS_ENUM(ar_session_error_code, ar_error_code_t,
/// Error code indicating that a data provider requires an authorization that has not been granted by the user.
ar_session_error_code_data_provider_not_authorized = 100,
@@ -61,30 +73,32 @@
) AR_REFINED_FOR_SWIFT;
#ifdef __BLOCKS__
-/// A handler that the session calls when one or more data providers associated with it change state.
-///
-/// - Parameters:
-/// - data_providers: The collection of data providers that changed state.
-/// - new_state: The data provider state that triggered the event.
-/// - error: An error associated with the state change, if any. The returned error supports ARC. In non-ARC files, call `ar_release()` to release
-/// the error. Also see `ar_session_error_code_t`.
-/// - failed_data_provider: The data provider that failed and caused the error, if any.
-///
-API_AVAILABLE(visionos(1.0), macos(26.0))
+/**
+ A handler that the session calls when one or more data providers associated with it change state.
+
+ - Parameters:
+ - data_providers: The collection of data providers that changed state.
+ - new_state: The data provider state that triggered the event.
+ - error: An error associated with the state change, if any. Also see `ar_session_error_code_t`.
+ - failed_data_provider: The data provider that failed and caused the error, if any.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
typedef void (^ar_session_data_provider_state_change_handler_t)(ar_data_providers_t data_providers,
ar_data_provider_state_t new_state,
ar_error_t _Nullable error,
ar_data_provider_t _Nullable failed_data_provider) AR_REFINED_FOR_SWIFT;
-/// Sets the handler for responding to a state change of one or more data providers.
-///
-/// - Parameters:
-/// - session: The `ar_session_t` instance.
-/// - queue: The queue on which the handler will be called. Passing NULL will default to the main queue.
-/// - data_provider_state_change_handler: The data provider state change handler.
-///
-/// - Note: Setting this will override the function set using `ar_session_set_data_provider_state_change_handler_f`.
-API_AVAILABLE(visionos(1.0), macos(26.0))
+/**
+ Sets the handler for responding to a state change of one or more data providers.
+
+ - Parameters:
+ - session: The `ar_session_t` instance.
+ - queue: The queue on which the handler will be called. Passing NULL will default to the main queue.
+ - data_provider_state_change_handler: The data provider state change handler.
+
+ - Note: Setting this will override the function set using `ar_session_set_data_provider_state_change_handler_f`.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN void ar_session_set_data_provider_state_change_handler(
ar_session_t session,
dispatch_queue_t _Nullable queue,
@@ -92,34 +106,35 @@
#endif // __BLOCKS__
-/// A handler function that the session calls when one or more data providers associated with it change state.
-///
-/// - Parameters:
-/// - context: The application-defined context.
-/// - data_providers: The collection of data providers that changed state.
-/// - new_state: The data provider state that triggered the event.
-/// - error: An error associated with the state change, if any. The returned error supports ARC. In non-ARC files, call `ar_release()` to
-/// release the error. Also see `ar_session_error_code_t`.
-/// - failed_data_provider: The data provider that failed and caused the error, if any.
-///
-API_AVAILABLE(visionos(1.0), macos(26.0))
+/**
+ A handler function that the session calls when one or more data providers associated with it change state.
+
+ - Parameters:
+ - context: The application-defined context.
+ - data_providers: The collection of data providers that changed state.
+ - new_state: The data provider state that triggered the event.
+ - error: An error associated with the state change, if any. Also see `ar_session_error_code_t`.
+ - failed_data_provider: The data provider that failed and caused the error, if any.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
typedef void (*ar_session_data_provider_state_change_handler_function_t)(void *_Nullable context,
ar_data_providers_t data_providers,
ar_data_provider_state_t new_state,
ar_error_t _Nullable error,
ar_data_provider_t _Nullable failed_data_provider) AR_REFINED_FOR_SWIFT;
-/// Sets the handler function for responding to a state change of one or more data providers.
-///
-/// - Parameters:
-/// - session: The `ar_session_t` instance.
-/// - queue: The queue on which the function will be called. Passing NULL will default to the main queue.
-/// - context: The application-defined context parameter to pass to the function.
-/// - data_provider_state_change_handler_function: The data provider state change handler function.
-///
-/// - Note: Setting this will override the handler set using `ar_session_set_data_provider_state_change_handler`.
-///
-API_AVAILABLE(visionos(1.0), macos(26.0))
+/**
+ Sets the handler function for responding to a state change of one or more data providers.
+
+ - Parameters:
+ - session: The `ar_session_t` instance.
+ - queue: The queue on which the function will be called. Passing NULL will default to the main queue.
+ - context: The application-defined context parameter to pass to the function.
+ - data_provider_state_change_handler_function: The data provider state change handler function.
+
+ - Note: Setting this will override the handler set using `ar_session_set_data_provider_state_change_handler`.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN void ar_session_set_data_provider_state_change_handler_f(
ar_session_t session,
dispatch_queue_t _Nullable queue,
@@ -129,28 +144,30 @@
/**
Run data providers on a session.
- @param session The session.
- @param data_providers The collection of data providers to run.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Parameters:
+ - session: The session.
+ - data_providers: The collection of data providers to run.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN void ar_session_run(ar_session_t session, ar_data_providers_t data_providers) AR_REFINED_FOR_SWIFT;
/**
Stop all running data providers on a session.
- @param session The session.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Parameter session: The session.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN void ar_session_stop(ar_session_t session) AR_REFINED_FOR_SWIFT;
/**
Get a copy of the collection of all data providers on this session.
- @param session The session.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return The collection of data providers.
- */
-API_AVAILABLE(visionos(26.0), macos(26.0))
+ - Parameter session: The session.
+
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+ - Returns: The collection of data providers.
+*/
+API_AVAILABLE(visionos(26.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_data_providers_t ar_session_copy_data_providers(ar_session_t session) AR_REFINED_FOR_SWIFT;
#pragma mark - Session Authorization
@@ -159,22 +176,23 @@
/**
Handler to be called when there are updates to authorization.
- @param authorization_result The authorization result.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Parameter authorization_result: The authorization result.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
typedef void (^ar_authorization_update_handler_t)(ar_authorization_result_t authorization_result) AR_REFINED_FOR_SWIFT;
/**
Set the handler for receiving authorization status updates.
- @param session The session.
- @param authorization_update_queue The queue on which the handler will be called. Passing NULL will default to the main queue.
- @param authorization_update_handler The handler to be called when there is an update to authorization status.
+ - Parameters:
+ - session: The session.
+ - authorization_update_queue: The queue on which the handler will be called. Passing NULL will default to the main queue.
+ - authorization_update_handler: The handler to be called when there is an update to authorization status.
- @note Setting this handler will override the function set using `ar_session_set_authorization_update_handler_f`.
- */
+ - Note: Setting this handler will override the function set using `ar_session_set_authorization_update_handler_f`.
+*/
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN void
ar_session_set_authorization_update_handler(ar_session_t session,
dispatch_queue_t _Nullable authorization_update_queue,
@@ -184,25 +202,27 @@
/**
Function to be called when there are updates to authorization.
- @param context The application-defined context.
- @param authorization_result The authorization result.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Parameters:
+ - context: The application-defined context.
+ - authorization_result: The authorization result.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
typedef void (*ar_authorization_update_handler_function_t)(void *_Nullable context,
ar_authorization_result_t authorization_result) AR_REFINED_FOR_SWIFT;
/**
Set the function for receiving authorization status updates.
- @param session The session.
- @param authorization_update_queue The queue on which the function will be called. Passing NULL will default to the main queue.
- @param context The application-defined context parameter to pass to the function.
- @param authorization_update_handler_function The function to be called when there is an update to authorization status.
+ - Parameters:
+ - session: The session.
+ - authorization_update_queue: The queue on which the function will be called. Passing NULL will default to the main queue.
+ - context: The application-defined context parameter to pass to the function.
+ - authorization_update_handler_function: The function to be called when there is an update to authorization status.
- @note Setting this function will override the handler set using `ar_session_set_authorization_update_handler`.
- */
+ - Note: Setting this function will override the handler set using `ar_session_set_authorization_update_handler`.
+*/
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN void ar_session_set_authorization_update_handler_f(
ar_session_t session,
dispatch_queue_t _Nullable authorization_update_queue,
@@ -213,23 +233,23 @@
/**
Handler to be called upon completion of an authorization request.
- @param authorization_results The collection of authorization results.
- @param error The error that occurred during the authorization request, if any. The returned error supports ARC. In non-ARC files, use `ar_release()`
- to release the error.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Parameters:
+ - authorization_results: The collection of authorization results.
+ - error: The error that occurred during the authorization request, if any.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
typedef void (^ar_authorization_results_handler_t)(ar_authorization_results_t authorization_results, ar_error_t _Nullable error) AR_REFINED_FOR_SWIFT;
/**
Query the status of different authorization types.
- @param session The session.
- @param authorization_types The authorization types to query.
- @param results_handler The handler to be called upon completion of the request. This handler will be called on an arbitrary queue.
+ - Parameters:
+ - session: The session.
+ - authorization_types: The authorization types to query.
+ - results_handler: The handler to be called upon completion of the request. This handler will be called on an arbitrary queue.
*/
-
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN void ar_session_query_authorization_results(ar_session_t session,
ar_authorization_type_t authorization_types,
ar_authorization_results_handler_t results_handler) AR_REFINED_FOR_SWIFT;
@@ -237,15 +257,16 @@
/**
Request authorization for accessing ARKit data.
- @param session The session.
- @param authorization_types The authorization types to request.
- @param results_handler The handler to be called upon completion of the request. This handler will be called on an arbitrary queue.
-
- @discussion This will asynchronously prompt users for permission to access their data. If the authorization is already allowed or denied by the user,
+ This will asynchronously prompt users for permission to access their data. If the authorization is already allowed or denied by the user,
the handler will be called without prompting the user for permission again.
+
+ - Parameters:
+ - session: The session.
+ - authorization_types: The authorization types to request.
+ - results_handler: The handler to be called upon completion of the request. This handler will be called on an arbitrary queue.
*/
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN void ar_session_request_authorization(ar_session_t session,
ar_authorization_type_t authorization_types,
ar_authorization_results_handler_t results_handler) AR_REFINED_FOR_SWIFT;
@@ -254,12 +275,12 @@
/**
Function to be called upon completion of an authorization request.
- @param context The application-defined context.
- @param authorization_results The collection of authorization results.
- @param error The error that occurred during the authorization request, if any. The returned error supports ARC. In non-ARC files, use `ar_release()`
- to release the error.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Parameters:
+ - context: The application-defined context.
+ - authorization_results: The collection of authorization results.
+ - error: The error that occurred during the authorization request, if any.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
typedef void (*ar_authorization_results_handler_function_t)(void *_Nullable context,
ar_authorization_results_t authorization_results,
ar_error_t _Nullable error) AR_REFINED_FOR_SWIFT;
@@ -267,14 +288,14 @@
/**
Query the status of different authorization types.
- @param session The session.
- @param authorization_types The authorization types to query.
- @param context The application-defined context parameter to pass to the function.
- @param results_handler_function The function to be called upon completion of the request. This function will be called on an arbitrary queue.
+ - Parameters:
+ - session: The session.
+ - authorization_types: The authorization types to query.
+ - context: The application-defined context parameter to pass to the function.
+ - results_handler_function: The function to be called upon completion of the request. This function will be called on an arbitrary queue.
*/
-
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN void ar_session_query_authorization_results_f(ar_session_t session,
ar_authorization_type_t authorization_types,
void *_Nullable context,
@@ -283,16 +304,17 @@
/**
Request authorization for accessing ARKit data.
- @param session The session.
- @param authorization_types The authorization types to request.
- @param context The application-defined context parameter to pass to the function.
- @param results_handler_function The function to be called upon completion of the request. This function will be called on an arbitrary queue.
-
- @discussion This will asynchronously prompt users for permission to access their data. If the authorization is already allowed or denied by the user,
+ This will asynchronously prompt users for permission to access their data. If the authorization is already allowed or denied by the user,
the function will be called without prompting the user for permission again.
+
+ - Parameters:
+ - session: The session.
+ - authorization_types: The authorization types to request.
+ - context: The application-defined context parameter to pass to the function.
+ - results_handler_function: The function to be called upon completion of the request. This function will be called on an arbitrary queue.
*/
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN void ar_session_request_authorization_f(ar_session_t session,
ar_authorization_type_t authorization_types,
void *_Nullable context,
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/shared_coordinate_space.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/shared_coordinate_space.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/shared_coordinate_space.h 1969-12-31 19:00:00
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/shared_coordinate_space.h 2026-06-01 00:37:41
@@ -0,0 +1,309 @@
+#if (defined(USE_ARKIT_PUBLIC_HEADERS) && USE_ARKIT_PUBLIC_HEADERS) || !__has_include(<ARKitCore/shared_coordinate_space.h>)
+//
+// shared_coordinate_space.h
+// ARKit
+//
+// An enterprise license is required to use shared coordinate space, and will be otherwise be a no-op.
+// The app must include the following entitlement:
+// com.apple.developer.arkit.shared-coordinate-space.allow
+//
+// Created by Jae Lee on 12/11/24.
+// Copyright © 2025 Apple Inc. All rights reserved.
+//
+
+#ifndef shared_coordinate_space_h
+#define shared_coordinate_space_h
+
+#import <ARKit/data_provider.h>
+#import <ARKit/identifiers.h>
+#import <ARKit/object.h>
+
+AR_ASSUME_NONNULL_BEGIN
+
+API_UNAVAILABLE_BEGIN(macos);
+API_UNAVAILABLE_BEGIN(macCatalyst);
+
+/**
+ Data for sharing coordinate space information between participants.
+ */
+AR_OBJECT_DECL(ar_coordinate_space_data)
+AR_REFINED_FOR_SWIFT
+API_AVAILABLE(visionos(26.0));
+
+/**
+ Configuration for the shared coordinate space provider.
+ */
+AR_OBJECT_DECL(ar_shared_coordinate_space_configuration)
+AR_REFINED_FOR_SWIFT
+API_AVAILABLE(visionos(26.0));
+
+/**
+ A data provider for shared coordinate spaces across participants.
+ */
+AR_OBJECT_DECL_SUBCLASS(ar_shared_coordinate_space_provider, ar_data_provider)
+AR_REFINED_FOR_SWIFT
+API_AVAILABLE(visionos(26.0));
+
+#ifdef __BLOCKS__
+/**
+ A handler that the provider calls when there is an update to the shared coordinate space connected participants.
+
+ - Parameter connected_participant_identifiers: List of all participant identifiers that have established a shared coordinate space.
+*/
+API_AVAILABLE(visionos(26.0))
+typedef void (^ar_shared_coordinate_space_connected_participants_update_handler_t)(ar_identifiers_t connected_participant_identifiers)
+ AR_REFINED_FOR_SWIFT;
+
+/**
+ A handler that the provider calls when there is an update to the shared coordinate space sharing status.
+
+ - Parameter is_sharing_enabled: Whether coordinate space sharing is enabled.
+*/
+API_AVAILABLE(visionos(26.0))
+typedef void (^ar_shared_coordinate_space_sharing_status_update_handler_t)(bool is_sharing_enabled) AR_REFINED_FOR_SWIFT;
+
+#endif // __BLOCKS__
+
+/**
+ Function called when there are updates to the shared coordinate space participant status.
+
+ - Parameters:
+ - context: The application-defined context.
+ - connected_participant_identifiers: List of participant identifiers that have established a shared coordinate space.
+*/
+API_AVAILABLE(visionos(26.0))
+typedef void (*ar_shared_coordinate_space_connected_participants_update_handler_function_t)(
+ void *_Nullable context, ar_identifiers_t connected_participant_identifiers) AR_REFINED_FOR_SWIFT;
+
+/**
+ Function called when there is an update to the shared coordinate space sharing status.
+
+ - Parameters:
+ - context: The application-defined context.
+ - is_sharing_enabled: Whether coordinate space sharing is enabled.
+*/
+API_AVAILABLE(visionos(26.0))
+typedef void (^ar_shared_coordinate_space_sharing_status_update_handler_function_t)(void *_Nullable context,
+ bool is_sharing_enabled) AR_REFINED_FOR_SWIFT;
+
+#pragma mark - Shared coordinate space data
+
+/**
+ Copy the list of participant identifiers of the intended recipient for this data. Data should be broadcast if the list is empty.
+
+ - Parameter shared_coordinate_space_data: Shared coordinate space data.
+
+ - Returns: List the participant identifiers to which the data should be sent. Data should be broadcast to all participants if the list is empty.
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+*/
+API_DEPRECATED_WITH_REPLACEMENT("ar_coordinate_space_data_copy_recipient_identifiers", visionos(26.0, 27.0))
+AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_identifiers_t
+ar_coordinate_space_data_copy_recipient_identifers(ar_coordinate_space_data_t shared_coordinate_space_data) AR_REFINED_FOR_SWIFT;
+
+/**
+ Copy the list of participant identifiers of the intended recipient for this data. Data should be broadcast if the list is empty.
+
+ - Parameter shared_coordinate_space_data: Shared coordinate space data.
+
+ - Returns: List the participant identifiers to which the data should be sent. Data should be broadcast to all participants if the list is empty.
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+*/
+API_AVAILABLE(visionos(27.0))
+AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_identifiers_t
+ar_coordinate_space_data_copy_recipient_identifiers(ar_coordinate_space_data_t shared_coordinate_space_data) AR_REFINED_FOR_SWIFT;
+
+/**
+ Create and initialize an `ar_coordinate_space_data_t` object from a `CFDataRef`.
+
+ - Parameter cfData: The `CFDataRef` object to set for the `ar_coordinate_space_data_t`.
+
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_coordinate_space_data_t`.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN AR_OBJECT_RETURNS_RETAINED _Nullable ar_coordinate_space_data_t
+ar_coordinate_space_data_create_from_cfdata(CFDataRef cfData) AR_REFINED_FOR_SWIFT;
+
+/**
+ Copy out a `CFDataRef` that archives the coordinate space data.
+
+ - Parameter data: Coordinate space data.
+
+ - Returns: The `CFDataRef`. The caller is responsible for calling `CFRelease` on the returned pointer.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN CF_RETURNS_RETAINED CFDataRef ar_coordinate_space_data_copy_cfdata(ar_coordinate_space_data_t data) AR_REFINED_FOR_SWIFT;
+
+#pragma mark - Shared Coordinate Space Configuration
+
+/**
+ Create a shared coordinate space configuration.
+
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_shared_coordinate_space_configuration_t`.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_shared_coordinate_space_configuration_t ar_shared_coordinate_space_configuration_create(void)
+ AR_REFINED_FOR_SWIFT;
+
+#pragma mark - Shared Coordinate Space Provider
+/**
+ Create a shared coordinate space provider.
+
+ - Parameter shared_coordinate_space_configuration: shared coordinate space configuration.
+
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_shared_coordinate_space_provider_t`.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_shared_coordinate_space_provider_t
+ar_shared_coordinate_space_provider_create(ar_shared_coordinate_space_configuration_t shared_coordinate_space_configuration) AR_REFINED_FOR_SWIFT;
+
+/**
+ Get the identifier used to identify the participant in the shared coordinate space.
+
+ - Parameters:
+ - shared_coordinate_space_provider: Shared coordinate space provider.
+ - out_identifier: A pointer to a UUID to fill out with the identifier of the participant. Must be non-null.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void ar_shared_coordinate_space_provider_get_participant_identifier(ar_shared_coordinate_space_provider_t shared_coordinate_space_provider,
+ uuid_t _Nonnull out_identifier) AR_REFINED_FOR_SWIFT;
+
+/**
+ Get the latest sharing status.
+
+ - Parameter shared_coordinate_space_provider: Shared coordinate space provider.
+
+ - Returns: `true` if coordinate space sharing is enabled, `false` otherwise.
+*/
+API_AVAILABLE(visionos(26.4))
+AR_EXTERN bool
+ar_shared_coordinate_space_provider_is_sharing_enabled(ar_shared_coordinate_space_provider_t shared_coordinate_space_provider) AR_REFINED_FOR_SWIFT;
+
+/**
+ Push data to the shared coordinate space provider.
+
+ - Parameters:
+ - shared_coordinate_space_provider: The shared coordinate space provider.
+ - coordinate_space_data: Coordinate space data.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void ar_shared_coordinate_space_provider_push_data(ar_shared_coordinate_space_provider_t shared_coordinate_space_provider,
+ ar_coordinate_space_data_t coordinate_space_data) AR_REFINED_FOR_SWIFT;
+
+/**
+ Determines whether this device supports the shared coordinate space provider.
+
+ - Returns: Returns `true` if provider is supported on this device, `false` otherwise.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN bool ar_shared_coordinate_space_provider_is_supported(void) AR_REFINED_FOR_SWIFT;
+
+/**
+ Copy the next collaboration data.
+
+ - Parameter shared_coordinate_space_provider: The shared coordinate space provider.
+
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: Coordinate space data if available, `nil` otherwise.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_coordinate_space_data_t _Nullable ar_shared_coordinate_space_provider_copy_next_coordinate_space_data(
+ ar_shared_coordinate_space_provider_t shared_coordinate_space_provider) AR_REFINED_FOR_SWIFT;
+
+#ifdef __BLOCKS__
+/**
+ Set the handler for receiving shared coordinate space connected participants updates.
+
+ - Parameters:
+ - shared_coordinate_space_provider: The shared coordinate space provider.
+ - connected_participants_update_queue: The queue on which the handler will be called. Passing `NULL` will default to the main queue.
+ - connected_participants_update_handler: The handler to be called when there is an update to shared coordinate space connected participants.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void ar_shared_coordinate_space_provider_set_connected_participants_update_handler(
+ ar_shared_coordinate_space_provider_t shared_coordinate_space_provider,
+ dispatch_queue_t _Nullable connected_participants_update_queue,
+ ar_shared_coordinate_space_connected_participants_update_handler_t _Nullable connected_participants_update_handler) AR_REFINED_FOR_SWIFT;
+#endif // __BLOCKS__
+
+/**
+ Set the function for receiving shared coordinate space connected participants updates.
+
+ - Parameters:
+ - shared_coordinate_space_provider: Shared coordinate space provider.
+ - connected_participants_update_queue: Queue on which the function will be executed. Defaults to main queue when NULL is passed in.
+ - context: The application-defined context parameter to pass to the function.
+ - connected_participants_update_handler_function: Function to be called when there is an update to shared coordinate space connected
+ participants. Refer to `ar_shared_coordinate_space_connected_participants_update_handler_function_t` for function signature.
+
+ - Note: Setting this function will override the handler set using `ar_shared_coordinate_space_provider_set_connected_participants_update_handler`.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void ar_shared_coordinate_provider_set_connected_participants_update_handler_f(
+ ar_shared_coordinate_space_provider_t shared_coordinate_space_provider,
+ dispatch_queue_t _Nullable connected_participants_update_queue,
+ void *_Nullable context,
+ ar_shared_coordinate_space_connected_participants_update_handler_function_t _Nullable connected_participants_update_handler_function)
+ AR_REFINED_FOR_SWIFT;
+
+/**
+ Set the handler for receiving sharing status updates.
+
+ Set the sharing status update handler to be informed when the provider starts producing data and when the user can push data.
+
+ - Parameters:
+ - shared_coordinate_space_provider: The shared coordinate space provider.
+ - status_updates_queue: The queue on which the handler will be called. Passing `NULL` will default to the main queue.
+ - sharing_status_update_handler: The handler to be called when there is an update to shared coordinate space sharing status.
+
+ - Note: Setting this function will override the handler set using `ar_shared_coordinate_space_provider_set_sharing_status_update_handler_f`.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void ar_shared_coordinate_space_provider_set_sharing_status_update_handler(
+ ar_shared_coordinate_space_provider_t shared_coordinate_space_provider,
+ dispatch_queue_t _Nullable status_updates_queue,
+ ar_shared_coordinate_space_sharing_status_update_handler_t _Nullable sharing_status_update_handler) AR_REFINED_FOR_SWIFT;
+
+/**
+ Set the function for receiving sharing status updates.
+
+ Set the sharing status update handler to be informed when the provider starts producing data and when the user can push data.
+
+ - Parameters:
+ - shared_coordinate_space_provider: The shared coordinate space provider.
+ - status_updates_queue: The queue on which the handler will be called. Passing `NULL` will default to the main queue.
+ - context: The application-defined context parameter to pass to the function.
+ - sharing_status_update_handler_function: The handler to be called when there is an update to shared coordinate space sharing status.
+
+ - Note: Setting this function will override the handler set using `ar_shared_coordinate_space_provider_set_sharing_status_update_handler`.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN void ar_shared_coordinate_space_provider_set_sharing_status_update_handler_f(
+ ar_shared_coordinate_space_provider_t shared_coordinate_space_provider,
+ dispatch_queue_t _Nullable status_updates_queue,
+ void *_Nullable context,
+ ar_shared_coordinate_space_sharing_status_update_handler_function_t _Nullable sharing_status_update_handler_function) AR_REFINED_FOR_SWIFT;
+
+/**
+ Get the authorization type required by the shared coordinate space provider.
+
+ - Returns: An authorization type.
+*/
+API_AVAILABLE(visionos(26.0))
+AR_EXTERN ar_authorization_type_t ar_shared_coordinate_space_provider_get_required_authorization_type(void) AR_REFINED_FOR_SWIFT;
+
+API_UNAVAILABLE_END; // macCatalyst
+API_UNAVAILABLE_END; // macos
+
+AR_ASSUME_NONNULL_END
+
+#endif /* shared_coordinate_space_h */
+#else
+#import <ARKitCore/shared_coordinate_space.h>
+#endif // #if (defined(USE_ARKIT_PUBLIC_HEADERS) \&\& USE_ARKIT_PUBLIC_HEADERS) || !__has_include(<ARKitCore/shared_coordinate_space.h>)
\ No newline at end of file
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/skeleton_joint.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/skeleton_joint.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/skeleton_joint.h 2026-04-19 01:08:32
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/skeleton_joint.h 2026-05-22 07:32:10
@@ -11,83 +11,129 @@
#define skeleton_joint_h
#import <ARKit/object.h>
+#import <ARKit/transform_correction.h>
#import <os/availability.h>
#import <simd/types.h>
AR_ASSUME_NONNULL_BEGIN
-API_UNAVAILABLE_BEGIN(macos);
-
+/**
+ Represents a joint in a skeleton with its transform and tracking state.
+ */
AR_OBJECT_DECL(ar_skeleton_joint)
AR_REFINED_FOR_SWIFT
-API_AVAILABLE(visionos(1.0));
+API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst);
/**
Returns a bool value that indicates whether the two skeleton joints are equal.
- @param skeleton_joint A skeleton joint to be compared.
- @param other_skeleton_joint The other skeleton joint to be compared to.
+ - Parameters:
+ - skeleton_joint: A skeleton joint to be compared.
+ - other_skeleton_joint: The other skeleton joint to be compared to.
- @return YES if the skeleton joints are equal, otherwise NO.
- */
+ - Returns: `YES` if the skeleton joints are equal, otherwise `NO`.
+*/
API_AVAILABLE(visionos(2.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN bool ar_skeleton_joint_is_equal_to_skeleton_joint(ar_skeleton_joint_t _Nullable skeleton_joint,
ar_skeleton_joint_t _Nullable other_skeleton_joint) AR_REFINED_FOR_SWIFT;
/**
Get a joint's index.
- @param joint The joint.
+ - Parameter joint: The joint.
- @return The index of the joint.
- */
+ - Returns: The index of the joint.
+*/
API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN uint64_t ar_skeleton_joint_get_index(ar_skeleton_joint_t joint) AR_REFINED_FOR_SWIFT;
/**
Get a joint's parent joint.
- @param joint the joint.
+ - Parameter joint: The joint.
- @return Parent joint. This function will return null for the root node.
- */
+ - Returns: Parent joint. This function will return `null` for the root node.
+*/
API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN ar_skeleton_joint_t _Nullable ar_skeleton_joint_get_parent(ar_skeleton_joint_t joint) AR_REFINED_FOR_SWIFT;
/**
Get the transform from the joint to its parent joint's coordinate system.
- @param joint The joint.
+ - Parameter joint: The joint.
- @note For a hand skeleton, the root of all these transforms starts at the wrist, then the next joint out (metacarpals and forearm) are relative to
+ - Note: For a hand skeleton, the root of all these transforms starts at the wrist, then the next joint out (metacarpals and forearm) are relative to
the wrist, then all knuckles are relative to the metacarpals and so on until the finger tips.
+ - Note: This function will return a rendering-corrected transform and is equal to calling
+ `ar_skeleton_joint_get_parent_from_joint_transform_with_correction` with `ar_transform_correction_rendered`.
- @return The transform from the joint to its parent joint's coordinate system. This function will return an identity matrix when called for the root
- joint.
- */
-
+ - Returns: The transform from the joint to its parent joint's coordinate system. This function will return an identity matrix when called for the
+ root joint.
+*/
API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN simd_float4x4 ar_skeleton_joint_get_parent_from_joint_transform(ar_skeleton_joint_t joint) AR_REFINED_FOR_SWIFT;
/**
+ Get the transform from the joint to its parent joint's coordinate system.
+
+ - Parameters:
+ - joint: The joint.
+ - transform_correction: The transform correction that should be applied.
+
+ - Note: For a hand skeleton, the root of all these transforms starts at the wrist, then the next joint out (metacarpals and forearm) are relative to
+ the wrist, then all knuckles are relative to the metacarpals and so on until the finger tips.
+
+ - Returns: The transform from the joint to its parent joint's coordinate system. This function will return an identity matrix when called for the
+ root joint.
+*/
+API_AVAILABLE(visionos(27.0))
+API_UNAVAILABLE(macos, macCatalyst)
+AR_EXTERN simd_float4x4 ar_skeleton_joint_get_parent_from_joint_transform_with_correction(
+ ar_skeleton_joint_t joint, ar_transform_correction_t transform_correction) AR_REFINED_FOR_SWIFT;
+
+/**
Get the transform from the joint to the anchor's coordinate system.
- @param joint The joint.
+ - Parameter joint: The joint.
- @return The transform from the joint to the anchor's coordinate system.
- */
+ - Note: This function will return a rendering-corrected transform and is equal to calling
+ `ar_skeleton_joint_get_anchor_from_joint_transform_with_correction` with `ar_transform_correction_rendered`.
+
+ - Returns: The transform from the joint to the anchor's coordinate system.
+*/
API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN simd_float4x4 ar_skeleton_joint_get_anchor_from_joint_transform(ar_skeleton_joint_t joint) AR_REFINED_FOR_SWIFT;
/**
+ Get the transform from the joint to the anchor's coordinate system.
+
+ - Parameters:
+ - joint: The joint.
+ - transform_correction: The transform correction that should be applied.
+
+ - Returns: The transform from the joint to the anchor's coordinate system.
+*/
+API_AVAILABLE(visionos(27.0))
+API_UNAVAILABLE(macos, macCatalyst)
+AR_EXTERN simd_float4x4 ar_skeleton_joint_get_anchor_from_joint_transform_with_correction(
+ ar_skeleton_joint_t joint, ar_transform_correction_t transform_correction) AR_REFINED_FOR_SWIFT;
+
+/**
Determine whether a joint is tracked.
- @param joint The joint.
+ - Parameter joint: The joint.
- @return `true` if the joint is tracked, `false` otherwise.
- */
+ - Returns: `true` if the joint is tracked, `false` otherwise.
+*/
API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN bool ar_skeleton_joint_is_tracked(ar_skeleton_joint_t joint) AR_REFINED_FOR_SWIFT;
#ifdef __BLOCKS__
@@ -95,25 +141,27 @@
/**
Handler for enumerating skeleton joints.
- @param joint The joint.
+ - Parameter joint: The joint.
- @return `true` to continue enumerating to the next joint name, `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating to the next joint name, `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst)
typedef bool (^ar_skeleton_joint_enumerator_t)(ar_skeleton_joint_t joint) AR_REFINED_FOR_SWIFT;
#endif // __BLOCKS__
/**
Function for enumerating skeleton joints.
- @param context The application-defined context.
- @param joint The joint.
- @return `true` to continue enumerating to the next joint, `false` to stop enumerating.
- */
+ - Parameters:
+ - context: The application-defined context.
+ - joint: The joint.
+
+ - Returns: `true` to continue enumerating to the next joint, `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(1.0))
+API_UNAVAILABLE(macos, macCatalyst)
typedef bool (*ar_skeleton_joint_enumerator_function_t)(void *_Nullable context, ar_skeleton_joint_t joint) AR_REFINED_FOR_SWIFT;
-
-API_UNAVAILABLE_END; // macos
AR_ASSUME_NONNULL_END
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/stereo_properties.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/stereo_properties.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/stereo_properties.h 2026-04-18 22:53:34
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/stereo_properties.h 2026-06-01 00:37:41
@@ -19,15 +19,25 @@
AR_ASSUME_NONNULL_BEGIN
API_UNAVAILABLE_BEGIN(macos);
+API_UNAVAILABLE_BEGIN(macCatalyst);
+/**
+ Configuration for the stereo properties provider.
+ */
AR_OBJECT_DECL(ar_stereo_properties_configuration)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(2.4));
+/**
+ A data provider that provides stereo viewpoint properties.
+ */
AR_OBJECT_DECL_SUBCLASS(ar_stereo_properties_provider, ar_data_provider)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(2.4));
+/**
+ Properties describing the stereo viewpoints of the device.
+ */
AR_OBJECT_DECL(ar_viewpoint_properties)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(2.4));
@@ -37,18 +47,18 @@
/**
Create an `ar_viewpoint_properties_t`.
- @return A new `ar_viewpoint_properties_t`.
- */
+ - Returns: A new `ar_viewpoint_properties_t`.
+*/
API_AVAILABLE(visionos(2.4))
-AR_EXTERN ar_viewpoint_properties_t ar_viewpoint_properties_create(void) AR_REFINED_FOR_SWIFT;
+AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_viewpoint_properties_t ar_viewpoint_properties_create(void) AR_REFINED_FOR_SWIFT;
/**
Get the transformation matrix that converts from the left viewpoint to the device’s coordinate space.
- @param viewpoint_properties The viewpoint properties.
+ - Parameter viewpoint_properties: The viewpoint properties.
- @return The transform from the left viewpoint to the device origin.
- */
+ - Returns: The transform from the left viewpoint to the device origin.
+*/
API_AVAILABLE(visionos(2.4))
AR_EXTERN simd_float4x4 ar_viewpoint_properties_get_device_from_left_viewpoint_transform(ar_viewpoint_properties_t viewpoint_properties)
AR_REFINED_FOR_SWIFT;
@@ -56,10 +66,10 @@
/**
Get the transformation matrix that converts from the right viewpoint to the device’s coordinate space.
- @param viewpoint_properties The viewpoint properties.
+ - Parameter viewpoint_properties: The viewpoint properties.
- @return The transform from the right viewpoint to the device origin.
- */
+ - Returns: The transform from the right viewpoint to the device origin.
+*/
API_AVAILABLE(visionos(2.4))
AR_EXTERN simd_float4x4 ar_viewpoint_properties_get_device_from_right_viewpoint_transform(ar_viewpoint_properties_t viewpoint_properties)
AR_REFINED_FOR_SWIFT;
@@ -69,9 +79,10 @@
/**
Create a stereo properties configuration object.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_stereo_properties_configuration_t`.
- */
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_stereo_properties_configuration_t`.
+*/
API_AVAILABLE(visionos(2.4))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_stereo_properties_configuration_t ar_stereo_properties_configuration_create(void) AR_REFINED_FOR_SWIFT;
@@ -80,11 +91,12 @@
/**
Create a stereo properties provider.
- @param configuration The configuration for the stereo properties provider.
- @see `ar_session_t` to run this provider.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_stereo_properties_provider_t`.
- */
+ - Parameter configuration: The configuration for the stereo properties provider.
+
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_stereo_properties_provider_t`.
+*/
API_AVAILABLE(visionos(2.4))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_stereo_properties_provider_t
ar_stereo_properties_provider_create(ar_stereo_properties_configuration_t configuration) AR_REFINED_FOR_SWIFT;
@@ -92,30 +104,33 @@
/**
Determines whether this device supports the stereo properties provider.
- @return Returns `true` if the stereo properties provider is supported on this device, `false` otherwise.
- */
+ - Returns: Returns `true` if the stereo properties provider is supported on this device, `false` otherwise.
+*/
API_AVAILABLE(visionos(2.4))
AR_EXTERN bool ar_stereo_properties_provider_is_supported(void) AR_REFINED_FOR_SWIFT;
/**
Get the authorization type required by the stereo properties provider.
- @return Authorization type.
- */
+ - Returns: Authorization type.
+*/
API_AVAILABLE(visionos(2.4))
AR_EXTERN ar_authorization_type_t ar_stereo_properties_provider_get_required_authorization_type(void) AR_REFINED_FOR_SWIFT;
/**
Returns the latest viewpoint properties.
- @param stereo_properties_provider The stereo properties provider.
- @param[out] viewpoint_properties The viewpoint properties to fill out.
- @returns True, if the viewpoint properties were updated.
- */
+ - Parameters:
+ - stereo_properties_provider: The stereo properties provider.
+ - viewpoint_properties: The viewpoint properties to fill out.
+
+ - Returns: `true`, if the viewpoint properties were updated.
+*/
API_AVAILABLE(visionos(2.4))
AR_EXTERN bool ar_stereo_properties_provider_get_viewpoint_properties(ar_stereo_properties_provider_t stereo_properties_provider,
ar_viewpoint_properties_t viewpoint_properties) AR_REFINED_FOR_SWIFT;
+API_UNAVAILABLE_END; // macCatalyst
API_UNAVAILABLE_END; // macos
AR_ASSUME_NONNULL_END
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/strings_collection.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/strings_collection.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/strings_collection.h 2026-04-19 01:08:32
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/strings_collection.h 2026-05-22 07:32:10
@@ -17,19 +17,23 @@
#pragma mark - Strings Collection
+/**
+ A collection of strings.
+ */
AR_OBJECT_DECL(ar_strings)
AR_REFINED_FOR_SWIFT
-API_AVAILABLE(visionos(26.0), macos(26.0));
+API_AVAILABLE(visionos(26.0), macos(26.0), macCatalyst(16.0));
API_UNAVAILABLE_BEGIN(macos);
+API_UNAVAILABLE_BEGIN(macCatalyst);
/**
Returns the number of strings in this collection.
- @param strings The strings collection.
+ - Parameter strings: The strings collection.
- @return Count of strings in the collection.
- */
+ - Returns: Count of strings in the collection.
+*/
API_AVAILABLE(visionos(26.0))
AR_EXTERN size_t ar_strings_get_count(ar_strings_t strings) AR_REFINED_FOR_SWIFT;
@@ -38,19 +42,20 @@
/**
Handler for enumerating a collection of strings.
- @param string An UTF-8 encoded string representation.
+ - Parameter string: An UTF-8 encoded string representation.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(26.0))
typedef bool (^ar_strings_enumerator_t)(const char *string) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of strings.
- @param strings Strings collection.
- @param strings_enumerator The enumerator handler.
- */
+ - Parameters:
+ - strings: Strings collection.
+ - strings_enumerator: The enumerator handler.
+*/
API_AVAILABLE(visionos(26.0))
AR_EXTERN void ar_strings_enumerate_strings(ar_strings_t strings, ar_strings_enumerator_t strings_enumerator) AR_REFINED_FOR_SWIFT;
@@ -59,26 +64,29 @@
/**
Function for enumerating a collection of strings.
- @param context The application-defined context.
- @param string An UTF-8 encoded string representation.
+ - Parameters:
+ - context: The application-defined context.
+ - string: An UTF-8 encoded string representation.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(26.0))
typedef bool (*ar_strings_enumerator_function_t)(void *_Nullable context, const char *string) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of strings using a function.
- @param strings Strings collection.
- @param context The application-defined context parameter to pass to the function.
- @param strings_enumerator_function The enumerator handler.
- */
+ - Parameters:
+ - strings: Strings collection.
+ - context: The application-defined context parameter to pass to the function.
+ - strings_enumerator_function: The enumerator handler.
+*/
API_AVAILABLE(visionos(26.0))
AR_EXTERN void ar_strings_enumerate_strings_f(ar_strings_t strings,
void *_Nullable context,
ar_strings_enumerator_function_t strings_enumerator_function) AR_REFINED_FOR_SWIFT;
+API_UNAVAILABLE_END; // macCatalyst
API_UNAVAILABLE_END; // macos
AR_ASSUME_NONNULL_END
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/transform_correction.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/transform_correction.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/transform_correction.h 1969-12-31 19:00:00
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/transform_correction.h 2026-05-22 07:32:10
@@ -0,0 +1,29 @@
+#if (defined(USE_ARKIT_PUBLIC_HEADERS) && USE_ARKIT_PUBLIC_HEADERS) || !__has_include(<ARKitCore/transform_correction.h>)
+//
+// transform_correction.h
+// ARKit
+//
+// Copyright © 2025 Apple Inc. All rights reserved.
+//
+
+#ifndef transform_correction_h
+#define transform_correction_h
+
+#import <ARKit/object.h>
+
+/**
+ A correction type to apply for transforms returned from ARKit APIs.
+ */
+API_AVAILABLE(visionos(26.0), macos(26.0), macCatalyst(16.0))
+OS_ENUM(ar_transform_correction,
+ intptr_t,
+ /// Transforms are unaltered and represent actual locations.
+ ar_transform_correction_none = 0,
+ /// Transforms are corrected to render over physical objects in passthrough displays.
+ ar_transform_correction_rendered)
+AR_REFINED_FOR_SWIFT;
+
+#endif // transform_correction_h
+#else
+#import <ARKitCore/transform_correction.h>
+#endif // #if (defined(USE_ARKIT_PUBLIC_HEADERS) \&\& USE_ARKIT_PUBLIC_HEADERS) || !__has_include(<ARKitCore/transform_correction.h>)
\ No newline at end of file
diff -ruN /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/world_tracking.h /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/world_tracking.h
--- /Applications/Xcode_26.5.0.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/world_tracking.h 2026-04-19 01:08:31
+++ /Applications/Xcode_27.0.0-beta.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/ARKit.framework/Headers/world_tracking.h 2026-05-22 07:32:10
@@ -13,6 +13,7 @@
#import <ARKit/data_provider.h>
#import <ARKit/object.h>
#import <ARKit/session.h>
+#import <ARKit/transform_correction.h>
#import <dispatch/dispatch.h>
#import <os/availability.h>
@@ -21,49 +22,63 @@
AR_ASSUME_NONNULL_BEGIN
+/**
+ An anchor that can be placed at a location in the real world.
+ */
AR_OBJECT_DECL_SUBCLASS(ar_world_anchor, ar_trackable_anchor)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(1.0))
API_UNAVAILABLE(macos);
+/**
+ A collection of world anchors.
+ */
AR_OBJECT_DECL(ar_world_anchors)
AR_REFINED_FOR_SWIFT
API_AVAILABLE(visionos(1.0))
API_UNAVAILABLE(macos);
+/**
+ Configuration for world tracking.
+ */
AR_OBJECT_DECL(ar_world_tracking_configuration)
AR_REFINED_FOR_SWIFT
-API_AVAILABLE(visionos(1.0), macos(26.0));
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0));
+/**
+ A data provider for world tracking.
+ */
AR_OBJECT_DECL_SUBCLASS(ar_world_tracking_provider, ar_data_provider)
AR_REFINED_FOR_SWIFT
-API_AVAILABLE(visionos(1.0), macos(26.0));
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0));
#pragma mark - World Anchor
/**
Returns a bool value that indicates whether the two world anchors are equal.
- @param anchor A world anchor to be compared.
- @param other_anchor The other world anchor to be compared to.
+ - Parameters:
+ - anchor: A world anchor to be compared.
+ - other_anchor: The other world anchor to be compared to.
- @return YES if the world anchors are equal, otherwise NO.
- */
+ - Returns: `YES` if the world anchors are equal, otherwise `NO`.
+*/
API_AVAILABLE(visionos(2.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN bool ar_world_anchor_is_equal_to_world_anchor(ar_world_anchor_t _Nullable anchor,
ar_world_anchor_t _Nullable other_anchor) AR_REFINED_FOR_SWIFT;
/**
Create a world anchor initialized with a transform from the anchor to the origin coordinate system.
- @param origin_from_anchor_transform The origin from anchor transform.
+ - Parameter origin_from_anchor_transform: The origin from anchor transform.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_world_anchor_t`.
- */
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_world_anchor_t`.
+*/
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_world_anchor_t
ar_world_anchor_create_with_origin_from_anchor_transform(simd_float4x4 origin_from_anchor_transform) AR_REFINED_FOR_SWIFT;
@@ -72,44 +87,59 @@
/**
Get the identifier of an anchor.
- @param[in] anchor The anchor.
- @param[out] out_identifier A pointer to a UUID to fill out with the anchor identifier. Must be non-null.
- */
+ - Parameters:
+ - anchor: The anchor.
+ - out_identifier: A pointer to a UUID to fill out with the anchor identifier. Must be non-null.
+*/
API_AVAILABLE(visionos(2.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN void ar_world_anchor_get_identifier(ar_world_anchor_t anchor, uuid_t _Nonnull out_identifier) AR_REFINED_FOR_SWIFT;
/**
Get the transform from an anchor to the origin coordinate system.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return The origin from anchor transform.
- */
+ - Returns: The origin from anchor transform.
+*/
API_AVAILABLE(visionos(2.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN simd_float4x4 ar_world_anchor_get_origin_from_anchor_transform(ar_world_anchor_t anchor) AR_REFINED_FOR_SWIFT;
/**
+ Get the transform from an anchor to the origin coordinate system.
+
+ - Parameters:
+ - anchor: The anchor.
+ - transform_correction: The transform correction that should be applied.
+
+ - Returns: The origin from anchor transform.
+*/
+API_AVAILABLE(visionos(27.0))
+API_UNAVAILABLE(macos, macCatalyst)
+AR_EXTERN simd_float4x4 ar_world_anchor_get_origin_from_anchor_transform_with_correction(
+ ar_world_anchor_t anchor, ar_transform_correction_t transform_correction) AR_REFINED_FOR_SWIFT;
+
+/**
Get the timestamp corresponding to an anchor.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return The timestamp associated with the anchor.
- */
+ - Returns: The timestamp associated with the anchor.
+*/
API_AVAILABLE(visionos(2.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN CFTimeInterval ar_world_anchor_get_timestamp(ar_world_anchor_t anchor) AR_REFINED_FOR_SWIFT;
/**
Determine whether an anchor is tracked.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return `true` if the anchor is tracked, `false` otherwise.
- */
+ - Returns: `true` if the anchor is tracked, `false` otherwise.
+*/
API_AVAILABLE(visionos(2.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN bool ar_world_anchor_is_tracked(ar_world_anchor_t anchor) AR_REFINED_FOR_SWIFT;
#pragma mark - World Anchors Collection
@@ -117,34 +147,35 @@
/**
Get the count of world anchors in a collection.
- @param world_anchors The collection of world anchors.
+ - Parameter world_anchors: The collection of world anchors.
- @return The number of world anchors in the collection.
- */
+ - Returns: The number of world anchors in the collection.
+*/
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN size_t ar_world_anchors_get_count(ar_world_anchors_t world_anchors) AR_REFINED_FOR_SWIFT;
#ifdef __BLOCKS__
/**
Handler for enumerating a collection of world anchors.
- @param world_anchor The world anchor.
+ - Parameter world_anchor: The world anchor.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
typedef bool (^ar_world_anchors_enumerator_t)(ar_world_anchor_t world_anchor) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of world anchors.
- @param world_anchors The collection of world anchors.
- @param world_anchors_enumerator The enumerator handler.
- */
+ - Parameters:
+ - world_anchors: The collection of world anchors.
+ - world_anchors_enumerator: The enumerator handler.
+*/
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN void ar_world_anchors_enumerate_anchors(ar_world_anchors_t world_anchors,
ar_world_anchors_enumerator_t world_anchors_enumerator) AR_REFINED_FOR_SWIFT;
#endif // __BLOCKS__
@@ -152,24 +183,26 @@
/**
Function for enumerating a collection of world anchors.
- @param context The application-defined context.
- @param world_anchor The world anchor.
+ - Parameters:
+ - context: The application-defined context.
+ - world_anchor: The world anchor.
- @return `true` to continue enumerating, or `false` to stop enumerating.
- */
+ - Returns: `true` to continue enumerating, or `false` to stop enumerating.
+*/
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
typedef bool (*ar_world_anchors_enumerator_function_t)(void *_Nullable context, ar_world_anchor_t world_anchor) AR_REFINED_FOR_SWIFT;
/**
Enumerate a collection of world anchors using a function.
- @param world_anchors The collection of world anchors.
- @param context The application-defined context parameter to pass to the function.
- @param world_anchors_enumerator_function The enumerator function.
- */
+ - Parameters:
+ - world_anchors: The collection of world anchors.
+ - context: The application-defined context parameter to pass to the function.
+ - world_anchors_enumerator_function: The enumerator function.
+*/
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN void ar_world_anchors_enumerate_anchors_f(ar_world_anchors_t world_anchors,
void *_Nullable context,
ar_world_anchors_enumerator_function_t world_anchors_enumerator_function) AR_REFINED_FOR_SWIFT;
@@ -179,10 +212,11 @@
/**
Create a world tracking configuration.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_world_tracking_configuration_t`.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_world_tracking_configuration_t`.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_world_tracking_configuration_t ar_world_tracking_configuration_create(void) AR_REFINED_FOR_SWIFT;
#pragma mark - World Tracking Provider
@@ -190,39 +224,43 @@
/**
Create a world tracking provider.
- @param world_tracking_configuration The configuration for world tracking.
+ - Parameter world_tracking_configuration: The configuration for world tracking.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_world_tracking_provider_t`.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_world_tracking_provider_t`.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_world_tracking_provider_t
ar_world_tracking_provider_create(ar_world_tracking_configuration_t world_tracking_configuration) AR_REFINED_FOR_SWIFT;
/**
Function called when a request to copy all known world anchors has completed (successfully or not).
- @param all_anchors The nullable collection of known world anchors. Passes null if data provider is not running and for other errors.
+ - Parameters:
+ - context: The application-defined context.
+ - all_anchors: The nullable collection of known world anchors. Passes `null` if data provider is not running and for other errors.
- @note The results will be accurate at the time of callback, but not necessarily at the time of the request.
- @note The returned anchors support ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the anchors.
- */
+ - Note: The results will be accurate at the time of callback, but not necessarily at the time of the request.
+ - Note: The returned anchors support ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the anchors.
+*/
API_AVAILABLE(visionos(2.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
typedef void (*ar_world_tracking_provider_copy_all_world_anchors_completion_function_t)(
void *_Nullable context, ar_world_anchors_t _Nullable all_anchors) AR_REFINED_FOR_SWIFT;
/**
Copies all known world anchors from the world tracking provider asynchronously.
- @param world_tracking_provider The world tracking provider.
- @param context The application-defined context parameter to pass to the function.
- @param copy_all_anchors_completion_handler_function The function to be called with the result of the request for all known world anchors.
+ - Parameters:
+ - world_tracking_provider: The world tracking provider.
+ - context: The application-defined context parameter to pass to the function.
+ - copy_all_anchors_completion_handler_function: The function to be called with the result of the request for all known world anchors.
- @note This is not a blocking call. It will return all anchors that have been added successfully before the completion handler is called.
- */
+ - Note: This is not a blocking call. It will return all anchors that have been added successfully before the completion handler is called.
+*/
API_AVAILABLE(visionos(2.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN void ar_world_tracking_provider_copy_all_world_anchors_f(
ar_world_tracking_provider_t world_tracking_provider,
void *_Nullable context,
@@ -231,27 +269,28 @@
#ifdef __BLOCKS__
/**
- Handler called when a request to copy all known world anchors has completed (successfully or not).
+ A handler that the provider calls when a request to copy all known world anchors has completed (successfully or not).
- @param all_anchors The nullable collection of known world anchors. Passes null if data provider is not running and for other errors.
+ - Parameter all_anchors: The nullable collection of known world anchors. Passes `null` if data provider is not running and for other errors.
- @note The results will be accurate at the time of callback, but not necessarily at the time of the request.
- @note The returned anchors support ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the anchors.
- */
+ - Note: The results will be accurate at the time of callback, but not necessarily at the time of the request.
+ - Note: The returned anchors support ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the anchors.
+*/
API_AVAILABLE(visionos(2.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
typedef void (^ar_world_tracking_provider_copy_all_world_anchors_completion_handler_t)(ar_world_anchors_t _Nullable all_anchors) AR_REFINED_FOR_SWIFT;
/**
Copies all known world anchors from the world tracking provider asynchronously.
- @param world_tracking_provider The world tracking provider.
- @param copy_all_anchors_completion_handler The handler to be called with the result of the request for all known world anchors.
+ - Parameters:
+ - world_tracking_provider: The world tracking provider.
+ - copy_all_anchors_completion_handler: The handler to be called with the result of the request for all known world anchors.
- @note This is not a blocking call. It will return all anchors that have been added successfully before the completion handler is called.
- */
+ - Note: This is not a blocking call. It will return all anchors that have been added successfully before the completion handler is called.
+*/
API_AVAILABLE(visionos(2.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN void ar_world_tracking_provider_copy_all_world_anchors(
ar_world_tracking_provider_t world_tracking_provider,
ar_world_tracking_provider_copy_all_world_anchors_completion_handler_t copy_all_anchors_completion_handler) AR_REFINED_FOR_SWIFT;
@@ -259,18 +298,20 @@
#ifdef __BLOCKS__
/**
- Handler called when there are updates to world anchors. This includes updates to persisted world anchors from previous runs of the app.
+ A handler that the provider calls when there are updates to world anchors. This includes updates to persisted world anchors from previous runs of the
+ app.
- @param added_anchors The collection of world anchors that were added.
- @param updated_anchors The collection of world anchors that were updated.
- @param removed_anchors The collection of world anchors that were removed.
+ - Parameters:
+ - added_anchors: The collection of world anchors that were added.
+ - updated_anchors: The collection of world anchors that were updated.
+ - removed_anchors: The collection of world anchors that were removed.
- @note This handler will also be called for persisted world anchors from previous runs of the app, after the world tracking provider has been started.
- World anchors persist across device restarts until they are explicitly removed. Identify the anchors you want to react to using
+ - Note: This handler will also be called for persisted world anchors from previous runs of the app, after the world tracking provider has been
+ started. World anchors persist across device restarts until they are explicitly removed. Identify the anchors you want to react to using
`ar_anchor_get_identifier`.
- */
+*/
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
typedef void (^ar_world_tracking_anchor_update_handler_t)(ar_world_anchors_t added_anchors,
ar_world_anchors_t updated_anchors,
ar_world_anchors_t removed_anchors) AR_REFINED_FOR_SWIFT;
@@ -278,14 +319,15 @@
/**
Set the handler for receiving world tracking anchor updates.
- @param world_tracking_provider The world tracking provider.
- @param world_tracking_updates_queue The queue on which the handler will be called. Passing NULL will default to the main queue.
- @param world_tracking_anchor_update_handler The handler to be called when new world anchor data arrives.
+ - Parameters:
+ - world_tracking_provider: The world tracking provider.
+ - world_tracking_updates_queue: The queue on which the handler will be called. Passing `NULL` will default to the main queue.
+ - world_tracking_anchor_update_handler: The handler to be called when new world anchor data arrives.
- @note Setting this handler will override the function set using `ar_world_tracking_provider_set_anchor_update_handler_f`.
- */
+ - Note: Setting this handler will override the function set using `ar_world_tracking_provider_set_anchor_update_handler_f`.
+*/
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN void ar_world_tracking_provider_set_anchor_update_handler(
ar_world_tracking_provider_t world_tracking_provider,
dispatch_queue_t _Nullable world_tracking_updates_queue,
@@ -295,17 +337,18 @@
/**
Function called when there are updates to world anchors. This includes updates to persisted world anchors from previous runs of the app.
- @param context The application-defined context.
- @param added_anchors The collection of world anchors that were added.
- @param updated_anchors The collection of world anchors that were updated.
- @param removed_anchors The collection of world anchors that were removed.
+ - Parameters:
+ - context: The application-defined context.
+ - added_anchors: The collection of world anchors that were added.
+ - updated_anchors: The collection of world anchors that were updated.
+ - removed_anchors: The collection of world anchors that were removed.
- @note This function will also be called for persisted world anchors from previous runs of the app, after the world tracking provider has been
+ - Note: This function will also be called for persisted world anchors from previous runs of the app, after the world tracking provider has been
started. World anchors persist across device restarts until they are explicitly removed. Identify the anchors you want to react to using
`ar_anchor_get_identifier`.
- */
+*/
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
typedef void (*ar_world_tracking_anchor_update_handler_function_t)(void *_Nullable context,
ar_world_anchors_t added_anchors,
ar_world_anchors_t updated_anchors,
@@ -314,23 +357,27 @@
/**
Set the function for receiving world tracking anchor updates.
- @param world_tracking_provider The world tracking provider.
- @param world_tracking_updates_queue The queue on which the function will be called. Passing NULL will default to the main queue.
- @param context The application-defined context parameter to pass to the function.
- @param world_tracking_anchor_update_handler_function The function to be called when new world anchor data arrives.
+ - Parameters:
+ - world_tracking_provider: The world tracking provider.
+ - world_tracking_updates_queue: The queue on which the function will be called. Passing `NULL` will default to the main queue.
+ - context: The application-defined context parameter to pass to the function.
+ - world_tracking_anchor_update_handler_function: The function to be called when new world anchor data arrives.
- @note Setting this function will override the handler set using `ar_world_tracking_provider_set_anchor_update_handler`.
- */
+ - Note: Setting this function will override the handler set using `ar_world_tracking_provider_set_anchor_update_handler`.
+*/
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN void ar_world_tracking_provider_set_anchor_update_handler_f(
ar_world_tracking_provider_t world_tracking_provider,
dispatch_queue_t _Nullable world_tracking_updates_queue,
void *_Nullable context,
ar_world_tracking_anchor_update_handler_function_t _Nullable world_tracking_anchor_update_handler_function) AR_REFINED_FOR_SWIFT;
+/**
+ Error codes specific to world tracking.
+ */
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
OS_ENUM(ar_world_tracking_error_code, ar_error_code_t,
/// Error code indicating that a world anchor failed to be added.
ar_world_tracking_error_code_add_anchor_failed = 200,
@@ -343,21 +390,22 @@
/**
Determine whether this device supports the world tracking provider.
- @return `true` if the world tracking provider is supported on this device, `false` otherwise.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Returns: `true` if the world tracking provider is supported on this device, `false` otherwise.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN bool ar_world_tracking_provider_is_supported(void) AR_REFINED_FOR_SWIFT;
#ifdef __BLOCKS__
/**
- Handler called when a request to add a world anchor has completed (successfully or not).
+ A handler that the provider calls when a request to add a world anchor has completed (successfully or not).
- @param world_anchor The world anchor to be added to the world tracking provider.
- @param successful `true` if the world anchor was successfully added to the world tracking provider, `false` otherwise.
- @param error The error that occurred, if any. The returned error supports ARC. In non-ARC files, use `ar_release()` to release the error.
- */
+ - Parameters:
+ - world_anchor: The world anchor to be added to the world tracking provider.
+ - successful: `true` if the world anchor was successfully added to the world tracking provider, `false` otherwise.
+ - error: The error that occurred, if any.
+*/
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
typedef void (^ar_world_tracking_add_anchor_completion_handler_t)(ar_world_anchor_t world_anchor,
bool successful,
ar_error_t _Nullable error) AR_REFINED_FOR_SWIFT;
@@ -365,12 +413,13 @@
/**
Add a world anchor to the world tracking provider. This anchor will be persisted across device restarts unless explicitly removed.
- @param world_tracking_provider The world tracking provider.
- @param world_anchor The world anchor to add.
- @param add_anchor_completion_handler The handler to be called after the request to add the world anchor to the world tracking provider completes.
- */
+ - Parameters:
+ - world_tracking_provider: The world tracking provider.
+ - world_anchor: The world anchor to add.
+ - add_anchor_completion_handler: The handler to be called after the request to add the world anchor to the world tracking provider completes.
+*/
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN void
ar_world_tracking_provider_add_anchor(ar_world_tracking_provider_t world_tracking_provider,
ar_world_anchor_t world_anchor,
@@ -380,13 +429,14 @@
/**
Function called when a request to add a world anchor has completed (successfully or not).
- @param context The application-defined context.
- @param world_anchor The world anchor to be added to the world tracking provider.
- @param successful `true` if the world anchor was successfully added to the world tracking provider, `false` otherwise.
- @param error The error that occurred, if any. The returned error supports ARC. In non-ARC files, use `ar_release()` to release the error.
- */
+ - Parameters:
+ - context: The application-defined context.
+ - world_anchor: The world anchor to be added to the world tracking provider.
+ - successful: `true` if the world anchor was successfully added to the world tracking provider, `false` otherwise.
+ - error: The error that occurred, if any.
+*/
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
typedef void (*ar_world_tracking_add_anchor_completion_handler_function_t)(void *_Nullable context,
ar_world_anchor_t world_anchor,
bool successful,
@@ -395,14 +445,15 @@
/**
Add a world anchor to the world tracking provider. This anchor will be persisted across device restarts unless explicitly removed.
- @param world_tracking_provider The world tracking provider.
- @param world_anchor The world anchor to add.
- @param context The application-defined context parameter to pass to the function.
- @param add_anchor_completion_handler_function The function to be called after the request to add the world anchor to the world tracking provider
+ - Parameters:
+ - world_tracking_provider: The world tracking provider.
+ - world_anchor: The world anchor to add.
+ - context: The application-defined context parameter to pass to the function.
+ - add_anchor_completion_handler_function: The function to be called after the request to add the world anchor to the world tracking provider
completes.
- */
+*/
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN void ar_world_tracking_provider_add_anchor_f(
ar_world_tracking_provider_t world_tracking_provider,
ar_world_anchor_t world_anchor,
@@ -411,14 +462,15 @@
#ifdef __BLOCKS__
/**
- Handler called when a request to remove a world anchor has completed (successfully or not).
+ A handler that the provider calls when a request to remove a world anchor has completed (successfully or not).
- @param world_anchor The world anchor to be removed from the world tracking provider.
- @param successful `true` if the world anchor was successfully removed from the world tracking provider, `false` otherwise.
- @param error The error that occurred, if any. The returned error supports ARC. In non-ARC files, use `ar_release()` to release the error.
- */
+ - Parameters:
+ - world_anchor: The world anchor to be removed from the world tracking provider.
+ - successful: `true` if the world anchor was successfully removed from the world tracking provider, `false` otherwise.
+ - error: The error that occurred, if any.
+*/
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
typedef void (^ar_world_tracking_remove_anchor_completion_handler_t)(ar_world_anchor_t world_anchor,
bool successful,
ar_error_t _Nullable error) AR_REFINED_FOR_SWIFT;
@@ -426,13 +478,14 @@
/**
Remove a world anchor from the world tracking provider.
- @param world_tracking_provider The world tracking provider.
- @param world_anchor The world anchor to remove.
- @param remove_anchor_completion_handler The handler to be called after the request to remove the world anchor from the world tracking provider
- completes.
- */
+ - Parameters:
+ - world_tracking_provider: The world tracking provider.
+ - world_anchor: The world anchor to remove.
+ - remove_anchor_completion_handler: The handler to be called after the request to remove the world anchor from the world tracking provider
+ completes.
+*/
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN void
ar_world_tracking_provider_remove_anchor(ar_world_tracking_provider_t world_tracking_provider,
ar_world_anchor_t world_anchor,
@@ -441,13 +494,14 @@
/**
Remove a world anchor from the world tracking provider using its identifier.
- @param world_tracking_provider The world tracking provider.
- @param anchor_identifier The identifier of the world anchor to remove.
- @param remove_anchor_completion_handler The handler to be called after the request to remove the world anchor from the world tracking provider
+ - Parameters:
+ - world_tracking_provider: The world tracking provider.
+ - anchor_identifier: The identifier of the world anchor to remove.
+ - remove_anchor_completion_handler: The handler to be called after the request to remove the world anchor from the world tracking provider
completes.
- */
+*/
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN void ar_world_tracking_provider_remove_anchor_with_identifier(
ar_world_tracking_provider_t world_tracking_provider,
uuid_t _Nonnull anchor_identifier,
@@ -457,13 +511,14 @@
/**
Function called when a request to remove a world anchor has completed (successfully or not).
- @param context The application-defined context.
- @param world_anchor The world anchor to be removed from the world tracking provider.
- @param successful `true` if the world anchor was successfully removed from the world tracking provider, `false` otherwise.
- @param error The error that occurred, if any. The returned error supports ARC. In non-ARC files, use `ar_release()` to release the error.
- */
+ - Parameters:
+ - context: The application-defined context.
+ - world_anchor: The world anchor to be removed from the world tracking provider.
+ - successful: `true` if the world anchor was successfully removed from the world tracking provider, `false` otherwise.
+ - error: The error that occurred, if any.
+*/
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
typedef void (*ar_world_tracking_remove_anchor_completion_handler_function_t)(void *_Nullable context,
ar_world_anchor_t world_anchor,
bool successful,
@@ -472,14 +527,15 @@
/**
Remove a world anchor from the world tracking provider.
- @param world_tracking_provider The world tracking provider.
- @param world_anchor The world anchor to remove.
- @param context The application-defined context parameter to pass to the function.
- @param remove_anchor_completion_handler_function The function to be called after the request to remove the world anchor from the world tracking
+ - Parameters:
+ - world_tracking_provider: The world tracking provider.
+ - world_anchor: The world anchor to remove.
+ - context: The application-defined context parameter to pass to the function.
+ - remove_anchor_completion_handler_function: The function to be called after the request to remove the world anchor from the world tracking
provider completes.
- */
+*/
API_AVAILABLE(visionos(1.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN void ar_world_tracking_provider_remove_anchor_f(
ar_world_tracking_provider_t world_tracking_provider,
ar_world_anchor_t world_anchor,
@@ -489,14 +545,15 @@
/**
Remove a world anchor from the world tracking provider using its identifier.
- @param world_tracking_provider The world tracking provider.
- @param anchor_identifier The identifier of the world anchor to remove.
- @param context The application-defined context parameter to pass to the function.
- @param remove_anchor_completion_handler_function The function to be called after the request to remove the world anchor from the world tracking
+ - Parameters:
+ - world_tracking_provider: The world tracking provider.
+ - anchor_identifier: The identifier of the world anchor to remove.
+ - context: The application-defined context parameter to pass to the function.
+ - remove_anchor_completion_handler_function: The function to be called after the request to remove the world anchor from the world tracking
provider completes.
- */
+*/
API_AVAILABLE(visionos(26.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN void ar_world_tracking_provider_remove_anchor_with_identifier_f(
ar_world_tracking_provider_t world_tracking_provider,
uuid_t _Nonnull anchor_identifier,
@@ -508,37 +565,40 @@
/**
Function called when a request to remove all known world anchors has completed (successfully or not).
- @param successful `true` if all anchors were successfully removed from the world tracking provider, `false` otherwise.
- @param error The error that occurred, if any. The returned error supports ARC. In non-ARC files, use `ar_release()` to release the error.
- */
+ - Parameters:
+ - successful: `true` if all anchors were successfully removed from the world tracking provider, `false` otherwise.
+ - error: The error that occurred, if any.
+*/
API_AVAILABLE(visionos(26.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
typedef void (^ar_world_tracking_remove_all_anchors_completion_handler_t)(bool successful, ar_error_t _Nullable error) AR_REFINED_FOR_SWIFT;
/**
Removes all known world anchors from the world tracking provider asynchronously.
- @param world_tracking_provider The world tracking provider.
- @param remove_all_anchors_completion_handler The handler to be called after the request to remove all known world anchors from
- the world tracking provider completes.
- */
+ - Parameters:
+ - world_tracking_provider: The world tracking provider.
+ - remove_all_anchors_completion_handler: The handler to be called after the request to remove all known world anchors from
+ the world tracking provider completes.
+*/
API_AVAILABLE(visionos(26.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN void ar_world_tracking_provider_remove_all_anchors(
ar_world_tracking_provider_t world_tracking_provider,
ar_world_tracking_remove_all_anchors_completion_handler_t remove_all_anchors_completion_handler) AR_REFINED_FOR_SWIFT;
-#endif
+#endif // __BLOCKS__
/**
Function called when a request to remove all known world anchors has completed (successfully or not).
- @param context The application-defined context.
- @param successful `true` if all anchors were successfully removed from the world tracking provider, `false` otherwise.
- @param error The error that occurred, if any. The returned error supports ARC. In non-ARC files, use `ar_release()` to release the error.
- */
+ - Parameters:
+ - context: The application-defined context.
+ - successful: `true` if all anchors were successfully removed from the world tracking provider, `false` otherwise.
+ - error: The error that occurred, if any.
+*/
API_AVAILABLE(visionos(26.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
typedef void (^ar_world_tracking_remove_all_anchors_completion_handler_function_t)(void *_Nullable context,
bool successful,
ar_error_t _Nullable error) AR_REFINED_FOR_SWIFT;
@@ -546,29 +606,132 @@
/**
Removes all known world anchors from the world tracking provider asynchronously.
- @param world_tracking_provider The world tracking provider.
- @param context The application-defined context parameter to pass to the function.
- @param remove_all_anchors_completion_handler_function The handler to be called after the request to remove all known world anchors from
- the world tracking provider completes.
- */
+ - Parameters:
+ - world_tracking_provider: The world tracking provider.
+ - context: The application-defined context parameter to pass to the function.
+ - remove_all_anchors_completion_handler_function: The handler to be called after the request to remove all known world anchors from
+ the world tracking provider completes.
+*/
API_AVAILABLE(visionos(26.0))
-API_UNAVAILABLE(macos)
+API_UNAVAILABLE(macos, macCatalyst)
AR_EXTERN void ar_world_tracking_provider_remove_all_anchors_f(
ar_world_tracking_provider_t world_tracking_provider,
void *_Nullable context,
ar_world_tracking_remove_all_anchors_completion_handler_function_t remove_all_anchors_completion_handler_function) AR_REFINED_FOR_SWIFT;
+/**
+ Initialize a world anchor that should be shared with nearby participants.
+ :
+ - Nearby participants refer to participants that are nearby to the local participant in a SharePlay session.
+ - World anchors that are marked for sharing do not get persisted across reboots and their lifetime is limited to that of the SharePlay session.
+
+ - Parameter origin_from_anchor_transform: The transform from the world anchor to the origin coordinate system.
+
+ - Returns: An instance of `ar_world_anchor_t` which is marked to be shared with nearby participants.
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+*/
+API_AVAILABLE(visionos(26.0))
+API_UNAVAILABLE(macos, macCatalyst)
+AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_world_anchor_t
+ar_world_anchor_shared_with_nearby_participants_create(simd_float4x4 origin_from_anchor_transform) AR_REFINED_FOR_SWIFT;
+
+/**
+ Check if a world anchor is marked to be shared with nearby participants.
+
+ - Parameter world_anchor: The world anchor.
+
+ - Returns: `true` if the world anchor is marked to be shared with nearby participants, `false` otherwise.
+*/
+API_AVAILABLE(visionos(26.0))
+API_UNAVAILABLE(macos, macCatalyst)
+AR_EXTERN bool ar_world_anchor_is_shared_with_nearby_participants(ar_world_anchor_t world_anchor) AR_REFINED_FOR_SWIFT;
+
+/**
+ Enumeration indicating the availability of world anchor sharing.
+ */
+API_AVAILABLE(visionos(26.0))
+API_UNAVAILABLE(macos, macCatalyst)
+OS_ENUM(ar_world_anchor_sharing_availability, intptr_t,
+ // World anchors can be shared with nearby participants.
+ // Indicates that the device is in a SharePlay session with nearby participants.
+ ar_world_anchor_sharing_availability_available,
+ // World anchors cannot be shared with nearby participants.
+ // This indicates that either there’s no SharePlay session or the session has ended.
+ ar_world_anchor_sharing_availability_unavailable
+) AR_REFINED_FOR_SWIFT;
+
+#ifdef __BLOCKS__
+
+/**
+ A handler that the provider calls when there is a change in world anchor sharing availability.
+
+ - Parameter sharing_availability: World anchor sharing availability.
+*/
+API_AVAILABLE(visionos(26.0))
+API_UNAVAILABLE(macos, macCatalyst)
+typedef void (^ar_world_anchor_sharing_availability_update_handler_t)(ar_world_anchor_sharing_availability_t sharing_availability)
+ AR_REFINED_FOR_SWIFT;
+
+/**
+ Set the handler for receiving world anchor sharing availability updates.
+
+ - Parameters:
+ - world_tracking_provider: The world tracking provider.
+ - world_tracking_updates_queue: The queue on which the handler will be called. Passing `NULL` will default to the main queue.
+ - world_anchor_sharing_availability_update_handler: The handler to be called when there is a change in world anchor sharing availability.
+*/
+API_AVAILABLE(visionos(26.0))
+API_UNAVAILABLE(macos, macCatalyst)
+AR_EXTERN void ar_world_tracking_provider_set_world_anchor_sharing_availability_update_handler(
+ ar_world_tracking_provider_t world_tracking_provider,
+ dispatch_queue_t _Nullable world_tracking_updates_queue,
+ ar_world_anchor_sharing_availability_update_handler_t _Nullable world_anchor_sharing_availability_update_handler) AR_REFINED_FOR_SWIFT;
+#endif // __BLOCKS__
+
+/**
+ Function pointer called when there is a change in world anchor sharing availability.
+
+ - Parameters:
+ - context: The application-defined context.
+ - sharing_availability: World anchor sharing availability.
+*/
+API_AVAILABLE(visionos(26.0))
+API_UNAVAILABLE(macos, macCatalyst)
+typedef void (*ar_world_anchor_sharing_availability_update_handler_function_t)(
+ void *_Nullable context, ar_world_anchor_sharing_availability_t sharing_availability) AR_REFINED_FOR_SWIFT;
+
+/**
+ Set the function for receiving world anchor sharing availability updates
+
+ - Parameters:
+ - world_tracking_provider: The world tracking provider.
+ - world_tracking_updates_queue: The queue on which the handler will be called. Passing `NULL` will default to the main queue.
+ - context: The application-defined context parameter to pass to the function.
+ - world_anchor_sharing_availability_update_handler_function: The function to be called when there is a change in world anchor sharing availability.
+*/
+API_AVAILABLE(visionos(26.0))
+API_UNAVAILABLE(macos, macCatalyst)
+AR_EXTERN void ar_world_tracking_provider_set_world_anchor_sharing_availability_update_handler_f(
+ ar_world_tracking_provider_t world_tracking_provider,
+ dispatch_queue_t _Nullable world_tracking_updates_queue,
+ void *_Nullable context,
+ ar_world_anchor_sharing_availability_update_handler_function_t _Nullable world_anchor_sharing_availability_update_handler_function)
+ AR_REFINED_FOR_SWIFT;
+
#pragma mark - Device Anchor
+/**
+ An anchor representing the device's position and orientation.
+ */
AR_OBJECT_DECL_SUBCLASS(ar_device_anchor, ar_trackable_anchor)
AR_REFINED_FOR_SWIFT
-API_AVAILABLE(visionos(1.0), macos(26.0));
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0));
/**
Return status enum values for getting the device anchor at a specified timestamp from the world tracking provider.
*/
-API_AVAILABLE(visionos(1.0), macos(26.0))
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
OS_ENUM(ar_device_anchor_query_status, intptr_t,
// The device anchor at the specified timestamp was successfully obtained.
ar_device_anchor_query_status_success = 0,
@@ -579,7 +742,7 @@
/**
Tracking states of a device anchor.
*/
-API_AVAILABLE(visionos(2.0), macos(26.0))
+API_AVAILABLE(visionos(2.0), macos(26.0), macCatalyst(16.0))
OS_ENUM(ar_device_anchor_tracking_state, intptr_t,
// The anchor is not tracked.
ar_device_anchor_tracking_state_untracked = 0,
@@ -592,10 +755,11 @@
/**
Create a device anchor.
- @note This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
- @return An instance of `ar_device_anchor_t`.
- */
-API_AVAILABLE(visionos(1.0), macos(26.0))
+ - Note: This type supports ARC. In non-ARC files, use `ar_retain()` and `ar_release()` to retain and release the object.
+
+ - Returns: An instance of `ar_device_anchor_t`.
+*/
+API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN AR_OBJECT_RETURNS_RETAINED ar_device_anchor_t ar_device_anchor_create(void) AR_REFINED_FOR_SWIFT;
#pragma mark - Device Anchor (ar_anchor convenience getters)
@@ -603,50 +767,64 @@
/**
Get the identifier of an anchor.
- @param[in] anchor The anchor.
- @param[out] out_identifier A pointer to a UUID to fill out with the anchor identifier. Must be non-null.
- */
-API_AVAILABLE(visionos(2.0), macos(26.0))
+ - Parameters:
+ - anchor: The anchor.
+ - out_identifier: A pointer to a UUID to fill out with the anchor identifier. Must be non-null.
+*/
+API_AVAILABLE(visionos(2.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN void ar_device_anchor_get_identifier(ar_device_anchor_t anchor, uuid_t _Nonnull out_identifier) AR_REFINED_FOR_SWIFT;
/**
Get the transform from an anchor to the origin coordinate system.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return The origin from anchor transform.
- */
-API_AVAILABLE(visionos(2.0), macos(26.0))
+ - Returns: The origin from anchor transform.
+*/
+API_AVAILABLE(visionos(2.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN simd_float4x4 ar_device_anchor_get_origin_from_anchor_transform(ar_device_anchor_t anchor) AR_REFINED_FOR_SWIFT;
/**
+ Get the transform from an anchor to the origin coordinate system.
+
+ - Parameters:
+ - anchor: The anchor.
+ - transform_correction: The transform correction that should be applied.
+
+ - Returns: The origin from anchor transform.
+*/
+API_AVAILABLE(visionos(27.0), macos(27.0), macCatalyst(27.0))
+AR_EXTERN simd_float4x4 ar_device_anchor_get_origin_from_anchor_transform_with_correction(
+ ar_device_anchor_t anchor, ar_transform_correction_t transform_correction) AR_REFINED_FOR_SWIFT;
+
+/**
Get the timestamp corresponding to an anchor.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return The timestamp associated with the anchor.
- */
-API_AVAILABLE(visionos(2.0), macos(26.0))
+ - Returns: The timestamp associated with the anchor.
+*/
+API_AVAILABLE(visionos(2.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN CFTimeInterval ar_device_anchor_get_timestamp(ar_device_anchor_t anchor) AR_REFINED_FOR_SWIFT;
/**
Determine whether an anchor is tracked.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return `true` if the anchor is tracked, `false` otherwise.
- */
-API_AVAILABLE(visionos(2.0), macos(26.0))
+ - Returns: `true` if the anchor is tracked, `false` otherwise.
+*/
+API_AVAILABLE(visionos(2.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN bool ar_device_anchor_is_tracked(ar_device_anchor_t anchor) AR_REFINED_FOR_SWIFT;
/**
Get the tracking state of the device anchor.
- @param anchor The anchor.
+ - Parameter anchor: The anchor.
- @return Tracking state of this anchor.
- */
-API_AVAILABLE(visionos(2.0), macos(26.0))
+ - Returns: Tracking state of this anchor.
+*/
+API_AVAILABLE(visionos(2.0), macos(26.0), macCatalyst(16.0))
AR_EXTERN ar_device_anchor_tracking_state_t ar_device_anchor_get_tracking_state(ar_device_anchor_t anchor) AR_REFINED_FOR_SWIFT;
@@ -654,6 +832,7 @@
/**
Query a device anchor at the given timestamp.
+
The origin is a right-handed coordinate system and is defined such that X points to the right, Y points up, and Z points backward.
Example usage:
@@ -663,14 +842,16 @@
const ar_device_anchor_query_status_t status = ar_world_tracking_provider_query_device_anchor_at_timestamp(_provider, time, &device_anchor);- @note This API is not thread safe.
- @param[in] world_tracking_provider The world tracking provider.
- @param[in] timestamp The timestamp to get the device anchor at. The timestamp should be provided as mach absolute time in seconds.
- @param[out] device_anchor The output device anchor.
-
- Note: This API is not thread safe.
- @return An
ar_device_anchor_query_status_tvalue indicating whether the device anchor was successfully retrieved at the given timestamp or not. - */ -API_AVAILABLE(visionos(1.0), macos(26.0))
-
- Parameters:
-
- world_tracking_provider: The world tracking provider.
-
- timestamp: The timestamp to get the device anchor at. The timestamp should be provided as mach absolute time in seconds.
-
- device_anchor: The output device anchor.
-
- Returns: An
ar_device_anchor_query_status_tvalue indicating whether the device anchor was successfully retrieved at the given timestamp or not. +*/ +API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0)) AR_EXTERN ar_device_anchor_query_status_t ar_world_tracking_provider_query_device_anchor_at_timestamp(ar_world_tracking_provider_t world_tracking_provider, CFTimeInterval timestamp, @@ -679,9 +860,9 @@ /** Get the authorization type required by the world tracking provider.
- Returns: An
- @return The required authorization type.
- */ -API_AVAILABLE(visionos(1.0), macos(26.0))
-
- Returns: The required authorization type. +*/ +API_AVAILABLE(visionos(1.0), macos(26.0), macCatalyst(16.0)) AR_EXTERN ar_authorization_type_t ar_world_tracking_provider_get_required_authorization_type(void) AR_REFINED_FOR_SWIFT;
AR_ASSUME_NONNULL_END