Push SDK # 1.1.186

Documentation updates.

8 files changed, 69 insertions, 36 deletions

diff --git a/include/gfesdk/bindings/cpp/highlights/highlights_types_cpp.h b/include/gfesdk/bindings/cpp/highlights/highlights_types_cpp.h
index 69dbb88..e71a4b9 100644
--- a/include/gfesdk/bindings/cpp/highlights/highlights_types_cpp.h
+++ b/include/gfesdk/bindings/cpp/highlights/highlights_types_cpp.h
@@ -29,7 +29,7 @@ struct HighlightDefinition
     NVGSDK_HighlightType                highlightTags;
     NVGSDK_HighlightSignificance        significance;
     TTranslationTable                   nameLocaleTable;  //!< Locale/translation pairs
-    HighlightDefinition() : highlightTags(static_cast<NVGSDK_HighlightType>(0)), significance(static_cast<NVGSDK_HighlightSignificance>(0)), userDefaultInterest(true) {}
+    HighlightDefinition() : highlightTags(NVGSDK_HIGHLIGHT_TYPE_NONE), significance(NVGSDK_HIGHLIGHT_SIGNIFICANCE_NONE), userDefaultInterest(true) {}
 };
 
 //! C++ binding for @ref NVGSDK_HighlightConfigParams
@@ -75,7 +75,7 @@ struct GroupView
     std::string                     groupId;
     NVGSDK_HighlightType            tagsFilter;
     NVGSDK_HighlightSignificance    significanceFilter;
-    GroupView() : tagsFilter(NVGSDK_HighlightType(0)), significanceFilter(NVGSDK_HighlightSignificance(0)) {}
+    GroupView() : tagsFilter(NVGSDK_HIGHLIGHT_TYPE_NONE), significanceFilter(NVGSDK_HIGHLIGHT_SIGNIFICANCE_NONE) {}
 };
 
 //! C++ binding for @ref NVGSDK_SummaryParams
diff --git a/include/gfesdk/bindings/cpp/highlights/ihighlights_cpp_impl.h b/include/gfesdk/bindings/cpp/highlights/ihighlights_cpp_impl.h
index 6af42c1..b6a0ba2 100644
--- a/include/gfesdk/bindings/cpp/highlights/ihighlights_cpp_impl.h
+++ b/include/gfesdk/bindings/cpp/highlights/ihighlights_cpp_impl.h
@@ -79,7 +79,7 @@ inline void HighlightsImpl::ConfigureAsync(HighlightConfigParams const& params,
             it->userDefaultInterest,
             it->highlightTags,
             it->significance,
-            &cLocaleMaps.back()[0],
+            it->nameLocaleTable.empty() ? nullptr : &cLocaleMaps.back()[0],
             it->nameLocaleTable.size()
         });
     }
diff --git a/include/gfesdk/config.h b/include/gfesdk/config.h
index 3ae765a..21994bc 100644
--- a/include/gfesdk/config.h
+++ b/include/gfesdk/config.h
@@ -18,8 +18,8 @@
 
 #define NVGSDK_VERSION_MAJOR   1
 #define NVGSDK_VERSION_MINOR   1
-#define NVGSDK_BUILD_NUMBER    173
-#define NVGSDK_BUILD_HASH      5d889305
-#define NVGSDK_BUILD_HASH_STR  "5d889305"
+#define NVGSDK_BUILD_NUMBER    186
+#define NVGSDK_BUILD_HASH      6007c22a
+#define NVGSDK_BUILD_HASH_STR  "6007c22a"
 
 #endif // _NVGSDK_CONFIG_H_
diff --git a/include/gfesdk/gfe3_product_version.h b/include/gfesdk/gfe3_product_version.h
index 64a2a63..c3c8186 100644
--- a/include/gfesdk/gfe3_product_version.h
+++ b/include/gfesdk/gfe3_product_version.h
@@ -10,10 +10,10 @@
 // N - Build counter.
 //
 #define NVIDIA_GFE3_VERSION_MAJOR 3
-#define NVIDIA_GFE3_VERSION_MINOR 13
+#define NVIDIA_GFE3_VERSION_MINOR 14
 #define NVIDIA_GFE3_VERSION_DEV_REBASE 0
 #define NVIDIA_GFE3_VERSION_RNEXT_REBASE 0
-#define NVIDIA_GFE3_VERSION_BUILD 47
+#define NVIDIA_GFE3_VERSION_BUILD 30
 
 //
 // Composite version values. We don't concatenate them here automatically because
@@ -22,11 +22,11 @@
 //
 
 // Format: A,B,XY,N
-#define NVIDIA_GFE3_VERSION          3,13,0,47
+#define NVIDIA_GFE3_VERSION          3,14,0,30
 // Format: A.B.XY.N
-#define NVIDIA_GFE3_VERSION_DOT      3.13.0.47
+#define NVIDIA_GFE3_VERSION_DOT      3.14.0.30
 // Format: "A.B.XY.N"
-#define NVIDIA_GFE3_VERSION_STRING   "3.13.0.47"
+#define NVIDIA_GFE3_VERSION_STRING   "3.14.0.30"
 
 //
 // Some common strings
diff --git a/include/gfesdk/highlights/highlights_types.h b/include/gfesdk/highlights/highlights_types.h
index 3ae751c..52ffe01 100644
--- a/include/gfesdk/highlights/highlights_types.h
+++ b/include/gfesdk/highlights/highlights_types.h
@@ -19,19 +19,6 @@
 #include <stdint.h>
 #include <stdbool.h>
 
-/*! Possible significance values */
-typedef enum
-{
-    NVGSDK_HIGHLIGHT_SIGNIFICANCE_EXTREMELY_BAD  = 0x00000001,
-    NVGSDK_HIGHLIGHT_SIGNIFICANCE_VERY_BAD       = 0x00000002,
-    NVGSDK_HIGHLIGHT_SIGNIFICANCE_BAD            = 0x00000004,
-    NVGSDK_HIGHLIGHT_SIGNIFICANCE_NEUTRAL        = 0x00000010,
-    NVGSDK_HIGHLIGHT_SIGNIFICANCE_GOOD           = 0x00000100,
-    NVGSDK_HIGHLIGHT_SIGNIFICANCE_VERY_GOOD      = 0x00000200,
-    NVGSDK_HIGHLIGHT_SIGNIFICANCE_EXTREMELY_GOOD = 0x00000400,
-    NVGSDK_HIGHLIGHT_SIGNIFICANCE_MAX            = 0x00000800
-} NVGSDK_HighlightSignificance;
-
 /*! Possible highlights that can occur during gameplay */
 typedef struct
 {
diff --git a/include/gfesdk/os_defines.h b/include/gfesdk/os_defines.h
index 7cf4688..f2eb0ca 100644
--- a/include/gfesdk/os_defines.h
+++ b/include/gfesdk/os_defines.h
@@ -27,6 +27,11 @@ extern "C" {
 #error Add the appropriate construct for the platform complier
 #endif
 
+// Older versions of MSVC don't support inline in C
+#if defined(_MSC_VER) && !defined(__cplusplus)
+#   define inline __inline
+#endif
+
 #ifdef __cplusplus
 };
 #endif
diff --git a/include/gfesdk/sdk_types.h b/include/gfesdk/sdk_types.h
index 5c9fd44..19375c0 100644
--- a/include/gfesdk/sdk_types.h
+++ b/include/gfesdk/sdk_types.h
@@ -15,12 +15,12 @@
 #ifndef GFESDK_SDK_TYPES_H
 #define GFESDK_SDK_TYPES_H
 
-#include <gfesdk/os_defines.h>
-#include <gfesdk/sdk_types_ipc.h>
 #include <stdint.h>
 #include <stdbool.h>
+#include <gfesdk/os_defines.h>
+#include <gfesdk/sdk_types_ipc.h>
 
-size_t const NVGSDK_MAX_LENGTH = 256;
+#define NVGSDK_MAX_LENGTH 256
 size_t const NVGSDK_MAX_LOCALE = 128;
 size_t const NVGSDK_MAX_HIGHLIGHT_TABLE = 128;
 
diff --git a/include/gfesdk/sdk_types_ipc.h b/include/gfesdk/sdk_types_ipc.h
index 03416c2..d023dec 100644
--- a/include/gfesdk/sdk_types_ipc.h
+++ b/include/gfesdk/sdk_types_ipc.h
@@ -1,4 +1,4 @@
-// Copyright (c) 2016, NVIDIA CORPORATION.  All rights reserved.
+// Copyright (c) 2016-2018, NVIDIA CORPORATION.  All rights reserved.
 //
 // NVIDIA CORPORATION and its licensors retain all intellectual property
 // and proprietary rights in and to this software, related documentation
@@ -9,6 +9,9 @@
 #ifndef NVSDKAPI_IPC_H
 #define NVSDKAPI_IPC_H
 
+#include <wchar.h>
+#include <stdbool.h>
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -63,7 +66,7 @@ typedef enum _NVGSDK_RetCode
     NVGSDK_ERR_GFE_VERSION               = -1002,
     NVGSDK_ERR_SDK_VERSION               = -1003,
     NVGSDK_ERR_NOT_IMPLEMENTED           = -1004,
-    NVGSDK_ERR_INVALID_PARAMETER	     = -1005,
+    NVGSDK_ERR_INVALID_PARAMETER         = -1005,
     NVGSDK_ERR_NOT_SET                   = -1006,
     NVGSDK_ERR_SHADOWPLAY_IR_DISABLED    = -1007,
     NVGSDK_ERR_SDK_IN_USE                = -1008,
@@ -85,7 +88,13 @@ typedef enum _NVGSDK_RetCode
     NVGSDK_ERR_IPC_FAILED                = -1024,
     NVGSDK_ERR_CONNECTION                = -1025,
     NVGSDK_ERR_MODULE_NOT_LOADED         = -1026,
-    NVGSDK_ERR_LIB_CALL_TIMEOUT          = -1027
+    NVGSDK_ERR_LIB_CALL_TIMEOUT          = -1027,
+    NVGSDK_ERR_APPLICATION_LOOKUP_FAILED = -1028,
+    NVGSDK_ERR_APPLICATION_NOT_KNOWN     = -1029,
+    NVGSDK_ERR_FEATURE_DISABLED          = -1030,
+    NVGSDK_ERR_APP_NO_OPTIMIZATION       = -1031,
+    NVGSDK_ERR_APP_SETTINGS_READ         = -1032,
+    NVGSDK_ERR_APP_SETTINGS_WRITE        = -1033,
 } NVGSDK_RetCode;
 
 // not using macros to avoid polluting namespace of SDK unnecessarily
@@ -106,6 +115,10 @@ inline bool NVGSDK_FAILED(NVGSDK_RetCode r)
 typedef enum
 {
     /*!
+    * No tags are attached to the highlight
+    */
+    NVGSDK_HIGHLIGHT_TYPE_NONE = 0x00000000,
+    /*!
     * Signifies direct progress towards completing the game. (e.g. completing a level)
     */
     NVGSDK_HIGHLIGHT_TYPE_MILESTONE = 0x00000001,
@@ -133,12 +146,30 @@ typedef enum
     NVGSDK_HIGHLIGHT_TYPE_MAX = 0x00000020
 } NVGSDK_HighlightType;
 
+/*! Possible significance values */
+typedef enum
+{
+    /*! No significance is attached to the highlights */
+    NVGSDK_HIGHLIGHT_SIGNIFICANCE_NONE = 0x00000000,
+    NVGSDK_HIGHLIGHT_SIGNIFICANCE_EXTREMELY_BAD = 0x00000001,
+    NVGSDK_HIGHLIGHT_SIGNIFICANCE_VERY_BAD = 0x00000002,
+    NVGSDK_HIGHLIGHT_SIGNIFICANCE_BAD = 0x00000004,
+    NVGSDK_HIGHLIGHT_SIGNIFICANCE_NEUTRAL = 0x00000010,
+    NVGSDK_HIGHLIGHT_SIGNIFICANCE_GOOD = 0x00000100,
+    NVGSDK_HIGHLIGHT_SIGNIFICANCE_VERY_GOOD = 0x00000200,
+    NVGSDK_HIGHLIGHT_SIGNIFICANCE_EXTREMELY_GOOD = 0x00000400,
+
+    //! Invalid default value
+    NVGSDK_HIGHLIGHT_SIGNIFICANCE_MAX = 0x00000800
+} NVGSDK_HighlightSignificance;
+
 /*! Functionality supported by the SDK and possibly requiring user permission */
 typedef enum
 {
     NVGSDK_SCOPE_HIGHLIGHTS = 0,            //!< Scope required to access highlights information, open group summary, etc
     NVGSDK_SCOPE_HIGHLIGHTS_VIDEO = 1,      //!< Scope required to save video highlights
     NVGSDK_SCOPE_HIGHLIGHTS_SCREENSHOT = 2, //!< Scope required to save screenshot highlights
+    NVGSDK_SCOPE_OPS = 3,                   //!< Scope required to optimize the game
     NVGSDK_SCOPE_MAX
 } NVGSDK_Scope;
 
@@ -185,6 +216,7 @@ inline const char* NVGSDK_RetCodeToString(NVGSDK_RetCode const ret)
     case NVGSDK_ERR_GROUP_NOT_FOUND:            return "NVGSDK_ERR_GROUP_NOT_FOUND";
     case NVGSDK_ERR_FILE_NOT_FOUND:             return "NVGSDK_ERR_FILE_NOT_FOUND";
     case NVGSDK_ERR_HIGHLIGHTS_SETUP_FAILED:    return "NVGSDK_ERR_HIGHLIGHTS_SETUP_FAILED";
+    case NVGSDK_ERR_HIGHLIGHTS_NOT_CONFIGURED:  return "NVGSDK_ERR_HIGHLIGHTS_NOT_CONFIGURED";
     case NVGSDK_ERR_HIGHLIGHTS_SAVE_FAILED:     return "NVGSDK_ERR_HIGHLIGHTS_SAVE_FAILED";
     case NVGSDK_ERR_UNEXPECTED_EXCEPTION:       return "NVGSDK_ERR_UNEXPECTED_EXCEPTION";
     case NVGSDK_ERR_NO_HIGHLIGHTS:              return "NVGSDK_ERR_NO_HIGHLIGHTS";
@@ -200,19 +232,28 @@ inline const char* NVGSDK_RetCodeToString(NVGSDK_RetCode const ret)
     case NVGSDK_ERR_CONNECTION:                 return "NVGSDK_ERR_CONNECTION";
     case NVGSDK_ERR_MODULE_NOT_LOADED:          return "NVGSDK_ERR_MODULE_NOT_LOADED";
     case NVGSDK_ERR_LIB_CALL_TIMEOUT:           return "NVGSDK_ERR_LIB_CALL_TIMEOUT";
+    case NVGSDK_ERR_APPLICATION_LOOKUP_FAILED:  return "NVGSDK_ERR_APPLICATION_LOOKUP_FAILED";
+    case NVGSDK_ERR_APPLICATION_NOT_KNOWN:      return "NVGSDK_ERR_APPLICATION_NOT_KNOWN";
+    case NVGSDK_ERR_FEATURE_DISABLED:           return "NVGSDK_ERR_FEATURE_DISABLED";
+    case NVGSDK_ERR_APP_NO_OPTIMIZATION:        return "NVGSDK_ERR_APP_NO_OPTIMIZATION";
+    case NVGSDK_ERR_APP_SETTINGS_READ:          return "NVGSDK_ERR_APP_SETTINGS_READ";
+    case NVGSDK_ERR_APP_SETTINGS_WRITE:         return "NVGSDK_ERR_APP_SETTINGS_WRITE";
     }
     return "Unknown code";
 }
 
 // All alphanumeric and the hyphen
-char const VALID_GROUPID_CHARS[] = "^[a-zA-Z0-9\\-_ ]+$";
-wchar_t const VALID_GROUPID_WCHARS[] = L"^[a-zA-Z0-9\\-_ ]+$";
+char const VALID_GROUPID_CHARS[] = "^[a-zA-Z0-9\\-\\._ ']+$";
+wchar_t const VALID_GROUPID_WCHARS[] = L"^[a-zA-Z0-9\\-\\._ ']+$";
+
+char const VALID_HIGHLIGHT_DEF_ID_CHARS[] = "^[a-zA-Z0-9\\-\\._ ']+$";
+wchar_t const VALID_HIGHLIGHT_DEF_ID_WCHARS[] = L"^[a-zA-Z0-9\\-\\._ ']+$";
 
-char const VALID_HIGHLIGHT_DEF_ID_CHARS[] = "^[a-zA-Z0-9\\-_ ]+$";
-wchar_t const VALID_HIGHLIGHT_DEF_ID_WCHARS[] = L"^[a-zA-Z0-9\\-_ ]+$";
+char const VALID_GAMENAME_CHARS[] = "^[a-zA-Z0-9\\-\\._ ']+$";
+wchar_t const VALID_GAMENAME_WCHARS[] = L"^[a-zA-Z0-9\\-\\._ ']+$";
 
-char const VALID_GAMENAME_CHARS[] = "^[a-zA-Z0-9\\-_ ]+$";
-wchar_t const VALID_GAMENAME_WCHARS[] = L"^[a-zA-Z0-9\\-_ ]+$";
+char const VALID_LOCALE_CODE_CHARS[] = "^[a-zA-Z\\-]+$";
+wchar_t const VALID_LOCALE_CODE_WCHARS[] = L"^[a-zA-Z\\-]+$";
 
 size_t const VALID_HIGHLIGHT_SIGNIFICANCE_WIDTH = 0x8FF;
 size_t const VALID_HIGHLIGHT_TAG_WIDTH = 0x1F;