NGFX API#

The NGFX API offers capabilities for programmatic control of applications integrating with Nsight Graphics.

It is an evoluation of the Injection API and should be preferred for all D3D12 and Vulkan applications.

Macros#

NGFX_FUNCTION
NGFX_GLOBAL
NGFX_GraphicsCapture_InitializeActivity_D3D12_Params_V1_VER
NGFX_GraphicsCapture_InitializeActivity_D3D12_Params_VER
NGFX_GraphicsCapture_Inject_D3D12_Params_V1_VER
NGFX_GraphicsCapture_Inject_D3D12_Params_VER
NGFX_GraphicsCapture_InjectionSettings_V1_VER
NGFX_GraphicsCapture_InjectionSettings_VER
NGFX_GraphicsCapture_RequestCapture_D3D12_Params_V1_VER
NGFX_GraphicsCapture_RequestCapture_D3D12_Params_VER
NGFX_GraphicsCapture_StartCapture_D3D12_Params_V1_VER
NGFX_GraphicsCapture_StartCapture_D3D12_Params_VER
NGFX_GraphicsCapture_StopCapture_D3D12_Params_V1_VER
NGFX_GraphicsCapture_StopCapture_D3D12_Params_VER
NGFX_INVALID_U32
NGFX_INVALID_U64
NGFX_LITERAL
NGFX_MAYBE_UNUSED
NGFX_SystemProfiling_InitializeActivity_D3D12_Params_V1_VER
NGFX_SystemProfiling_InitializeActivity_D3D12_Params_VER
NGFX_SystemProfiling_Inject_D3D12_Params_V1_VER
NGFX_SystemProfiling_Inject_D3D12_Params_VER
NGFX_SystemProfiling_InjectionSettings_V1_VER
NGFX_SystemProfiling_InjectionSettings_VER
NGFX_SystemProfiling_StartProfiling_D3D12_Params_V1_VER
NGFX_SystemProfiling_StartProfiling_D3D12_Params_VER
NGFX_SystemProfiling_StopProfiling_D3D12_Params_V1_VER
NGFX_SystemProfiling_StopProfiling_D3D12_Params_VER
NGFX_VAR_LNAME
NGFX_VAR_NAME

Enumerations#

NGFX_ActivityType: Enum representing the type of activity made available by Nsight Graphics.
NGFX_ApiType: Enum representing the API of the activity that will be analyzed.
NGFX_For_Dlss_DLSS_FG_PresentBoundaryType: Enum representing the workload boundary reported by Streamline for frame generation.
NGFX_GraphicsCapture_Compression
NGFX_GraphicsCapture_Delimiter: Enum representing the type of delimiter used for graphics capture.
NGFX_GraphicsCapture_HudPosition
NGFX_GraphicsCapture_HvvmMode
NGFX_Injection_SKU: Enum representing the distribution/SKU of Nsight Graphics.
NGFX_Result: Enum representing the result of an API operation.

Functions#

NGFX_Result NGFX_DLSS_FG_PresentBoundary_D3D12(NGFX_DLSS_FG_PresentBoundary_D3D12_Params *params): Delimits sub-events when Streamline frame generation processes a Present call into generated and real frames.
NGFX_Result NGFX_DLSS_FG_PresentBoundary_Vulkan(NGFX_DLSS_FG_PresentBoundary_Vulkan_Params *params): Delimits sub-events when Streamline frame generation processes a Present call into generated and real frames.
NGFX_Result NGFX_FrameBoundary_CUDA(NGFX_FrameBoundary_CUDA_Params *params): Delimits a CUDA frame.
NGFX_Result NGFX_FrameBoundary_CUDART(NGFX_FrameBoundary_CUDART_Params *params): Delimits a CUDART frame.
NGFX_Result NGFX_FrameBoundary_D3D12(NGFX_FrameBoundary_D3D12_Params *params): Delimits a D3D12 frame and optionally provides information about the associated resources.
NGFX_Result NGFX_FrameBoundary_OpenGL(NGFX_FrameBoundary_OpenGL_Params *params): Delimits a OpenGL frame and optionally provides information about the associated resources.
NGFX_Result NGFX_FrameBoundary_Vulkan(NGFX_FrameBoundary_Vulkan_Params *params): Delimits a Vulkan frame and optionally provides information about the associated resources.
NGFX_Result NGFX_GPUTrace_ActivateTrace_CUDA(NGFX_GPUTrace_ActivateTrace_CUDA_Params *params): Activates the GPU Trace activity.
NGFX_Result NGFX_GPUTrace_ActivateTrace_CUDART(NGFX_GPUTrace_ActivateTrace_CUDART_Params *params): Activates the GPU Trace activity.
NGFX_Result NGFX_GPUTrace_ActivateTrace_D3D12(NGFX_GPUTrace_ActivateTrace_D3D12_Params *params): Activates the GPU Trace activity.
NGFX_Result NGFX_GPUTrace_ActivateTrace_OpenGL(NGFX_GPUTrace_ActivateTrace_OpenGL_Params *params): Activates the GPU Trace activity.
NGFX_Result NGFX_GPUTrace_ActivateTrace_Vulkan(NGFX_GPUTrace_ActivateTrace_Vulkan_Params *params): Activates the GPU Trace activity.
NGFX_Result NGFX_GPUTrace_GetStatus(NGFX_GPUTrace_GetStatus_Params *params): Retrieves the current status of the GPU Trace activity.
NGFX_Result NGFX_GPUTrace_InitializeActivity_CUDA(NGFX_GPUTrace_InitializeActivity_CUDA_Params *params): Initialize the GPU Trace activity in an already injected CUDA application.
NGFX_Result NGFX_GPUTrace_InitializeActivity_CUDART(NGFX_GPUTrace_InitializeActivity_CUDART_Params *params): Initialize the GPU Trace activity in an already injected CUDART application.
NGFX_Result NGFX_GPUTrace_InitializeActivity_D3D12(NGFX_GPUTrace_InitializeActivity_D3D12_Params *params): Initialize the GPU Trace activity in an already injected D3D12 application.
NGFX_Result NGFX_GPUTrace_InitializeActivity_OpenGL(NGFX_GPUTrace_InitializeActivity_OpenGL_Params *params): Initialize the GPU Trace activity in an already injected OpenGL application.
NGFX_Result NGFX_GPUTrace_InitializeActivity_Vulkan(NGFX_GPUTrace_InitializeActivity_Vulkan_Params *params): Initialize the GPU Trace activity in an already injected Vulkan application.
NGFX_Result NGFX_GPUTrace_Inject_CUDA(NGFX_GPUTrace_Inject_CUDA_Params *params): Injects the GPU Trace activity into a CUDA application.
NGFX_Result NGFX_GPUTrace_Inject_CUDART(NGFX_GPUTrace_Inject_CUDART_Params *params): Injects the GPU Trace activity into a CUDART application.
NGFX_Result NGFX_GPUTrace_Inject_D3D12(NGFX_GPUTrace_Inject_D3D12_Params *params): Injects the GPU Trace activity into a D3D12 application.
NGFX_Result NGFX_GPUTrace_Inject_OpenGL(NGFX_GPUTrace_Inject_OpenGL_Params *params): Injects the GPU Trace activity into a OpenGL application.
NGFX_Result NGFX_GPUTrace_Inject_Vulkan(NGFX_GPUTrace_Inject_Vulkan_Params *params): Injects the GPU Trace activity into a Vulkan application.
NGFX_Result NGFX_GPUTrace_InjectionSettings_SetDefaults(NGFX_GPUTrace_InjectionSettings *settings): Initialize Ngfx_GPUTrace_InjectionSettings struct with default values.
NGFX_Result NGFX_GPUTrace_IsInitialized(bool *initialized): Checks if the GPU Trace activity is currently initialized.
NGFX_Result NGFX_GPUTrace_IsInjected(bool *injected): Checks if the GPU Trace activity is currently injected.
NGFX_Result NGFX_GPUTrace_StartTrace_CUDA(NGFX_GPUTrace_StartTrace_CUDA_Params *params): Starts a Trace of the application.
NGFX_Result NGFX_GPUTrace_StartTrace_CUDART(NGFX_GPUTrace_StartTrace_CUDART_Params *params): Starts a Trace of the application.
NGFX_Result NGFX_GPUTrace_StartTrace_D3D12(NGFX_GPUTrace_StartTrace_D3D12_Params *params): Starts a Trace of the application.
NGFX_Result NGFX_GPUTrace_StartTrace_OpenGL(NGFX_GPUTrace_StartTrace_OpenGL_Params *params)
NGFX_Result NGFX_GPUTrace_StartTrace_Vulkan(NGFX_GPUTrace_StartTrace_Vulkan_Params *params)
NGFX_Result NGFX_GPUTrace_StopTrace_CUDA(NGFX_GPUTrace_StopTrace_CUDA_Params *params): Stops a previously started Trace.
NGFX_Result NGFX_GPUTrace_StopTrace_CUDART(NGFX_GPUTrace_StopTrace_CUDART_Params *params): Stops a previously started Trace.
NGFX_Result NGFX_GPUTrace_StopTrace_D3D12(NGFX_GPUTrace_StopTrace_D3D12_Params *params): Stops a previously started Trace.
NGFX_Result NGFX_GPUTrace_StopTrace_OpenGL(NGFX_GPUTrace_StopTrace_OpenGL_Params *params): Stops a previously started Trace.
NGFX_Result NGFX_GPUTrace_StopTrace_Vulkan(NGFX_GPUTrace_StopTrace_Vulkan_Params *params): Stops a previously started Trace.
NGFX_Result NGFX_GPUTrace_WaitForStatus(NGFX_GPUTrace_WaitForStatus_Params *params): Waits for the GPU Trace activity to reach a specific status.
NGFX_Result NGFX_GraphicsCapture_InitializeActivity_D3D12(NGFX_GraphicsCapture_InitializeActivity_D3D12_Params *params): Initialize the Graphics capture activity in an already injected D3D12 application.
NGFX_Result NGFX_GraphicsCapture_InitializeActivity_Vulkan(NGFX_GraphicsCapture_InitializeActivity_Vulkan_Params *params): Initialize the Graphics capture activity in an already injected Vulkan application.
NGFX_Result NGFX_GraphicsCapture_Inject_D3D12(NGFX_GraphicsCapture_Inject_D3D12_Params *params): Injects the GraphicsCapture activity into a D3D12 application.
NGFX_Result NGFX_GraphicsCapture_Inject_Vulkan(NGFX_GraphicsCapture_Inject_Vulkan_Params *params): Injects the GraphicsCapture activity into a Vulkan application.
NGFX_Result NGFX_GraphicsCapture_InjectionSettings_SetDefaults(NGFX_GraphicsCapture_InjectionSettings *settings): Initialize NGFX_GraphicsCapture_InjectionSettings struct with default values.
NGFX_Result NGFX_GraphicsCapture_RequestCapture_D3D12(NGFX_GraphicsCapture_RequestCapture_D3D12_Params *params): Requests that a capture begin at the start of the next delimiter.
NGFX_Result NGFX_GraphicsCapture_RequestCapture_Vulkan(NGFX_GraphicsCapture_RequestCapture_Vulkan_Params *params): Requests that a capture begin at the start of the next delimiter.
NGFX_Result NGFX_GraphicsCapture_StartCapture_D3D12(NGFX_GraphicsCapture_StartCapture_D3D12_Params *params): Starts a Capture of the application.
NGFX_Result NGFX_GraphicsCapture_StartCapture_Vulkan(NGFX_GraphicsCapture_StartCapture_Vulkan_Params *params): Starts a Capture of the application.
NGFX_Result NGFX_GraphicsCapture_StopCapture_D3D12(NGFX_GraphicsCapture_StopCapture_D3D12_Params *params): Stops a previously started Capture of the application.
NGFX_Result NGFX_GraphicsCapture_StopCapture_Vulkan(NGFX_GraphicsCapture_StopCapture_Vulkan_Params *params): Stops a previously started Capture of the application.
NGFX_Result NGFX_SystemProfiling_InitializeActivity_D3D12(NGFX_SystemProfiling_InitializeActivity_D3D12_Params *params): Initialize the System profiling activity in an already injected D3D12 application.
NGFX_Result NGFX_SystemProfiling_InitializeActivity_Vulkan(NGFX_SystemProfiling_InitializeActivity_Vulkan_Params *params): Initialize the System profiling activity in an already injected Vulkan application.
NGFX_Result NGFX_SystemProfiling_Inject_D3D12(NGFX_SystemProfiling_Inject_D3D12_Params *params): Injects the SystemProfiling activity into a D3D12 application.
NGFX_Result NGFX_SystemProfiling_Inject_Vulkan(NGFX_SystemProfiling_Inject_Vulkan_Params *params): Injects the SystemProfiling activity into a Vulkan application.
NGFX_Result NGFX_SystemProfiling_InjectionSettings_SetDefaults(NGFX_SystemProfiling_InjectionSettings *settings): Initialize NGFX_SystemProfiling_InjectionSettings struct with default values.
NGFX_Result NGFX_SystemProfiling_StartProfiling_D3D12(NGFX_SystemProfiling_StartProfiling_D3D12_Params *params): Starts system profiling of the application.
NGFX_Result NGFX_SystemProfiling_StartProfiling_Vulkan(NGFX_SystemProfiling_StartProfiling_Vulkan_Params *params): Starts system profiling of the application.
NGFX_Result NGFX_SystemProfiling_StopProfiling_D3D12(NGFX_SystemProfiling_StopProfiling_D3D12_Params *params): Stops a previously started system profiling of the application.
NGFX_Result NGFX_SystemProfiling_StopProfiling_Vulkan(NGFX_SystemProfiling_StopProfiling_Vulkan_Params *params): Stops a previously started system profiling of the application.

Structs#

NGFX_GraphicsCapture_InitializeActivity_D3D12_Params_V1: Parameters for initializing a Graphics capture in a D3D12 application.
NGFX_GraphicsCapture_Inject_D3D12_Params_V1: Parameters for injecting GraphicsCapture into a D3D12 application.
NGFX_GraphicsCapture_InjectionSettings_V1: struct containing GraphicsCapture injection settings Note: these options mirror those displayed by ngfx-capture.exe help, which is a useful reference
NGFX_GraphicsCapture_RequestCapture_D3D12_Params_V1: Parameters for requesting a Graphics capture in a D3D12 application.
NGFX_GraphicsCapture_StartCapture_D3D12_Params_V1: Parameters for starting a Graphics capture in a D3D12 application.
NGFX_GraphicsCapture_StopCapture_D3D12_Params_V1: Parameters for stopping a Graphics capture in a D3D12 application.
NGFX_InstallationInfo: Structure containing information about an Nsight Graphics installation.
NGFX_SystemProfiling_InitializeActivity_D3D12_Params_V1: Parameters for initializing a System profiling activity in a D3D12 application.
NGFX_SystemProfiling_Inject_D3D12_Params_V1: Parameters for injecting SystemProfiling into a D3D12 application.
NGFX_SystemProfiling_InjectionSettings_V1: struct containing SystemProfiling injection settings
NGFX_SystemProfiling_StartProfiling_D3D12_Params_V1: Parameters for starting system profiling in a D3D12 application.
NGFX_SystemProfiling_StopProfiling_D3D12_Params_V1: Parameters for stopping system profiling in a D3D12 application.

Typedefs#

NGFX_GraphicsCapture_InitializeActivity_D3D12_Params
NGFX_GraphicsCapture_Inject_D3D12_Params
NGFX_GraphicsCapture_InjectionSettings
NGFX_GraphicsCapture_RequestCapture_D3D12_Params
NGFX_GraphicsCapture_StartCapture_D3D12_Params
NGFX_GraphicsCapture_StopCapture_D3D12_Params
NGFX_LoadLibraryFnPtr: Typedef for a callback function for library loading.
NGFX_PathChar
NGFX_SystemProfiling_InitializeActivity_D3D12_Params
NGFX_SystemProfiling_Inject_D3D12_Params
NGFX_SystemProfiling_InjectionSettings
NGFX_SystemProfiling_StartProfiling_D3D12_Params
NGFX_SystemProfiling_StopProfiling_D3D12_Params

Macros#

NGFX_FUNCTION#

NGFX_GLOBAL#

NGFX_GraphicsCapture_InitializeActivity_D3D12_Params_V1_VER#

NGFX_GraphicsCapture_InitializeActivity_D3D12_Params_VER#

NGFX_GraphicsCapture_Inject_D3D12_Params_V1_VER#

NGFX_GraphicsCapture_Inject_D3D12_Params_VER#

NGFX_GraphicsCapture_InjectionSettings_V1_VER#

NGFX_GraphicsCapture_InjectionSettings_VER#

NGFX_GraphicsCapture_RequestCapture_D3D12_Params_V1_VER#

NGFX_GraphicsCapture_RequestCapture_D3D12_Params_VER#

NGFX_GraphicsCapture_StartCapture_D3D12_Params_V1_VER#

NGFX_GraphicsCapture_StartCapture_D3D12_Params_VER#

NGFX_GraphicsCapture_StopCapture_D3D12_Params_V1_VER#

NGFX_GraphicsCapture_StopCapture_D3D12_Params_VER#

NGFX_INVALID_U32#

NGFX_INVALID_U64#

NGFX_LITERAL(x)#

NGFX_MAYBE_UNUSED#

NGFX_SystemProfiling_InitializeActivity_D3D12_Params_V1_VER#

NGFX_SystemProfiling_InitializeActivity_D3D12_Params_VER#

NGFX_SystemProfiling_Inject_D3D12_Params_V1_VER#

NGFX_SystemProfiling_Inject_D3D12_Params_VER#

NGFX_SystemProfiling_InjectionSettings_V1_VER#

NGFX_SystemProfiling_InjectionSettings_VER#

NGFX_SystemProfiling_StartProfiling_D3D12_Params_V1_VER#

NGFX_SystemProfiling_StartProfiling_D3D12_Params_VER#

NGFX_SystemProfiling_StopProfiling_D3D12_Params_V1_VER#

NGFX_SystemProfiling_StopProfiling_D3D12_Params_VER#

NGFX_VAR_LNAME#

NGFX_VAR_NAME#

Enumerations#

enum NGFX_ActivityType#

Enum representing the type of activity made available by Nsight Graphics.

Given the different needs of activities, there are activity-specific methods and activity-specific initialization that is required.

Values:

enumerator NGFX_ActivityType_GraphicsCapture#: Graphics Capture activity type.

enumerator NGFX_ActivityType_GPUTrace#: GPU Trace activity type.

enumerator NGFX_ActivityType_SystemProfiling#: System Profiling activity type.

enumerator NGFX_ActivityType_COUNT#: Total count of activity types.

enum NGFX_ApiType#

Enum representing the API of the activity that will be analyzed.

Given the different needs of activities, there are activity-specific methods and activity-specific initialization that is required.

Values:

enumerator NGFX_ApiType_D3D12#: D3D12 applications.

enumerator NGFX_ApiType_Vulkan#: Vulkan applications.

enumerator NGFX_ApiType_CUDA#: CUDA applications.

enumerator NGFX_ApiType_CUDART#: CUDA runtime applications.

enumerator NGFX_ApiType_OpenGL#: OpenGL applications.

enumerator NGFX_ApiType_COUNT#: Total count of APIs types.

enum NGFX_For_Dlss_DLSS_FG_PresentBoundaryType#

Enum representing the workload boundary reported by Streamline for frame generation.

Values:

enumerator NGFX_For_Dlss_DLSS_FG_PresentBoundaryType_Application_Present_Requested#: Streamline should report application present begin boundary with requested api parameters (even though this call may be completely reintepreted for FG)

enumerator NGFX_For_Dlss_DLSS_FG_PresentBoundaryType_Generated_Frame_Begin#: Streamline is generating and presenting a new frame and should report a generated frame id as well as the queue.

enumerator NGFX_For_Dlss_DLSS_FG_PresentBoundaryType_Generated_Frame_End#: Streamline is done with the generation and present of the new frame.

enumerator NGFX_For_Dlss_DLSS_FG_PresentBoundaryType_Real_Frame_Begin#

Streamline should issue this before any calls to present the “real frame” to the swapchain.

Note this present happens after any generated frame presents.

enumerator NGFX_For_Dlss_DLSS_FG_PresentBoundaryType_Real_Frame_End#

Streamline should issue this after any calls to present the “real frame” to the swapchain.

It’s assumed this resumes normal rendering by the app.

enum NGFX_GraphicsCapture_Compression#

Values:

enumerator NGFX_GraphicsCapture_COMPRESSION_DEFAULT#

enumerator NGFX_GraphicsCapture_COMPRESSION_NO#

enumerator NGFX_GraphicsCapture_COMPRESSION_HIGH#

enumerator NGFX_GraphicsCapture_COMPRESSION_COUNT#

enum NGFX_GraphicsCapture_Delimiter#

Enum representing the type of delimiter used for graphics capture.

Values:

enumerator NGFX_GraphicsCapture_Delimiter_Present#: Use Present to delimit a frame.

enumerator NGFX_GraphicsCapture_Delimiter_FrameBoundary#: Use NGFX FrameBoundary to delimit a frame.

enumerator NGFX_GraphicsCapture_Delimiter_VkFrameBoundaryEXT#: Use VK_Ext_frame_boundary to delimit a frame.

enum NGFX_GraphicsCapture_HudPosition#

Values:

enumerator NGFX_GraphicsCapture_HUD_POSITION_DEFAULT#

enumerator NGFX_GraphicsCapture_HUD_POSITION_TOP_LEFT#

enumerator NGFX_GraphicsCapture_HUD_POSITION_TOP_RIGHT#

enumerator NGFX_GraphicsCapture_HUD_POSITION_BOTTOM_LEFT#

enumerator NGFX_GraphicsCapture_HUD_POSITION_BOTTOM_RIGHT#

enumerator NGFX_GraphicsCapture_HUD_POSITION_TOP#

enumerator NGFX_GraphicsCapture_HUD_POSITION_LEFT#

enumerator NGFX_GraphicsCapture_HUD_POSITION_RIGHT#

enumerator NGFX_GraphicsCapture_HUD_POSITION_BOTTOM#

enumerator NGFX_GraphicsCapture_HUD_POSITION_COUNT#

enum NGFX_GraphicsCapture_HvvmMode#

Values:

enumerator NGFX_GraphicsCapture_HVVM_DEFAULT#

enumerator NGFX_GraphicsCapture_HVVM_DEMOTE#

enumerator NGFX_GraphicsCapture_HVVM_DISABLE#

enumerator NGFX_GraphicsCapture_HVVM_MANUAL_TRACKING#

enumerator NGFX_GraphicsCapture_HVVM_CPU_HASH#

enumerator NGFX_GraphicsCapture_HVVM_COUNT#

enum NGFX_Injection_SKU#

Enum representing the distribution/SKU of Nsight Graphics.

The sku indicates the distribution of Nsight Graphics (Public, Pro, Internal, etc.).

Values:

enumerator NGFX_Injection_SKU_UNKNOWN#: Unknown SKU type.

enumerator NGFX_Injection_SKU_PUBLIC#: Public distribution of Nsight Graphics.

enumerator NGFX_Injection_SKU_PRO#: Professional distribution of Nsight Graphics.

enumerator NGFX_Injection_SKU_INTERNAL#: Internal distribution of Nsight Graphics.

enum NGFX_Result#

Enum representing the result of an API operation.

Most functions within the NGFX Injection API will report a result code that identifies the success or failure of the operation.

Values:

enumerator NGFX_Result_Success#: Operation completed successfully.

enumerator NGFX_Result_NotImplemented#: The requested operation is not implemented.

enumerator NGFX_Result_LibNotFound#: The requested library could not be found.

enumerator NGFX_Result_InvalidLib#: An invalid library was specified.

enumerator NGFX_Result_DifferentActivityInjected#: A different activity is already injected.

enumerator NGFX_Result_InvalidParameter#: An invalid parameter was passed to the API.

enumerator NGFX_Result_InvalidState#: The operation cannot complete due to the current state of the API.

enumerator NGFX_Result_UnspecifiedError#: The requested operation could not be completed.

enumerator NGFX_Result_Timeout#: The operation timed out.

enumerator NGFX_Result_COUNT#: Total count of result codes.

Functions#

NGFX_Result NGFX_DLSS_FG_PresentBoundary_D3D12( NGFX_DLSS_FG_PresentBoundary_D3D12_Params *params, )#: Delimits sub-events when Streamline frame generation processes a Present call into generated and real frames.

NGFX_Result NGFX_DLSS_FG_PresentBoundary_Vulkan( NGFX_DLSS_FG_PresentBoundary_Vulkan_Params *params, )#: Delimits sub-events when Streamline frame generation processes a Present call into generated and real frames.

NGFX_Result NGFX_FrameBoundary_CUDA( NGFX_FrameBoundary_CUDA_Params *params, )#

Delimits a CUDA frame.

This function signals the boundary of a CUDA frame.

Parameters:: params – Pointer to a structure containing parameters for delimiting the frame.
Returns:: NGFX_Result_Success if the operation is successful, or an appropriate error code.

NGFX_Result NGFX_FrameBoundary_CUDART( NGFX_FrameBoundary_CUDART_Params *params, )#

Delimits a CUDART frame.

This function signals the boundary of a CUDART frame.

Parameters:: params – Pointer to a structure containing parameters for delimiting the frame.
Returns:: NGFX_Result_Success if the operation is successful, or an appropriate error code.

NGFX_Result NGFX_FrameBoundary_D3D12( NGFX_FrameBoundary_D3D12_Params *params, )#

Delimits a D3D12 frame and optionally provides information about the associated resources.

This function signals the boundary of a D3D12 frame. It can optionally provide information about the associated command queue and output resources that may be used by the activity as a hint for resources of interest.

Parameters:: params – Pointer to a structure containing parameters for delimiting the frame.
Returns:: NGFX_Result_Success if the operation is successful, or an appropriate error code.

NGFX_Result NGFX_FrameBoundary_OpenGL( NGFX_FrameBoundary_OpenGL_Params *params, )#

Delimits a OpenGL frame and optionally provides information about the associated resources.

This function signals the boundary of a OpenGL frame. The calling thread is required to have a current OpenGL context.

Parameters:: params – Pointer to a structure containing parameters for delimiting the frame.
Returns:: NGFX_Result_Success if the operation is successful, or an appropriate error code.

NGFX_Result NGFX_FrameBoundary_Vulkan( NGFX_FrameBoundary_Vulkan_Params *params, )#

Delimits a Vulkan frame and optionally provides information about the associated resources.

This function signals the boundary of a Vulkan frame. It can optionally provide information about the associated Vulkan queue and output resources that may be used by the activity as a hint for resources of interest.

Parameters:: params – Pointer to a structure containing parameters for delimiting the frame.
Returns:: NGFX_Result_Success if the operation is successful, or an appropriate error code.

NGFX_Result NGFX_GPUTrace_ActivateTrace_CUDA( NGFX_GPUTrace_ActivateTrace_CUDA_Params *params, )#