aboutsummaryrefslogtreecommitdiff
path: root/include/ansel/Configuration.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/ansel/Configuration.h')
-rw-r--r--include/ansel/Configuration.h366
1 files changed, 183 insertions, 183 deletions
diff --git a/include/ansel/Configuration.h b/include/ansel/Configuration.h
index 742ba10..96169e4 100644
--- a/include/ansel/Configuration.h
+++ b/include/ansel/Configuration.h
@@ -1,183 +1,183 @@
-// This code contains NVIDIA Confidential Information and is disclosed to you
-// under a form of NVIDIA software license agreement provided separately to you.
-//
-// Notice
-// NVIDIA Corporation and its licensors retain all intellectual property and
-// proprietary rights in and to this software and related documentation and
-// any modifications thereto. Any use, reproduction, disclosure, or
-// distribution of this software and related documentation without an express
-// license agreement from NVIDIA Corporation is strictly prohibited.
-//
-// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
-// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
-// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
-// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
-//
-// Information and code furnished is believed to be accurate and reliable.
-// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
-// information or for any infringement of patents or other rights of third parties that may
-// result from its use. No license is granted by implication or otherwise under any patent
-// or patent rights of NVIDIA Corporation. Details are subject to change without notice.
-// This code supersedes and replaces all information previously supplied.
-// NVIDIA Corporation products are not authorized for use as critical
-// components in life support devices or systems without express written approval of
-// NVIDIA Corporation.
-//
-// Copyright 2016 NVIDIA Corporation. All rights reserved.
-
-#pragma once
-#include <ansel/Defines.h>
-#include <ansel/Session.h>
-#include <ansel/Version.h>
-#include <nv/Vec3.h>
-#include <stdint.h>
-
-namespace ansel
-{
- enum SetConfigurationStatus
- {
- // successfully initialized the Ansel SDK
- kSetConfigurationSuccess,
- // the version provided in the Configuration structure is not the same as the one stored inside the SDK binary (header/binary mismatch)
- kSetConfigurationIncompatibleVersion,
- // the Configuration structure supplied for the setConfiguration call is not consistent
- kSetConfigurationIncorrectConfiguration,
- // the Ansel SDK is delay loaded and setConfiguration is called before the SDK is actually loaded
- kSetConfigurationSdkNotLoaded
- };
-
- enum FovType
- {
- kHorizontalFov,
- kVerticalFov
- };
-
- struct Configuration
- {
- // Basis vectors used by the game. They specify the handedness and orientation of
- // the game's coordinate system. Think of them as the default orientation of the game
- // camera.
- nv::Vec3 right, up, forward;
- // The speed at which camera moves in the world
- float translationalSpeedInWorldUnitsPerSecond;
- // The speed at which camera rotates
- float rotationalSpeedInDegreesPerSecond;
- // How many frames it takes for camera update to be reflected in a rendered frame
- uint32_t captureLatency;
- // How many frames we must wait for a new frame to settle - i.e. temporal AA and similar
- // effects to stabilize after the camera has been adjusted
- uint32_t captureSettleLatency;
- // Game scale, the size of a world unit measured in meters
- float metersInWorldUnit;
- // Integration will support Camera::projectionOffsetX/projectionOffsetY
- bool isCameraOffcenteredProjectionSupported;
- // Integration will support Camera::position
- bool isCameraTranslationSupported;
- // Integration will support Camera::rotation
- bool isCameraRotationSupported;
- // Integration will support Camera::horizontalFov
- bool isCameraFovSupported;
- // Game name, in utf8 encoding, used to name the resulting image files from capturing.
- // It is not mandatory to set this field. The name chosen is based on the following
- // selection order:
- // 1. If GeForce profile exists for the game that name will be used
- // 2. If 'titleNameUtf8' is set that will be used
- // 3. The executable name is used as a last resort
- const char* titleNameUtf8;
- // Camera structure will contain vertical FOV if this is set to kVerticalFov
- // but horizontal FOV if this is set to kHorizontalFov. To simplify integration set
- // this to the same orientation as the game is using.
- FovType fovType;
-
- // These callbacks will be called on the same thread Present()/glSwapBuffers is called
- // The thread calling to updateCamera() might be a different thread
-
- // User defined pointer which is then passed to all the callbacks (nullptr by default)
- void* userPointer;
-
- // The window handle for the game/application where input messages are processed
- void* gameWindowHandle;
-
- // Called when user activates Ansel. Return kDisallowed if the game cannot comply with the
- // request. If the function returns kAllowed the following must be done:
- // 1. Change the SessionConfigruation settings, but only where you need to (the object
- // is already populated with default settings).
- // 2. On the next update loop the game will be in an Ansel session. During an Ansel session
- // the game :
- // a) Must stop drawing UI and HUD elements on the screen, including mouse cursor
- // b) Must call ansel::updateCamera on every frame
- // c) Should pause rendering time (i.e. no movement should be visible in the world)
- // d) Should not act on any input from mouse and keyboard and must not act on any input
- // from gamepads
- // 3. Step 2 is repeated on every iteration of update loop until Session is stopped.
- StartSessionCallback startSessionCallback;
-
- // Called when Ansel is deactivated. This call will only be made if the previous call
- // to the startSessionCallback returned kAllowed.
- // Normally games will use this callback to restore their camera to the settings it had
- // when the Ansel session was started.
- StopSessionCallback stopSessionCallback;
-
- // Called when the capture of a multipart shot (highres, 360, etc) has started.
- // Handy to disable those fullscreen effects that aren't uniform (like vignette)
- // This callback is optional (leave nullptr if not needed)
- StartCaptureCallback startCaptureCallback;
- // Called when the capture of a multipart shot (highres, 360, etc) has stopped.
- // Handy to enable those fullscreen effects that were disabled by startCaptureCallback.
- // This callback is optional (leave nullptr if not needed)
- StopCaptureCallback stopCaptureCallback;
- // The 'isFilterOutsideSessionAllowed' setting has been phased out in version 1.3 of the
- // SDK. This feature was only temporarily supported and no games took advantage of it.
- bool unused2;
- // The 'isExrSupported' setting has been phased out in version 1.1 of the SDK. Use
- // 'isRawAllowed' setting in SessionConfiguration to enable/disable captures into EXR
- // format.
- bool unused1;
- // Holds the sdk version, doesn't require modifications
- uint64_t sdkVersion;
-
- Configuration()
- {
- right.x = 0.0f;
- right.y = 1.0f;
- right.z = 0.0f;
- up.x = 0.0f;
- up.y = 0.0f;
- up.z = 1.0f;
- forward.x = 1.0f;
- forward.y = 0.0f;
- forward.z = 0.0f;
- translationalSpeedInWorldUnitsPerSecond = 1.0f;
- rotationalSpeedInDegreesPerSecond = 45.0f;
- captureLatency = 1;
- captureSettleLatency = 0;
- metersInWorldUnit = 1.0f;
- isCameraOffcenteredProjectionSupported = true;
- isCameraTranslationSupported = true;
- isCameraRotationSupported = true;
- isCameraFovSupported = true;
- titleNameUtf8 = nullptr;
- fovType = kHorizontalFov;
- userPointer = nullptr;
- gameWindowHandle = 0;
- startSessionCallback = nullptr;
- stopSessionCallback = nullptr;
- startCaptureCallback = nullptr;
- stopCaptureCallback = nullptr;
- unused2 = true;
- unused1 = false;
- sdkVersion = ANSEL_SDK_VERSION;
- }
- };
-
- // Called during startup by the game. See 'Configuration' for further documentation.
- ANSEL_SDK_API SetConfigurationStatus setConfiguration(const Configuration& cfg);
-
- // Can be called *after* D3D device has been created to see if Ansel is available.
- // If called prior to D3D device creation it will always return false.
- // Can be called *before* calling setConfiguration in which case it'll return true if Ansel is potentially available, otherwise false.
- // If setConfiguration fails for any reason this function will return false (even if Ansel would be available otherwise)
- // until a successfull call to setConfiguration has been made.
- ANSEL_SDK_API bool isAnselAvailable();
-}
-
+// This code contains NVIDIA Confidential Information and is disclosed to you
+// under a form of NVIDIA software license agreement provided separately to you.
+//
+// Notice
+// NVIDIA Corporation and its licensors retain all intellectual property and
+// proprietary rights in and to this software and related documentation and
+// any modifications thereto. Any use, reproduction, disclosure, or
+// distribution of this software and related documentation without an express
+// license agreement from NVIDIA Corporation is strictly prohibited.
+//
+// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
+// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
+// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
+// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
+//
+// Information and code furnished is believed to be accurate and reliable.
+// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
+// information or for any infringement of patents or other rights of third parties that may
+// result from its use. No license is granted by implication or otherwise under any patent
+// or patent rights of NVIDIA Corporation. Details are subject to change without notice.
+// This code supersedes and replaces all information previously supplied.
+// NVIDIA Corporation products are not authorized for use as critical
+// components in life support devices or systems without express written approval of
+// NVIDIA Corporation.
+//
+// Copyright 2016 NVIDIA Corporation. All rights reserved.
+
+#pragma once
+#include <ansel/Defines.h>
+#include <ansel/Session.h>
+#include <ansel/Version.h>
+#include <nv/Vec3.h>
+#include <stdint.h>
+
+namespace ansel
+{
+ enum SetConfigurationStatus
+ {
+ // successfully initialized the Ansel SDK
+ kSetConfigurationSuccess,
+ // the version provided in the Configuration structure is not the same as the one stored inside the SDK binary (header/binary mismatch)
+ kSetConfigurationIncompatibleVersion,
+ // the Configuration structure supplied for the setConfiguration call is not consistent
+ kSetConfigurationIncorrectConfiguration,
+ // the Ansel SDK is delay loaded and setConfiguration is called before the SDK is actually loaded
+ kSetConfigurationSdkNotLoaded
+ };
+
+ enum FovType
+ {
+ kHorizontalFov,
+ kVerticalFov
+ };
+
+ struct Configuration
+ {
+ // Basis vectors used by the game. They specify the handedness and orientation of
+ // the game's coordinate system. Think of them as the default orientation of the game
+ // camera.
+ nv::Vec3 right, up, forward;
+ // The speed at which camera moves in the world
+ float translationalSpeedInWorldUnitsPerSecond;
+ // The speed at which camera rotates
+ float rotationalSpeedInDegreesPerSecond;
+ // How many frames it takes for camera update to be reflected in a rendered frame
+ uint32_t captureLatency;
+ // How many frames we must wait for a new frame to settle - i.e. temporal AA and similar
+ // effects to stabilize after the camera has been adjusted
+ uint32_t captureSettleLatency;
+ // Game scale, the size of a world unit measured in meters
+ float metersInWorldUnit;
+ // Integration will support Camera::projectionOffsetX/projectionOffsetY
+ bool isCameraOffcenteredProjectionSupported;
+ // Integration will support Camera::position
+ bool isCameraTranslationSupported;
+ // Integration will support Camera::rotation
+ bool isCameraRotationSupported;
+ // Integration will support Camera::horizontalFov
+ bool isCameraFovSupported;
+ // Game name, in utf8 encoding, used to name the resulting image files from capturing.
+ // It is not mandatory to set this field. The name chosen is based on the following
+ // selection order:
+ // 1. If GeForce profile exists for the game that name will be used
+ // 2. If 'titleNameUtf8' is set that will be used
+ // 3. The executable name is used as a last resort
+ const char* titleNameUtf8;
+ // Camera structure will contain vertical FOV if this is set to kVerticalFov
+ // but horizontal FOV if this is set to kHorizontalFov. To simplify integration set
+ // this to the same orientation as the game is using.
+ FovType fovType;
+
+ // These callbacks will be called on the same thread Present()/glSwapBuffers is called
+ // The thread calling to updateCamera() might be a different thread
+
+ // User defined pointer which is then passed to all the callbacks (nullptr by default)
+ void* userPointer;
+
+ // The window handle for the game/application where input messages are processed
+ void* gameWindowHandle;
+
+ // Called when user activates Ansel. Return kDisallowed if the game cannot comply with the
+ // request. If the function returns kAllowed the following must be done:
+ // 1. Change the SessionConfigruation settings, but only where you need to (the object
+ // is already populated with default settings).
+ // 2. On the next update loop the game will be in an Ansel session. During an Ansel session
+ // the game :
+ // a) Must stop drawing UI and HUD elements on the screen, including mouse cursor
+ // b) Must call ansel::updateCamera on every frame
+ // c) Should pause rendering time (i.e. no movement should be visible in the world)
+ // d) Should not act on any input from mouse and keyboard and must not act on any input
+ // from gamepads
+ // 3. Step 2 is repeated on every iteration of update loop until Session is stopped.
+ StartSessionCallback startSessionCallback;
+
+ // Called when Ansel is deactivated. This call will only be made if the previous call
+ // to the startSessionCallback returned kAllowed.
+ // Normally games will use this callback to restore their camera to the settings it had
+ // when the Ansel session was started.
+ StopSessionCallback stopSessionCallback;
+
+ // Called when the capture of a multipart shot (highres, 360, etc) has started.
+ // Handy to disable those fullscreen effects that aren't uniform (like vignette)
+ // This callback is optional (leave nullptr if not needed)
+ StartCaptureCallback startCaptureCallback;
+ // Called when the capture of a multipart shot (highres, 360, etc) has stopped.
+ // Handy to enable those fullscreen effects that were disabled by startCaptureCallback.
+ // This callback is optional (leave nullptr if not needed)
+ StopCaptureCallback stopCaptureCallback;
+ // The 'isFilterOutsideSessionAllowed' setting has been phased out in version 1.3 of the
+ // SDK. This feature was only temporarily supported and no games took advantage of it.
+ bool unused2;
+ // The 'isExrSupported' setting has been phased out in version 1.1 of the SDK. Use
+ // 'isRawAllowed' setting in SessionConfiguration to enable/disable captures into EXR
+ // format.
+ bool unused1;
+ // Holds the sdk version, doesn't require modifications
+ uint64_t sdkVersion;
+
+ Configuration()
+ {
+ right.x = 0.0f;
+ right.y = 1.0f;
+ right.z = 0.0f;
+ up.x = 0.0f;
+ up.y = 0.0f;
+ up.z = 1.0f;
+ forward.x = 1.0f;
+ forward.y = 0.0f;
+ forward.z = 0.0f;
+ translationalSpeedInWorldUnitsPerSecond = 1.0f;
+ rotationalSpeedInDegreesPerSecond = 45.0f;
+ captureLatency = 1;
+ captureSettleLatency = 0;
+ metersInWorldUnit = 1.0f;
+ isCameraOffcenteredProjectionSupported = true;
+ isCameraTranslationSupported = true;
+ isCameraRotationSupported = true;
+ isCameraFovSupported = true;
+ titleNameUtf8 = nullptr;
+ fovType = kHorizontalFov;
+ userPointer = nullptr;
+ gameWindowHandle = 0;
+ startSessionCallback = nullptr;
+ stopSessionCallback = nullptr;
+ startCaptureCallback = nullptr;
+ stopCaptureCallback = nullptr;
+ unused2 = true;
+ unused1 = false;
+ sdkVersion = ANSEL_SDK_VERSION;
+ }
+ };
+
+ // Called during startup by the game. See 'Configuration' for further documentation.
+ ANSEL_SDK_API SetConfigurationStatus setConfiguration(const Configuration& cfg);
+
+ // Can be called *after* D3D device has been created to see if Ansel is available.
+ // If called prior to D3D device creation it will always return false.
+ // Can be called *before* calling setConfiguration in which case it'll return true if Ansel is potentially available, otherwise false.
+ // If setConfiguration fails for any reason this function will return false (even if Ansel would be available otherwise)
+ // until a successfull call to setConfiguration has been made.
+ ANSEL_SDK_API bool isAnselAvailable();
+}
+