Version: Unity 6.1 Alpha (6000.1)
LanguageEnglish
  • C#

UnityEngine.NVIDIAModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

A module that contains API you can use to interact with NVIDIA graphics cards.

To activate this module at runtime, call NVIDIA.Plugins.LoadPlugin with the NVIDIA.Plugins.Plugin.NVUnityPlugin value during application startup. The class NVIDIA.Device contains the APIs to interact with the graphics cards' specific features.

Classes

DLSSContextRepresents the state of DLSS.
GraphicsDeviceProvides the main entry point for the NVIDIA Module. Use this to interact with specific NVIDIA graphics card features.
GraphicsDeviceDebugViewRepresents a memory snapshot of the current feature states. The memory of the arrays/buffers in this struct are tied to the lifetime of the debug view. Additional resources: GraphicsDevice.CreateDebugView, GraphicsDevice.UpdateDebugView and GraphicsDevice.DeleteDebugView.
NVUnityPluginProvides methods to manage loading and unloading NVIDIA module plugins.

Structs

DLSSCommandExecutionDataRepresents the state of a DLSSContext. If you call Device.ExecuteDLSS, Unity sends the values in this struct to the runtime. After this, you can change the values in this struct without any side effects.
DLSSCommandInitializationDataRepresent the initialization state of a DLSSContext. You can only use and set this when calling GraphicsDevice.CreateFeature.
DLSSDebugFeatureInfosRepresents debug information for a particular DLSSContext.
DLSSTextureTableThe set of texture slots available for the DLSSContext. SA GraphicsDevice.ExecuteDLSS
OptimalDLSSSettingsDataRepresents the performance settings that DLSS recommends based on the system's graphics card and the size of the input and output color buffers. Additional resources: GraphicsDevice.GetOptimalSettings

Enumerations

DLSSFeatureFlagsOptions that represent subfeatures of DLSS.
DLSSQualityOptions for DLSS performance modes.
GraphicsDeviceFeatureLists every feature ID the GraphicsDevice API supports. For now, this only includes Deep Learning Super Sampling (DLSS). To check if the device supports a feature, call GraphicsDevice.IsFeatureAvailable.