Upgrading SDK to v67.0 (#8)

.github/workflows/build_all.yml

@@ -7,7 +7,7 @@ on:
     branches: [ "main" ]
 
 env:
-  OCULUS_VERSION: 66
+  OCULUS_VERSION: 67
   GODOT_ENGINE_VERSION: "4.2.0"
   GODOT_ENGINE_STAGE: "stable"
   INTEGRATION_VERSION: "v1.5.0"

src/include/OVR_AbuseReportOptions.h

@@ -15,7 +15,9 @@ typedef struct ovrAbuseReportOptions* ovrAbuseReportOptionsHandle;
 
 OVRP_PUBLIC_FUNCTION(ovrAbuseReportOptionsHandle) ovr_AbuseReportOptions_Create();
 OVRP_PUBLIC_FUNCTION(void) ovr_AbuseReportOptions_Destroy(ovrAbuseReportOptionsHandle handle);
+/// Set whether or not to show the user selection step in the report dialog.
 OVRP_PUBLIC_FUNCTION(void) ovr_AbuseReportOptions_SetPreventPeopleChooser(ovrAbuseReportOptionsHandle handle, bool value);
+/// The intended entity being reported, whether user or object/content.
 OVRP_PUBLIC_FUNCTION(void) ovr_AbuseReportOptions_SetReportType(ovrAbuseReportOptionsHandle handle, ovrAbuseReportType value);
 
 #endif

src/include/OVR_AccountAgeCategory.h

@@ -5,10 +5,17 @@
 
 #include "OVR_Platform_Defs.h"
 
+/// Age category in Meta account. The values are used in
+/// ovr_UserAgeCategory_Get() API.
 typedef enum ovrAccountAgeCategory_ {
   ovrAccountAgeCategory_Unknown,
+  /// Child age group for users between the ages of 10-12 (age may vary by
+  /// region)
   ovrAccountAgeCategory_Ch,
+  /// Teenage age group for users between the ages of 13-17 (age may vary by
+  /// region)
   ovrAccountAgeCategory_Tn,
+  /// Adult age group for users ages 18 and up (age may vary by region)
   ovrAccountAgeCategory_Ad,
 } ovrAccountAgeCategory;
 

src/include/OVR_AchievementProgress.h

@@ -8,10 +8,21 @@
 
 typedef struct ovrAchievementProgress *ovrAchievementProgressHandle;
 
-OVRP_PUBLIC_FUNCTION(const char *)       ovr_AchievementProgress_GetBitfield(const ovrAchievementProgressHandle obj);
+/// For bitfield achievements, the current bitfield state.
+OVRP_PUBLIC_FUNCTION(const char *) ovr_AchievementProgress_GetBitfield(const ovrAchievementProgressHandle obj);
+
+/// For count achievements, the current counter state.
 OVRP_PUBLIC_FUNCTION(unsigned long long) ovr_AchievementProgress_GetCount(const ovrAchievementProgressHandle obj);
-OVRP_PUBLIC_FUNCTION(bool)               ovr_AchievementProgress_GetIsUnlocked(const ovrAchievementProgressHandle obj);
-OVRP_PUBLIC_FUNCTION(const char *)       ovr_AchievementProgress_GetName(const ovrAchievementProgressHandle obj);
+
+/// If the user has already unlocked this achievement.
+OVRP_PUBLIC_FUNCTION(bool) ovr_AchievementProgress_GetIsUnlocked(const ovrAchievementProgressHandle obj);
+
+/// The unique string that you use to reference the achievement in your app, as
+/// specified in the developer dashboard.
+OVRP_PUBLIC_FUNCTION(const char *) ovr_AchievementProgress_GetName(const ovrAchievementProgressHandle obj);
+
+/// If the achievement is unlocked, the time when it was unlocked.
 OVRP_PUBLIC_FUNCTION(unsigned long long) ovr_AchievementProgress_GetUnlockTime(const ovrAchievementProgressHandle obj);
 
+
 #endif

src/include/OVR_AdvancedAbuseReportOptions.h

@@ -16,14 +16,27 @@ typedef struct ovrAdvancedAbuseReportOptions* ovrAdvancedAbuseReportOptionsHandl
 
 OVRP_PUBLIC_FUNCTION(ovrAdvancedAbuseReportOptionsHandle) ovr_AdvancedAbuseReportOptions_Create();
 OVRP_PUBLIC_FUNCTION(void) ovr_AdvancedAbuseReportOptions_Destroy(ovrAdvancedAbuseReportOptionsHandle handle);
+/// This field is intended to allow developers to pass custom metadata through
+/// the report flow. The metadata passed through is included with the report
+/// received by the developer.
 OVRP_PUBLIC_FUNCTION(void) ovr_AdvancedAbuseReportOptions_SetDeveloperDefinedContextString(ovrAdvancedAbuseReportOptionsHandle handle, const char* key, const char* value);
 OVRP_PUBLIC_FUNCTION(void) ovr_AdvancedAbuseReportOptions_ClearDeveloperDefinedContext(ovrAdvancedAbuseReportOptionsHandle handle);
-/// If report_type is content, a string representing the type of content being
-/// reported. This should correspond to the object_type string used in the UI
+/// If report_type is object/content, a string representing the type of content
+/// being reported. This should correspond to the object_type string used in
+/// the UI
 OVRP_PUBLIC_FUNCTION(void) ovr_AdvancedAbuseReportOptions_SetObjectType(ovrAdvancedAbuseReportOptionsHandle handle, const char * value);
+/// The intended entity being reported, whether user or object/content.
 OVRP_PUBLIC_FUNCTION(void) ovr_AdvancedAbuseReportOptions_SetReportType(ovrAdvancedAbuseReportOptionsHandle handle, ovrAbuseReportType value);
+/// Provide a list of users to suggest for reporting. This list should include
+/// users that the reporter has recently interacted with to aid them in
+/// selecting the right user to report.
 OVRP_PUBLIC_FUNCTION(void) ovr_AdvancedAbuseReportOptions_AddSuggestedUser(ovrAdvancedAbuseReportOptionsHandle handle, ovrID value);
 OVRP_PUBLIC_FUNCTION(void) ovr_AdvancedAbuseReportOptions_ClearSuggestedUsers(ovrAdvancedAbuseReportOptionsHandle handle);
+/// The video mode controls whether or not the abuse report flow should collect
+/// evidence and whether it is optional or not. "Collect" requires video
+/// evidence to be provided by the user. "Optional" presents the user with the
+/// option to provide video evidence. "Skip" bypasses the video evidence
+/// collection step altogether.
 OVRP_PUBLIC_FUNCTION(void) ovr_AdvancedAbuseReportOptions_SetVideoMode(ovrAdvancedAbuseReportOptionsHandle handle, ovrAbuseReportVideoMode value);
 
 #endif

src/include/OVR_AppAgeCategory.h

@@ -5,9 +5,14 @@
 
 #include "OVR_Platform_Defs.h"
 
+/// Age category for developers to send to Meta. The values are used in
+/// ovr_UserAgeCategory_Report() API.
 typedef enum ovrAppAgeCategory_ {
   ovrAppAgeCategory_Unknown,
+  /// Child age group for users between the ages of 10-12 (age may vary by
+  /// region)
   ovrAppAgeCategory_Ch,
+  /// Non-child age group for users ages 13 and up (age may vary by region)
   ovrAppAgeCategory_Nch,
 } ovrAppAgeCategory;
 

src/include/OVR_AppInstallResult.h

@@ -5,14 +5,27 @@
 
 #include "OVR_Platform_Defs.h"
 
+/// Result of installing an app. In case of an error during install process,
+/// the error message contains the string representation of this result. This
+/// is returned from ovr_Application_StartAppDownload(),
+/// ovr_Application_CancelAppDownload() and
+/// ovr_Application_InstallAppUpdateAndRelaunch() APIs.
 typedef enum ovrAppInstallResult_ {
   ovrAppInstallResult_Unknown,
+  /// Install of the app failed due to low storage on the device
   ovrAppInstallResult_LowStorage,
+  /// Install of the app failed due to a network error
   ovrAppInstallResult_NetworkError,
+  /// Install of the app failed as another install request for this application
+  /// is already being processed by the installer
   ovrAppInstallResult_DuplicateRequest,
+  /// Install of the app failed due to an internal installer error
   ovrAppInstallResult_InstallerError,
+  /// Install of the app failed because the user cancelled the install operation
   ovrAppInstallResult_UserCancelled,
+  /// Install of the app failed due to a user authorization error
   ovrAppInstallResult_AuthorizationError,
+  /// Install of the app succeeded
   ovrAppInstallResult_Success,
 } ovrAppInstallResult;
 

src/include/OVR_AppStatus.h

@@ -5,14 +5,24 @@
 
 #include "OVR_Platform_Defs.h"
 
+/// Current status of the app on the device. An app can only check its own
+/// status.
 typedef enum ovrAppStatus_ {
   ovrAppStatus_Unknown,
+  /// User has valid entitlement to the app but it is not currently installed on
+  /// the device.
   ovrAppStatus_Entitled,
+  /// Download of the app is currently queued.
   ovrAppStatus_DownloadQueued,
+  /// Download of the app is currently in progress.
   ovrAppStatus_Downloading,
+  /// Install of the app is currently in progress.
   ovrAppStatus_Installing,
+  /// App is installed on the device.
   ovrAppStatus_Installed,
+  /// App is being uninstalled from the device.
   ovrAppStatus_Uninstalling,
+  /// Install of the app is currently queued.
   ovrAppStatus_InstallQueued,
 } ovrAppStatus;
 

src/include/OVR_ApplicationVersion.h

@@ -7,15 +7,27 @@
 
 typedef struct ovrApplicationVersion *ovrApplicationVersionHandle;
 
-/// Seconds since epoch when the latest app update was released
+/// Version code number for the version of the application currently installed
+/// on the device.
+OVRP_PUBLIC_FUNCTION(int) ovr_ApplicationVersion_GetCurrentCode(const ovrApplicationVersionHandle obj);
+
+/// Version name string for the version of the application currently installed
+/// on the device.
+OVRP_PUBLIC_FUNCTION(const char *) ovr_ApplicationVersion_GetCurrentName(const ovrApplicationVersionHandle obj);
+
+/// Version code number of the latest update of the application. This may or
+/// may not be currently installed on the device.
+OVRP_PUBLIC_FUNCTION(int) ovr_ApplicationVersion_GetLatestCode(const ovrApplicationVersionHandle obj);
+
+/// Version name string of the latest update of the application. This may or
+/// may not be currently installed on the device.
+OVRP_PUBLIC_FUNCTION(const char *) ovr_ApplicationVersion_GetLatestName(const ovrApplicationVersionHandle obj);
+
+/// Seconds since epoch when the latest application update was released.
 OVRP_PUBLIC_FUNCTION(long long) ovr_ApplicationVersion_GetReleaseDate(const ovrApplicationVersionHandle obj);
 
-/// Size of the app update in bytes
+/// Size of the latest application update in bytes.
 OVRP_PUBLIC_FUNCTION(const char *) ovr_ApplicationVersion_GetSize(const ovrApplicationVersionHandle obj);
 
-OVRP_PUBLIC_FUNCTION(int)          ovr_ApplicationVersion_GetCurrentCode(const ovrApplicationVersionHandle obj);
-OVRP_PUBLIC_FUNCTION(const char *) ovr_ApplicationVersion_GetCurrentName(const ovrApplicationVersionHandle obj);
-OVRP_PUBLIC_FUNCTION(int)          ovr_ApplicationVersion_GetLatestCode(const ovrApplicationVersionHandle obj);
-OVRP_PUBLIC_FUNCTION(const char *) ovr_ApplicationVersion_GetLatestName(const ovrApplicationVersionHandle obj);
 
 #endif

src/include/OVR_LaunchReportFlowResult.h

@@ -12,6 +12,8 @@ typedef struct ovrLaunchReportFlowResult *ovrLaunchReportFlowResultHandle;
 /// Whether the viewer chose to cancel the report flow.
 OVRP_PUBLIC_FUNCTION(bool) ovr_LaunchReportFlowResult_GetDidCancel(const ovrLaunchReportFlowResultHandle obj);
 
+/// ID of the report created by the user.
 OVRP_PUBLIC_FUNCTION(ovrID) ovr_LaunchReportFlowResult_GetUserReportId(const ovrLaunchReportFlowResultHandle obj);
 
+
 #endif

src/include/OVR_PlatformVersion.h

@@ -12,7 +12,7 @@
 // If you change these values then you need to also make sure to change LibOVRPlatform.props in
 // parallel.
 #define PLATFORM_MAJOR_VERSION 1
-#define PLATFORM_MINOR_VERSION 98
+#define PLATFORM_MINOR_VERSION 99
 #define PLATFORM_PATCH_VERSION 0
 #define PLATFORM_BUILD_NUMBER 0
 #define PLATFORM_DRIVER_VERSION 0

src/include/OVR_ReportRequestResponse.h

@@ -5,10 +5,18 @@
 
 #include "OVR_Platform_Defs.h"
 
+/// Possible states that an app can respond to the platform notification that
+/// the in-app reporting flow has been requested by the user.
 typedef enum ovrReportRequestResponse_ {
   ovrReportRequestResponse_Unknown,
+  /// Response to the platform notification that the in-app reporting flow
+  /// request is handled.
   ovrReportRequestResponse_Handled,
+  /// Response to the platform notification that the in-app reporting flow
+  /// request is not handled.
   ovrReportRequestResponse_Unhandled,
+  /// Response to the platform notification that the in-app reporting flow is
+  /// unavailable or non-existent.
   ovrReportRequestResponse_Unavailable,
 } ovrReportRequestResponse;