RTAS Parallel Operation - Extensions

oneAPI Level Zero Specification - Version 1.18.31

RTAS Parallel Operation - Extension Functions

zeRTASParallelOperationCreateExt

Added in version 1.13

ZE_APIEXPORT ze_result_t ZE_APICALL zeRTASParallelOperationCreateExt(ze_driver_handle_t hDriver, ze_rtas_parallel_operation_ext_handle_t *phParallelOperation)

Creates a ray tracing acceleration structure builder parallel operation object.

• The application may call this function from simultaneous threads.

• The implementation of this function must be thread-safe.

• The implementation must support ZE_RTAS_EXT_NAME extension.

Parameters:

• hDriver – [in] handle of driver object

• phParallelOperation – [out] handle of parallel operation object

Returns:

• ZE_RESULT_SUCCESS

• ZE_RESULT_ERROR_UNINITIALIZED

• ZE_RESULT_ERROR_DEVICE_LOST

• ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY

• ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY

• ZE_RESULT_ERROR_INVALID_ARGUMENT

• ZE_RESULT_ERROR_UNSUPPORTED_FEATURE

• ZE_RESULT_ERROR_DEPENDENCY_UNAVAILABLE

• ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS

• ZE_RESULT_ERROR_NOT_AVAILABLE

• ZE_RESULT_ERROR_DEVICE_REQUIRES_RESET

• ZE_RESULT_ERROR_DEVICE_IN_LOW_POWER_STATE

• ZE_RESULT_ERROR_UNKNOWN

• ZE_RESULT_ERROR_INVALID_NULL_HANDLE

  • nullptr == hDriver

• ZE_RESULT_ERROR_INVALID_NULL_POINTER

  • nullptr == phParallelOperation

zeRTASParallelOperationGetPropertiesExt

Added in version 1.13

ZE_APIEXPORT ze_result_t ZE_APICALL zeRTASParallelOperationGetPropertiesExt(ze_rtas_parallel_operation_ext_handle_t hParallelOperation, ze_rtas_parallel_operation_ext_properties_t *pProperties)

Retrieves ray tracing acceleration structure builder parallel operation properties.

• The application must first bind the parallel operation object to a build operation before it may query the parallel operation properties. In other words, the application must first call zeRTASBuilderBuildExt with hParallelOperation before calling this function.

• The application may call this function from simultaneous threads.

• The implementation of this function must be thread-safe.

Parameters:

• hParallelOperation – [in] handle of parallel operation object

• pProperties – [in,out] query result for parallel operation properties

Returns:

• ZE_RESULT_SUCCESS

• ZE_RESULT_ERROR_UNINITIALIZED

• ZE_RESULT_ERROR_DEVICE_LOST

• ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY

• ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY

• ZE_RESULT_ERROR_INVALID_ARGUMENT

• ZE_RESULT_ERROR_UNSUPPORTED_FEATURE

• ZE_RESULT_ERROR_DEPENDENCY_UNAVAILABLE

• ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS

• ZE_RESULT_ERROR_NOT_AVAILABLE

• ZE_RESULT_ERROR_DEVICE_REQUIRES_RESET

• ZE_RESULT_ERROR_DEVICE_IN_LOW_POWER_STATE

• ZE_RESULT_ERROR_UNKNOWN

• ZE_RESULT_ERROR_INVALID_NULL_HANDLE

  • nullptr == hParallelOperation

• ZE_RESULT_ERROR_INVALID_NULL_POINTER

  • nullptr == pProperties

zeRTASParallelOperationJoinExt

Added in version 1.13

ZE_APIEXPORT ze_result_t ZE_APICALL zeRTASParallelOperationJoinExt(ze_rtas_parallel_operation_ext_handle_t hParallelOperation)

Joins a parallel build operation.

• All worker threads return the same error code for the parallel build operation upon build completion

Parameters:

hParallelOperation – [in] handle of parallel operation object

Returns:

• ZE_RESULT_SUCCESS

• ZE_RESULT_ERROR_UNINITIALIZED

• ZE_RESULT_ERROR_DEVICE_LOST

• ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY

• ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY

• ZE_RESULT_ERROR_INVALID_ARGUMENT

• ZE_RESULT_ERROR_UNSUPPORTED_FEATURE

• ZE_RESULT_ERROR_DEPENDENCY_UNAVAILABLE

• ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS

• ZE_RESULT_ERROR_NOT_AVAILABLE

• ZE_RESULT_ERROR_DEVICE_REQUIRES_RESET

• ZE_RESULT_ERROR_DEVICE_IN_LOW_POWER_STATE

• ZE_RESULT_ERROR_UNKNOWN

• ZE_RESULT_ERROR_INVALID_NULL_HANDLE

  • nullptr == hParallelOperation

zeRTASParallelOperationDestroyExt

Added in version 1.13

ZE_APIEXPORT ze_result_t ZE_APICALL zeRTASParallelOperationDestroyExt(ze_rtas_parallel_operation_ext_handle_t hParallelOperation)

Destroys a ray tracing acceleration structure builder parallel operation object.

• The implementation of this function may immediately release any internal Host and Device resources associated with this parallel operation.

• The application must not call this function from simultaneous threads with the same parallel operation handle.

• The implementation of this function must be thread-safe.

Parameters:

hParallelOperation – [in][release] handle of parallel operation object to destroy

Returns:

• ZE_RESULT_SUCCESS

• ZE_RESULT_ERROR_UNINITIALIZED

• ZE_RESULT_ERROR_DEVICE_LOST

• ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY

• ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY

• ZE_RESULT_ERROR_INVALID_ARGUMENT

• ZE_RESULT_ERROR_UNSUPPORTED_FEATURE

• ZE_RESULT_ERROR_DEPENDENCY_UNAVAILABLE

• ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS

• ZE_RESULT_ERROR_NOT_AVAILABLE

• ZE_RESULT_ERROR_DEVICE_REQUIRES_RESET

• ZE_RESULT_ERROR_DEVICE_IN_LOW_POWER_STATE

• ZE_RESULT_ERROR_UNKNOWN

• ZE_RESULT_ERROR_INVALID_NULL_HANDLE

  • nullptr == hParallelOperation

RTAS Parallel Operation - Extension Enums

ze_rtas_parallel_operation_ext_flags_t

Added in version 1.13

enum ze_rtas_parallel_operation_ext_flag_t

Values:

enumerator ZE_RTAS_PARALLEL_OPERATION_EXT_FLAG_RESERVED

Reserved for future use.

enumerator ZE_RTAS_PARALLEL_OPERATION_EXT_FLAG_FORCE_UINT32

Value marking end of ZE_RTAS_PARALLEL_OPERATION_EXT_FLAG_* ENUMs.

RTAS Parallel Operation - Extension Structures

ze_rtas_parallel_operation_ext_properties_t

Added in version 1.13

struct ze_rtas_parallel_operation_ext_properties_t

Ray tracing acceleration structure builder parallel operation properties.

Public Members

ze_structure_type_t stype

[in] type of this structure

void *pNext

[in,out][optional] must be null or a pointer to an extension-specific structure (i.e. contains stype and pNext).

ze_rtas_parallel_operation_ext_flags_t flags

[out] ray tracing acceleration structure builder parallel operation flags

uint32_t maxConcurrency

[out] maximum number of threads that may join the parallel operation