API Documentation
API Documentation#
- Core API
- Registry
- Common
- Loader
- Adapter
- Platform
- Device
- Device Functions
- Device Enums
- ur_device_type_t
- ur_device_info_t
- ur_device_affinity_domain_flags_t
- ur_device_partition_t
- ur_device_fp_capability_flags_t
- ur_device_mem_cache_type_t
- ur_device_local_mem_type_t
- ur_device_exec_capability_flags_t
- ur_memory_order_capability_flags_t
- ur_memory_scope_capability_flags_t
- ur_device_usm_access_capability_flags_t
- Device Structures
- Device Macros
- UR_DEVICE_BINARY_TARGET_UNKNOWN
- UR_DEVICE_BINARY_TARGET_SPIRV32
- UR_DEVICE_BINARY_TARGET_SPIRV64
- UR_DEVICE_BINARY_TARGET_SPIRV64_X86_64
- UR_DEVICE_BINARY_TARGET_SPIRV64_GEN
- UR_DEVICE_BINARY_TARGET_SPIRV64_FPGA
- UR_DEVICE_BINARY_TARGET_NVPTX64
- UR_DEVICE_BINARY_TARGET_AMDGCN
- UR_DEVICE_BINARY_TARGET_NATIVE_CPU
- Context
- Memory
- Sampler
- Usm
- Virtual memory
- Program
- Program Functions
- urProgramCreateWithIL
- urProgramCreateWithBinary
- urProgramBuild
- urProgramCompile
- urProgramLink
- urProgramRetain
- urProgramRelease
- urProgramGetFunctionPointer
- urProgramGetGlobalVariablePointer
- urProgramGetInfo
- urProgramGetBuildInfo
- urProgramSetSpecializationConstants
- urProgramGetNativeHandle
- urProgramCreateWithNativeHandle
- Program Enums
- Program Structures
- Program Functions
- Kernel
- Kernel Functions
- urKernelCreate
- urKernelSetArgValue
- urKernelSetArgLocal
- urKernelGetInfo
- urKernelGetGroupInfo
- urKernelGetSubGroupInfo
- urKernelRetain
- urKernelRelease
- urKernelSetArgPointer
- urKernelSetExecInfo
- urKernelSetArgSampler
- urKernelSetArgMemObj
- urKernelSetSpecializationConstants
- urKernelGetNativeHandle
- urKernelCreateWithNativeHandle
- urKernelGetSuggestedLocalWorkSize
- Kernel Enums
- Kernel Structures
- Kernel Functions
- Queue
- Event
- Enqueue
- Enqueue Functions
- urEnqueueKernelLaunch
- urEnqueueEventsWait
- urEnqueueEventsWaitWithBarrier
- urEnqueueMemBufferRead
- urEnqueueMemBufferWrite
- urEnqueueMemBufferReadRect
- urEnqueueMemBufferWriteRect
- urEnqueueMemBufferCopy
- urEnqueueMemBufferCopyRect
- urEnqueueMemBufferFill
- urEnqueueMemImageRead
- urEnqueueMemImageWrite
- urEnqueueMemImageCopy
- urEnqueueMemBufferMap
- urEnqueueMemUnmap
- urEnqueueUSMFill
- urEnqueueUSMMemcpy
- urEnqueueUSMPrefetch
- urEnqueueUSMAdvise
- urEnqueueUSMFill2D
- urEnqueueUSMMemcpy2D
- urEnqueueDeviceGlobalVariableWrite
- urEnqueueDeviceGlobalVariableRead
- urEnqueueReadHostPipe
- urEnqueueWriteHostPipe
- Enqueue Enums
- Enqueue Functions
- 2d block array capabilities (experimental)
- Bindless images (experimental)
- Bindless images (experimental) Functions
- urUSMPitchedAllocExp
- urBindlessImagesUnsampledImageHandleDestroyExp
- urBindlessImagesSampledImageHandleDestroyExp
- urBindlessImagesImageAllocateExp
- urBindlessImagesImageFreeExp
- urBindlessImagesUnsampledImageCreateExp
- urBindlessImagesSampledImageCreateExp
- urBindlessImagesImageCopyExp
- urBindlessImagesImageGetInfoExp
- urBindlessImagesMipmapGetLevelExp
- urBindlessImagesMipmapFreeExp
- urBindlessImagesImportExternalMemoryExp
- urBindlessImagesMapExternalArrayExp
- urBindlessImagesMapExternalLinearMemoryExp
- urBindlessImagesReleaseExternalMemoryExp
- urBindlessImagesImportExternalSemaphoreExp
- urBindlessImagesReleaseExternalSemaphoreExp
- urBindlessImagesWaitExternalSemaphoreExp
- urBindlessImagesSignalExternalSemaphoreExp
- Bindless images (experimental) Enums
- Bindless images (experimental) Structures
- Bindless images (experimental) Functions
- Command buffer (experimental)
- Command buffer (experimental) Functions
- urCommandBufferCreateExp
- urCommandBufferRetainExp
- urCommandBufferReleaseExp
- urCommandBufferFinalizeExp
- urCommandBufferAppendKernelLaunchExp
- urCommandBufferAppendUSMMemcpyExp
- urCommandBufferAppendUSMFillExp
- urCommandBufferAppendMemBufferCopyExp
- urCommandBufferAppendMemBufferWriteExp
- urCommandBufferAppendMemBufferReadExp
- urCommandBufferAppendMemBufferCopyRectExp
- urCommandBufferAppendMemBufferWriteRectExp
- urCommandBufferAppendMemBufferReadRectExp
- urCommandBufferAppendMemBufferFillExp
- urCommandBufferAppendUSMPrefetchExp
- urCommandBufferAppendUSMAdviseExp
- urCommandBufferEnqueueExp
- urCommandBufferRetainCommandExp
- urCommandBufferReleaseCommandExp
- urCommandBufferUpdateKernelLaunchExp
- urCommandBufferUpdateSignalEventExp
- urCommandBufferUpdateWaitEventsExp
- urCommandBufferGetInfoExp
- urCommandBufferCommandGetInfoExp
- Command buffer (experimental) Enums
- Command buffer (experimental) Structures
- Command buffer (experimental) Macros
- Command buffer (experimental) Typedefs
- Command buffer (experimental) Functions
- Cooperative kernels (experimental)
- Enqueue timestamp recording (experimental)
- Launch properties (experimental)
- Multi device compile (experimental)
- Usm import release (experimental)
- Usm p2p (experimental)
- Low power events (experimental)
- Native enqueue (experimental)
- Tensor map (experimental)
- Print C API
- Print C Functions
- urPrintFunction
- urPrintStructureType
- urPrintResult
- urPrintBaseProperties
- urPrintBaseDesc
- urPrintRectOffset
- urPrintRectRegion
- urPrintDeviceInitFlags
- urPrintLoaderConfigInfo
- urPrintCodeLocation
- urPrintAdapterInfo
- urPrintAdapterBackend
- urPrintPlatformInfo
- urPrintApiVersion
- urPrintPlatformNativeProperties
- urPrintPlatformBackend
- urPrintDeviceBinary
- urPrintDeviceType
- urPrintDeviceInfo
- urPrintDeviceAffinityDomainFlags
- urPrintDevicePartition
- urPrintDevicePartitionProperty
- urPrintDevicePartitionProperties
- urPrintDeviceFpCapabilityFlags
- urPrintDeviceMemCacheType
- urPrintDeviceLocalMemType
- urPrintDeviceExecCapabilityFlags
- urPrintDeviceNativeProperties
- urPrintMemoryOrderCapabilityFlags
- urPrintMemoryScopeCapabilityFlags
- urPrintDeviceUsmAccessCapabilityFlags
- urPrintContextFlags
- urPrintContextProperties
- urPrintContextInfo
- urPrintContextNativeProperties
- urPrintMemFlags
- urPrintMemType
- urPrintMemInfo
- urPrintImageChannelOrder
- urPrintImageChannelType
- urPrintImageInfo
- urPrintImageFormat
- urPrintImageDesc
- urPrintBufferProperties
- urPrintBufferChannelProperties
- urPrintBufferAllocLocationProperties
- urPrintBufferRegion
- urPrintBufferCreateType
- urPrintMemNativeProperties
- urPrintSamplerFilterMode
- urPrintSamplerAddressingMode
- urPrintSamplerInfo
- urPrintSamplerDesc
- urPrintSamplerNativeProperties
- urPrintUsmHostMemFlags
- urPrintUsmDeviceMemFlags
- urPrintUsmPoolFlags
- urPrintUsmType
- urPrintUsmAllocInfo
- urPrintUsmAdviceFlags
- urPrintUsmDesc
- urPrintUsmHostDesc
- urPrintUsmDeviceDesc
- urPrintUsmAllocLocationDesc
- urPrintUsmPoolDesc
- urPrintUsmPoolLimitsDesc
- urPrintUsmPoolInfo
- urPrintVirtualMemGranularityInfo
- urPrintVirtualMemAccessFlags
- urPrintVirtualMemInfo
- urPrintPhysicalMemFlags
- urPrintPhysicalMemProperties
- urPrintPhysicalMemInfo
- urPrintProgramMetadataType
- urPrintProgramMetadata
- urPrintProgramProperties
- urPrintProgramInfo
- urPrintProgramBuildStatus
- urPrintProgramBinaryType
- urPrintProgramBuildInfo
- urPrintSpecializationConstantInfo
- urPrintProgramNativeProperties
- urPrintKernelArgValueProperties
- urPrintKernelArgLocalProperties
- urPrintKernelInfo
- urPrintKernelGroupInfo
- urPrintKernelSubGroupInfo
- urPrintKernelCacheConfig
- urPrintKernelExecInfo
- urPrintKernelArgPointerProperties
- urPrintKernelExecInfoProperties
- urPrintKernelArgSamplerProperties
- urPrintKernelArgMemObjProperties
- urPrintKernelNativeProperties
- urPrintQueueInfo
- urPrintQueueFlags
- urPrintQueueProperties
- urPrintQueueIndexProperties
- urPrintQueueNativeDesc
- urPrintQueueNativeProperties
- urPrintCommand
- urPrintEventStatus
- urPrintEventInfo
- urPrintProfilingInfo
- urPrintEventNativeProperties
- urPrintExecutionInfo
- urPrintMapFlags
- urPrintUsmMigrationFlags
- urPrintExpDevice_2dBlockArrayCapabilityFlags
- urPrintExpImageCopyFlags
- urPrintExpSamplerCubemapFilterMode
- urPrintExpExternalMemType
- urPrintExpExternalSemaphoreType
- urPrintExpFileDescriptor
- urPrintExpWin32Handle
- urPrintExpSamplerMipProperties
- urPrintExpSamplerAddrModes
- urPrintExpSamplerCubemapProperties
- urPrintExpExternalMemDesc
- urPrintExpExternalSemaphoreDesc
- urPrintExpImageCopyRegion
- urPrintDeviceCommandBufferUpdateCapabilityFlags
- urPrintExpCommandBufferInfo
- urPrintExpCommandBufferCommandInfo
- urPrintExpCommandBufferDesc
- urPrintExpCommandBufferUpdateMemobjArgDesc
- urPrintExpCommandBufferUpdatePointerArgDesc
- urPrintExpCommandBufferUpdateValueArgDesc
- urPrintExpCommandBufferUpdateKernelLaunchDesc
- urPrintExpLaunchPropertyId
- urPrintExpLaunchProperty
- urPrintExpPeerInfo
- urPrintExpEnqueueExtFlags
- urPrintExpEnqueueExtProperties
- urPrintExpEnqueueNativeCommandFlags
- urPrintExpEnqueueNativeCommandProperties
- urPrintExpTensorMapDataTypeFlags
- urPrintExpTensorMapInterleaveFlags
- urPrintExpTensorMapL2PromotionFlags
- urPrintExpTensorMapSwizzleFlags
- urPrintExpTensorMapOobFillFlags
- urPrintLoaderConfigCreateParams
- urPrintLoaderConfigRetainParams
- urPrintLoaderConfigReleaseParams
- urPrintLoaderConfigGetInfoParams
- urPrintLoaderConfigEnableLayerParams
- urPrintLoaderConfigSetCodeLocationCallbackParams
- urPrintLoaderConfigSetMockingEnabledParams
- urPrintPlatformGetParams
- urPrintPlatformGetInfoParams
- urPrintPlatformGetNativeHandleParams
- urPrintPlatformCreateWithNativeHandleParams
- urPrintPlatformGetApiVersionParams
- urPrintPlatformGetBackendOptionParams
- urPrintContextCreateParams
- urPrintContextRetainParams
- urPrintContextReleaseParams
- urPrintContextGetInfoParams
- urPrintContextGetNativeHandleParams
- urPrintContextCreateWithNativeHandleParams
- urPrintContextSetExtendedDeleterParams
- urPrintEventGetInfoParams
- urPrintEventGetProfilingInfoParams
- urPrintEventWaitParams
- urPrintEventRetainParams
- urPrintEventReleaseParams
- urPrintEventGetNativeHandleParams
- urPrintEventCreateWithNativeHandleParams
- urPrintEventSetCallbackParams
- urPrintProgramCreateWithIlParams
- urPrintProgramCreateWithBinaryParams
- urPrintProgramBuildParams
- urPrintProgramBuildExpParams
- urPrintProgramCompileParams
- urPrintProgramCompileExpParams
- urPrintProgramLinkParams
- urPrintProgramLinkExpParams
- urPrintProgramRetainParams
- urPrintProgramReleaseParams
- urPrintProgramGetFunctionPointerParams
- urPrintProgramGetGlobalVariablePointerParams
- urPrintProgramGetInfoParams
- urPrintProgramGetBuildInfoParams
- urPrintProgramSetSpecializationConstantsParams
- urPrintProgramGetNativeHandleParams
- urPrintProgramCreateWithNativeHandleParams
- urPrintKernelCreateParams
- urPrintKernelGetInfoParams
- urPrintKernelGetGroupInfoParams
- urPrintKernelGetSubGroupInfoParams
- urPrintKernelRetainParams
- urPrintKernelReleaseParams
- urPrintKernelGetNativeHandleParams
- urPrintKernelCreateWithNativeHandleParams
- urPrintKernelGetSuggestedLocalWorkSizeParams
- urPrintKernelSetArgValueParams
- urPrintKernelSetArgLocalParams
- urPrintKernelSetArgPointerParams
- urPrintKernelSetExecInfoParams
- urPrintKernelSetArgSamplerParams
- urPrintKernelSetArgMemObjParams
- urPrintKernelSetSpecializationConstantsParams
- urPrintKernelSuggestMaxCooperativeGroupCountExpParams
- urPrintQueueGetInfoParams
- urPrintQueueCreateParams
- urPrintQueueRetainParams
- urPrintQueueReleaseParams
- urPrintQueueGetNativeHandleParams
- urPrintQueueCreateWithNativeHandleParams
- urPrintQueueFinishParams
- urPrintQueueFlushParams
- urPrintSamplerCreateParams
- urPrintSamplerRetainParams
- urPrintSamplerReleaseParams
- urPrintSamplerGetInfoParams
- urPrintSamplerGetNativeHandleParams
- urPrintSamplerCreateWithNativeHandleParams
- urPrintMemImageCreateParams
- urPrintMemBufferCreateParams
- urPrintMemRetainParams
- urPrintMemReleaseParams
- urPrintMemBufferPartitionParams
- urPrintMemGetNativeHandleParams
- urPrintMemBufferCreateWithNativeHandleParams
- urPrintMemImageCreateWithNativeHandleParams
- urPrintMemGetInfoParams
- urPrintMemImageGetInfoParams
- urPrintPhysicalMemCreateParams
- urPrintPhysicalMemRetainParams
- urPrintPhysicalMemReleaseParams
- urPrintPhysicalMemGetInfoParams
- urPrintAdapterGetParams
- urPrintAdapterReleaseParams
- urPrintAdapterRetainParams
- urPrintAdapterGetLastErrorParams
- urPrintAdapterGetInfoParams
- urPrintEnqueueKernelLaunchParams
- urPrintEnqueueEventsWaitParams
- urPrintEnqueueEventsWaitWithBarrierParams
- urPrintEnqueueMemBufferReadParams
- urPrintEnqueueMemBufferWriteParams
- urPrintEnqueueMemBufferReadRectParams
- urPrintEnqueueMemBufferWriteRectParams
- urPrintEnqueueMemBufferCopyParams
- urPrintEnqueueMemBufferCopyRectParams
- urPrintEnqueueMemBufferFillParams
- urPrintEnqueueMemImageReadParams
- urPrintEnqueueMemImageWriteParams
- urPrintEnqueueMemImageCopyParams
- urPrintEnqueueMemBufferMapParams
- urPrintEnqueueMemUnmapParams
- urPrintEnqueueUsmFillParams
- urPrintEnqueueUsmMemcpyParams
- urPrintEnqueueUsmPrefetchParams
- urPrintEnqueueUsmAdviseParams
- urPrintEnqueueUsmFill_2dParams
- urPrintEnqueueUsmMemcpy_2dParams
- urPrintEnqueueDeviceGlobalVariableWriteParams
- urPrintEnqueueDeviceGlobalVariableReadParams
- urPrintEnqueueReadHostPipeParams
- urPrintEnqueueWriteHostPipeParams
- urPrintEnqueueKernelLaunchCustomExpParams
- urPrintEnqueueEventsWaitWithBarrierExtParams
- urPrintEnqueueCooperativeKernelLaunchExpParams
- urPrintEnqueueTimestampRecordingExpParams
- urPrintEnqueueNativeCommandExpParams
- urPrintBindlessImagesUnsampledImageHandleDestroyExpParams
- urPrintBindlessImagesSampledImageHandleDestroyExpParams
- urPrintBindlessImagesImageAllocateExpParams
- urPrintBindlessImagesImageFreeExpParams
- urPrintBindlessImagesUnsampledImageCreateExpParams
- urPrintBindlessImagesSampledImageCreateExpParams
- urPrintBindlessImagesImageCopyExpParams
- urPrintBindlessImagesImageGetInfoExpParams
- urPrintBindlessImagesMipmapGetLevelExpParams
- urPrintBindlessImagesMipmapFreeExpParams
- urPrintBindlessImagesImportExternalMemoryExpParams
- urPrintBindlessImagesMapExternalArrayExpParams
- urPrintBindlessImagesMapExternalLinearMemoryExpParams
- urPrintBindlessImagesReleaseExternalMemoryExpParams
- urPrintBindlessImagesImportExternalSemaphoreExpParams
- urPrintBindlessImagesReleaseExternalSemaphoreExpParams
- urPrintBindlessImagesWaitExternalSemaphoreExpParams
- urPrintBindlessImagesSignalExternalSemaphoreExpParams
- urPrintUsmHostAllocParams
- urPrintUsmDeviceAllocParams
- urPrintUsmSharedAllocParams
- urPrintUsmFreeParams
- urPrintUsmGetMemAllocInfoParams
- urPrintUsmPoolCreateParams
- urPrintUsmPoolRetainParams
- urPrintUsmPoolReleaseParams
- urPrintUsmPoolGetInfoParams
- urPrintUsmPitchedAllocExpParams
- urPrintUsmImportExpParams
- urPrintUsmReleaseExpParams
- urPrintCommandBufferCreateExpParams
- urPrintCommandBufferRetainExpParams
- urPrintCommandBufferReleaseExpParams
- urPrintCommandBufferFinalizeExpParams
- urPrintCommandBufferAppendKernelLaunchExpParams
- urPrintCommandBufferAppendUsmMemcpyExpParams
- urPrintCommandBufferAppendUsmFillExpParams
- urPrintCommandBufferAppendMemBufferCopyExpParams
- urPrintCommandBufferAppendMemBufferWriteExpParams
- urPrintCommandBufferAppendMemBufferReadExpParams
- urPrintCommandBufferAppendMemBufferCopyRectExpParams
- urPrintCommandBufferAppendMemBufferWriteRectExpParams
- urPrintCommandBufferAppendMemBufferReadRectExpParams
- urPrintCommandBufferAppendMemBufferFillExpParams
- urPrintCommandBufferAppendUsmPrefetchExpParams
- urPrintCommandBufferAppendUsmAdviseExpParams
- urPrintCommandBufferEnqueueExpParams
- urPrintCommandBufferRetainCommandExpParams
- urPrintCommandBufferReleaseCommandExpParams
- urPrintCommandBufferUpdateKernelLaunchExpParams
- urPrintCommandBufferUpdateSignalEventExpParams
- urPrintCommandBufferUpdateWaitEventsExpParams
- urPrintCommandBufferGetInfoExpParams
- urPrintCommandBufferCommandGetInfoExpParams
- urPrintTensorMapEncodeIm_2ColExpParams
- urPrintTensorMapEncodeTiledExpParams
- urPrintUsmP2pEnablePeerAccessExpParams
- urPrintUsmP2pDisablePeerAccessExpParams
- urPrintUsmP2pPeerAccessGetInfoExpParams
- urPrintLoaderInitParams
- urPrintLoaderTearDownParams
- urPrintVirtualMemGranularityGetInfoParams
- urPrintVirtualMemReserveParams
- urPrintVirtualMemFreeParams
- urPrintVirtualMemMapParams
- urPrintVirtualMemUnmapParams
- urPrintVirtualMemSetAccessParams
- urPrintVirtualMemGetInfoParams
- urPrintDeviceGetParams
- urPrintDeviceGetSelectedParams
- urPrintDeviceGetInfoParams
- urPrintDeviceRetainParams
- urPrintDeviceReleaseParams
- urPrintDevicePartitionParams
- urPrintDeviceSelectBinaryParams
- urPrintDeviceGetNativeHandleParams
- urPrintDeviceCreateWithNativeHandleParams
- urPrintDeviceGetGlobalTimestampsParams
- urPrintFunctionParams
- Print C Functions
- Print C++ API