Configuration for initializing graphics interop on an EP factory. More...

#include <onnxruntime_c_api.h>

Public Attributes
uint32_t	version

OrtGraphicsApi	graphics_api

void *	command_queue
	Command queue/submission queue for graphics workloads (optional).

const OrtKeyValuePairs *	additional_options
	Additional API-specific options (optional).

Detailed Description

Configuration for initializing graphics interop on an EP factory.

This structure contains all parameters needed to set up graphics interop between ONNX Runtime and an external graphics API (D3D12, Vulkan). The factory stores this configuration and uses it when creating synchronization streams.

Design rationale:

Single init function with all required params to avoid multiple init signatures
Factory stores the context and uses it in stream creation
Supports extensibility via additional_options for future requirements

Example usage for D3D12:

const OrtInteropApi* interop_api = ort_api->GetInteropApi();
OrtGraphicsInteropConfig config = {0};
config.version = ORT_API_VERSION;
config.graphics_api = ORT_GRAPHICS_API_D3D12;
config.command_queue = my_d3d12_command_queue;  // ID3D12CommandQueue*
status = interop_api->InitGraphicsInteropForEpDevice(ep_device, &config);

Note: The version field must be set to ORT_API_VERSION. This ensures forward compatibility as fields may be added in future versions.

Since: Version 1.25.

Member Data Documentation

◆ additional_options

const OrtKeyValuePairs* OrtGraphicsInteropConfig::additional_options

Additional API-specific options (optional).

Can be used for future extensibility without changing the struct layout. For example, D3D12 fence sharing flags or provider-specific options like onnxruntime::nv::provider_option_names::kExternalComputeQueueDataParamNV_data for Vulkan interop for the NvTensorRTRTX provider.

◆ command_queue

void* OrtGraphicsInteropConfig::command_queue

Command queue/submission queue for graphics workloads (optional).

Optional. When provided, the factory may use it for efficient GPU-side synchronization with inference streams (performance optimization). When null, the Interop API still works; streams use the default context.

For D3D12: ID3D12CommandQueue* For Vulkan: pass NULL

◆ graphics_api

OrtGraphicsApi OrtGraphicsInteropConfig::graphics_api

The graphics API to use for interop

◆ version

uint32_t OrtGraphicsInteropConfig::version