Stay organized with collections
Save and categorize content based on your preferences.
GARFramePair
Container class for an ARFrame and its corresponding GARFrame.
These two frames will always have the same timestamp. A GARFrame does not hold references to ARFrames - ARFrames must be released as quickly as possible to free up resources, or ARKit may be starved. The SDK only holds a reference to the most recent frame pair.
Summary
Inheritance
Inherits from:
NSObject
Properties
|
arFrame
|
ARFrame *
The ARKit frame object.
|
garFrame
|
The ARCore frame object.
|
Properties
arFrame
@property(nonatomic, readonly) ARFrame *arFrame;
Public methods
initWithARFrame:GARFrame:
- (instancetype _Nullable)initWithARFrame:
(ARFrame *) arFrame
Instantiate a GARFramePair with the given frames.
| Details |
|---|
| Parameters |
arFrame
|
The ARKit frame object.
|
garFrame
|
The ARCore frame object.
|
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-14 UTC.
[null,null,["Last updated 2025-07-14 UTC."],[[["\u003cp\u003e\u003ccode\u003eGARFramePair\u003c/code\u003e is a container for corresponding \u003ccode\u003eARFrame\u003c/code\u003e and \u003ccode\u003eGARFrame\u003c/code\u003e objects, ensuring synchronized timestamps.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eARFrame\u003c/code\u003es should be released swiftly to avoid resource constraints within ARKit.\u003c/p\u003e\n"],["\u003cp\u003eThe SDK retains only the latest \u003ccode\u003eGARFramePair\u003c/code\u003e, optimizing memory usage.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGARFramePair\u003c/code\u003e offers straightforward access to both \u003ccode\u003eARFrame\u003c/code\u003e and \u003ccode\u003eGARFrame\u003c/code\u003e via its properties.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can create \u003ccode\u003eGARFramePair\u003c/code\u003e instances by using the designated initializer with \u003ccode\u003eARFrame\u003c/code\u003e and \u003ccode\u003eGARFrame\u003c/code\u003e as inputs.\u003c/p\u003e\n"]]],[],null,["# GARFramePair Class Reference\n\nGARFramePair\n============\n\nContainer class for an `ARFrame` and its corresponding [GARFrame](/ar/reference/ios/interface/GARFrame#interface_g_a_r_frame).\n\nThese two frames will always have the same timestamp. A [GARFrame](/ar/reference/ios/interface/GARFrame#interface_g_a_r_frame) does not hold references to `ARFrame`s - `ARFrame`s must be released as quickly as possible to free up resources, or **ARKit** may be starved. The SDK only holds a reference to the most recent frame pair.\n\nSummary\n-------\n\n### Inheritance\n\nInherits from: `NSObject`\n\n| ### Properties ||\n|-----------------------|-----------------------------------------------------------------------------------------------------|\n| [arFrame](#arframe) | `ARFrame *` The **ARKit** frame object. |\n| [garFrame](#garframe) | [GARFrame](/ar/reference/ios/interface/GARFrame#interface_g_a_r_frame)` *` The ARCore frame object. |\n\n| ### Public methods ||\n|---------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|\n| [initWithARFrame:GARFrame:](#initwitharframe:garframe:) | `instancetype _Nullable` Instantiate a [GARFramePair](/ar/reference/ios/interface/GARFramePair#interface_g_a_r_frame_pair) with the given frames. |\n\nProperties\n----------\n\n### arFrame\n\n```transact-sql\n@property(nonatomic, readonly) ARFrame */ar/reference/ios/interface/GARFramePair#arframe;\n``` \nThe **ARKit** frame object. \n\n### garFrame\n\n```transact-sql\n@property(nonatomic, readonly) /ar/reference/ios/interface/GARFrame#interface_g_a_r_frame */ar/reference/ios/interface/GARFramePair#garframe;\n``` \nThe ARCore frame object.\n\nPublic methods\n--------------\n\n### initWithARFrame:GARFrame:\n\n```carbon\n- (instancetype _Nullable)initWithARFrame: \n(ARFrame *) arFrame \nGARFrame: \n(/ar/reference/ios/interface/GARFrame#interface_g_a_r_frame *) garFrame\n``` \nInstantiate a [GARFramePair](/ar/reference/ios/interface/GARFramePair#interface_g_a_r_frame_pair) with the given frames.\n\n\n| Details ||\n|------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| Parameters | |------------|-----------------------------| | `arFrame` | The **ARKit** frame object. | | `garFrame` | The ARCore frame object. | |"]]
