From 5c3721f55d6a8c96750e7f96d7ab11ace76f7ba8 Mon Sep 17 00:00:00 2001 From: Dwilson_NV Date: Thu, 2 Aug 2018 10:08:49 -0500 Subject: Documentation Update Expanded information about CreateInputParams member variables --- CHANGELOG.md | 4 + doc/html/_c_h_a_n_g_e_l_o_g_8md_source.html | 2 +- doc/html/config_8h_source.html | 6 +- doc/html/dir_21dfd2273a7f43571f69ea7d9a7bef28.html | 101 ++++++++++++++++++++ doc/html/dir_21dfd2273a7f43571f69ea7d9a7bef28.js | 4 + doc/html/dir_5dcaa289b4249f1f80d9a0096774c521.html | 101 ++++++++++++++++++++ doc/html/dir_5dcaa289b4249f1f80d9a0096774c521.js | 4 + doc/html/dir_7d6569e3afa6c3a9528328a9b8f74487.html | 101 ++++++++++++++++++++ doc/html/dir_7d6569e3afa6c3a9528328a9b8f74487.js | 6 ++ doc/html/dir_c8951a4514ffd6dca1d0bd1443098010.html | 105 +++++++++++++++++++++ doc/html/dir_c8951a4514ffd6dca1d0bd1443098010.js | 4 + doc/html/dir_e789e2e8a554a90f7e478c85f971e5ee.html | 101 ++++++++++++++++++++ doc/html/dir_e789e2e8a554a90f7e478c85f971e5ee.js | 6 ++ doc/html/dir_eab758979aa93160875026eddee5dc76.html | 105 +++++++++++++++++++++ doc/html/dir_eab758979aa93160875026eddee5dc76.js | 4 + doc/html/files.html | 6 +- doc/html/files.js | 2 +- doc/html/gfe3__product__version_8h_source.html | 6 +- doc/html/ihighlights_8h_source.html | 2 +- doc/html/isdk_8h_source.html | 8 +- doc/html/isdk__cpp__impl_8h_source.html | 22 ++--- ...pace_dev_sdkwinauto_doc__c_h_a_n_g_e_l_o_g.html | 7 +- doc/html/navtreeindex0.js | 6 +- doc/html/sdk__types_8h.html | 4 +- doc/html/sdk__types_8h_source.html | 26 ++--- doc/html/sdk__types__ipc_8h_source.html | 6 +- .../struct_n_v_g_s_d_k___create_input_params.html | 4 +- doc/html/struct_n_v_g_s_d_k___create_response.html | 2 +- doc/html/struct_n_v_g_s_d_k___language.html | 2 +- ...t_n_v_g_s_d_k___request_permissions_params.html | 2 +- doc/img/button.png | Bin 0 -> 68026 bytes doc/img/permission.png | Bin 96609 -> 46783 bytes 32 files changed, 705 insertions(+), 54 deletions(-) create mode 100644 doc/html/dir_21dfd2273a7f43571f69ea7d9a7bef28.html create mode 100644 doc/html/dir_21dfd2273a7f43571f69ea7d9a7bef28.js create mode 100644 doc/html/dir_5dcaa289b4249f1f80d9a0096774c521.html create mode 100644 doc/html/dir_5dcaa289b4249f1f80d9a0096774c521.js create mode 100644 doc/html/dir_7d6569e3afa6c3a9528328a9b8f74487.html create mode 100644 doc/html/dir_7d6569e3afa6c3a9528328a9b8f74487.js create mode 100644 doc/html/dir_c8951a4514ffd6dca1d0bd1443098010.html create mode 100644 doc/html/dir_c8951a4514ffd6dca1d0bd1443098010.js create mode 100644 doc/html/dir_e789e2e8a554a90f7e478c85f971e5ee.html create mode 100644 doc/html/dir_e789e2e8a554a90f7e478c85f971e5ee.js create mode 100644 doc/html/dir_eab758979aa93160875026eddee5dc76.html create mode 100644 doc/html/dir_eab758979aa93160875026eddee5dc76.js create mode 100644 doc/img/button.png diff --git a/CHANGELOG.md b/CHANGELOG.md index 1f9ebcc..0ab6560 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ # Changelog +## NVIDIA GfeSDK 1.1 (2018-08-1) +### Improvements +* **Documentation** Expanded information about CreateInputParams member variables + ## NVIDIA GfeSDK 1.1 (2018-04-11) ### Improvements * **Buildable Sample** Sample application now have sample settings, allowing it to be optimized with GeforceExperience UI diff --git a/doc/html/_c_h_a_n_g_e_l_o_g_8md_source.html b/doc/html/_c_h_a_n_g_e_l_o_g_8md_source.html index 0ccc95e..7bc92b2 100644 --- a/doc/html/_c_h_a_n_g_e_l_o_g_8md_source.html +++ b/doc/html/_c_h_a_n_g_e_l_o_g_8md_source.html @@ -85,7 +85,7 @@ $(document).ready(function(){initNavTree('_c_h_a_n_g_e_l_o_g_8md.html','');});
C:/u/workspace/dev/sdkwinauto/doc/CHANGELOG.md
-
1 # Changelog
2 
3 ## NVIDIA GfeSDK 1.1 (2018-04-11)
4 ### Improvements
5 * **Buildable Sample** Sample application now have sample settings, allowing it to be optimized with GeforceExperience UI
6 * **Include cleanup** Include headers cleanup
7 
8 ## NVIDIA GfeSDK 1.1 (2018-03-15)
9 ### Bug Fixes
10 * **Fix Crash** Fix crash when passing NULL handle to C APIs like GetUILanguage
11 * **Include fix** Fix problem where wchar.h was getting stuck in GfeSDK namespace
12 
13 ### Other
14 * **Renaming** Renaming "NVIDIA Shadowplay Highlights" to "NVIDIA Highlights" in docs
15 
16 ## NVIDIA GfeSDK 1.1 (2018-03-08)
17 ### Improvements
18 * **Buildable Sample** Fix release configurations of sample, and fix compiler errors
19 
20 ## NVIDIA GfeSDK 1.1 (2018-02-28)
21 ### Improvements
22 * **Documentation** Top level documentation improvements
23 * **Buildable Sample** Include a simple DXUT buildable sample in the distribution, demonstrating API calls
24 * **Spectre/Meltdown** Compile with /Qspectre protection
25 * **Assets** Add final assets and image guide
26 
27 ### Bug Fixes
28 * **Fix Crash** Fix race condition on startup
29 
30 ## NVIDIA GfeSDK 1.1 (2018-01-22)
31 
32 ### API Changes
33 * **SDK version incremented to 1.1** Allows old SDK clients to work with upcoming 3.13 GFE
34 * **Highlights Config parameters validation** Rejects Highlights of invalid type and significance
35 
36 ## NVIDIA GfeSDK 1.0 (2018-01-16)
37 
38 ### Features for GFE 3.13+
39 * **Target PID** Add support for whitelisted apps to record another process's PID
40 
41 ### API Changes
42 * **Target PID** Added to NVGSDK_Create call
43 * **Unannounced Highlight Type** To prevent showing Highlights notifications for certain applications
44 
45 ### Bug Fixes
46 * **Fix Crash** Was occasionally crashing when communication with the backend could not be established
47 
48 ## NVIDIA GfeSDK 1.0 (2017-08-01)
49 
50 ### API Changes
51 * **Timeout:** Was returning NVGSDK_ERR_GENERIC when IPC call timed now. Now returning NVGSDK_ERR_IPC_FAILED
52 * **windows.h:** Removed windows.h from public includes
53 * **globals:** Removed macros from global namespace
54 * **stdint:** Standardize on stdint types
55 * **stdbool:** Use stdbool in C API instead of integer 0/1
56 * **namespace:** Renamed namespace from gfesdk to GfeSDK, and wrapped C API in namespace when using C++ bindings
57 * **Highlights split:** Split all Highlights features into their own headers
58 * **C++ Bindings RAII:** Update C++ bindings to follow recognized C++ idioms
59 * **package structure:** Standardize package structure to look like other GameWorks packages
60 * **Typed Callbacks:** Return typed callback data instead of void*
61 * **Naming:** Match naming standard to other GameWorks packages
62 
63 ### Improvements
64 * **Thread Model**: Improve thread model. Prevent callbacks from occurring after Release. Allow Polling of callbacks
65 * **Documentation**: Improved and expanded documentation
66 
67 ### Bug Fixes
68 * **Whitelist:** Fix error causing ShadowPlay to not whitelist game correctly.
69 * **Fix crash:** Was crashing when the same game ran twice.
70 * **Input validation:** Added input validation to return an error for C++ create instead of crash
71 * **Timeout return value:** Was returning NVGSDK_ERR_GENERIC instead of NVGSDK_ERR_IPC_FAILED
72 
73 ### Features for GFE 3.9+
74 * **In-Game Overlay Notification:** Notify the app when the in-game overlay opens or closes.
75 
76 ## NVIDIA GfeSDK 1.0 (2017-07-10)
77 
78 ### Features for GFE 3.8+
79 
80 * **NVIDIA Highlights** Help Gamers automatically capture their most exciting gaming moments.
81 
+
1 # Changelog
2 
3 ## NVIDIA GfeSDK 1.1 (2018-08-1)
4 ### Improvements
5 * **Documentation** Expanded information about CreateInputParams member variables
6 
7 ## NVIDIA GfeSDK 1.1 (2018-04-11)
8 ### Improvements
9 * **Buildable Sample** Sample application now have sample settings, allowing it to be optimized with GeforceExperience UI
10 * **Include cleanup** Include headers cleanup
11 
12 ## NVIDIA GfeSDK 1.1 (2018-03-15)
13 ### Bug Fixes
14 * **Fix Crash** Fix crash when passing NULL handle to C APIs like GetUILanguage
15 * **Include fix** Fix problem where wchar.h was getting stuck in GfeSDK namespace
16 
17 ### Other
18 * **Renaming** Renaming "NVIDIA Shadowplay Highlights" to "NVIDIA Highlights" in docs
19 
20 ## NVIDIA GfeSDK 1.1 (2018-03-08)
21 ### Improvements
22 * **Buildable Sample** Fix release configurations of sample, and fix compiler errors
23 
24 ## NVIDIA GfeSDK 1.1 (2018-02-28)
25 ### Improvements
26 * **Documentation** Top level documentation improvements
27 * **Buildable Sample** Include a simple DXUT buildable sample in the distribution, demonstrating API calls
28 * **Spectre/Meltdown** Compile with /Qspectre protection
29 * **Assets** Add final assets and image guide
30 
31 ### Bug Fixes
32 * **Fix Crash** Fix race condition on startup
33 
34 ## NVIDIA GfeSDK 1.1 (2018-01-22)
35 
36 ### API Changes
37 * **SDK version incremented to 1.1** Allows old SDK clients to work with upcoming 3.13 GFE
38 * **Highlights Config parameters validation** Rejects Highlights of invalid type and significance
39 
40 ## NVIDIA GfeSDK 1.0 (2018-01-16)
41 
42 ### Features for GFE 3.13+
43 * **Target PID** Add support for whitelisted apps to record another process's PID
44 
45 ### API Changes
46 * **Target PID** Added to NVGSDK_Create call
47 * **Unannounced Highlight Type** To prevent showing Highlights notifications for certain applications
48 
49 ### Bug Fixes
50 * **Fix Crash** Was occasionally crashing when communication with the backend could not be established
51 
52 ## NVIDIA GfeSDK 1.0 (2017-08-01)
53 
54 ### API Changes
55 * **Timeout:** Was returning NVGSDK_ERR_GENERIC when IPC call timed now. Now returning NVGSDK_ERR_IPC_FAILED
56 * **windows.h:** Removed windows.h from public includes
57 * **globals:** Removed macros from global namespace
58 * **stdint:** Standardize on stdint types
59 * **stdbool:** Use stdbool in C API instead of integer 0/1
60 * **namespace:** Renamed namespace from gfesdk to GfeSDK, and wrapped C API in namespace when using C++ bindings
61 * **Highlights split:** Split all Highlights features into their own headers
62 * **C++ Bindings RAII:** Update C++ bindings to follow recognized C++ idioms
63 * **package structure:** Standardize package structure to look like other GameWorks packages
64 * **Typed Callbacks:** Return typed callback data instead of void*
65 * **Naming:** Match naming standard to other GameWorks packages
66 
67 ### Improvements
68 * **Thread Model**: Improve thread model. Prevent callbacks from occurring after Release. Allow Polling of callbacks
69 * **Documentation**: Improved and expanded documentation
70 
71 ### Bug Fixes
72 * **Whitelist:** Fix error causing ShadowPlay to not whitelist game correctly.
73 * **Fix crash:** Was crashing when the same game ran twice.
74 * **Input validation:** Added input validation to return an error for C++ create instead of crash
75 * **Timeout return value:** Was returning NVGSDK_ERR_GENERIC instead of NVGSDK_ERR_IPC_FAILED
76 
77 ### Features for GFE 3.9+
78 * **In-Game Overlay Notification:** Notify the app when the in-game overlay opens or closes.
79 
80 ## NVIDIA GfeSDK 1.0 (2017-07-10)
81 
82 ### Features for GFE 3.8+
83 
84 * **NVIDIA Highlights** Help Gamers automatically capture their most exciting gaming moments.
85 
diff --git a/doc/html/config_8h_source.html b/doc/html/config_8h_source.html index cf199e8..f9b71cb 100644 --- a/doc/html/config_8h_source.html +++ b/doc/html/config_8h_source.html @@ -6,7 +6,7 @@ -NVIDIAGeForceExperienceSDK: C:/u/workspace/dev/sdkwinauto/_build/x64-release/sdk/include/gfesdk/config.h Source File +NVIDIAGeForceExperienceSDK: C:/u/workspace/dev/sdkwinauto/_build/x64-release-uwp/sdk/include/gfesdk/config.h Source File @@ -85,13 +85,13 @@ $(document).ready(function(){initNavTree('config_8h_source.html','');});
config.h
-
1 /* Copyright (c) 2016, NVIDIA CORPORATION. All rights reserved.
2  *
3  * NVIDIA CORPORATION and its licensors retain all intellectual property
4  * and proprietary rights in and to this software, related documentation
5  * and any modifications thereto. Any use, reproduction, disclosure or
6  * distribution of this software and related documentation without an express
7  * license agreement from NVIDIA CORPORATION is strictly prohibited.
8  */
9 
10 // Warning: This file is generated. Do not edit
11 
12 #ifndef _NVGSDK_CONFIG_H_
13 #define _NVGSDK_CONFIG_H_
14 
15 #include "gfe3_product_version.h"
16 
17 #define NVGSDK_PROJECT_NAME "GfeSDK"
18 
19 #define NVGSDK_VERSION_MAJOR 1
20 #define NVGSDK_VERSION_MINOR 1
21 #define NVGSDK_BUILD_NUMBER 201
22 #define NVGSDK_BUILD_HASH 4c06af57
23 #define NVGSDK_BUILD_HASH_STR "4c06af57"
24 
25 #endif // _NVGSDK_CONFIG_H_
+
1 /* Copyright (c) 2016, NVIDIA CORPORATION. All rights reserved.
2  *
3  * NVIDIA CORPORATION and its licensors retain all intellectual property
4  * and proprietary rights in and to this software, related documentation
5  * and any modifications thereto. Any use, reproduction, disclosure or
6  * distribution of this software and related documentation without an express
7  * license agreement from NVIDIA CORPORATION is strictly prohibited.
8  */
9 
10 // Warning: This file is generated. Do not edit
11 
12 #ifndef _NVGSDK_CONFIG_H_
13 #define _NVGSDK_CONFIG_H_
14 
15 #include "gfe3_product_version.h"
16 
17 #define NVGSDK_PROJECT_NAME "GfeSDK"
18 
19 #define NVGSDK_VERSION_MAJOR 1
20 #define NVGSDK_VERSION_MINOR 1
21 #define NVGSDK_BUILD_NUMBER 217
22 #define NVGSDK_BUILD_HASH 10bac95d
23 #define NVGSDK_BUILD_HASH_STR "10bac95d"
24 
25 #endif // _NVGSDK_CONFIG_H_