.. _global:
.. index:: pair: namespace; global

Global Namespace
================

.. toctree::
	:hidden:

	namespace_dpctl.rst
	enum_DPCTLGlobalMemCacheType.rst
	enum_DPCTLKernelArgType.rst
	enum_DPCTLPartitionAffinityDomainType.rst
	enum_DPCTLQueuePropertyType.rst
	enum_DPCTLSyclAspectType.rst
	enum_DPCTLSyclBackendType.rst
	enum_DPCTLSyclDeviceType.rst
	enum_DPCTLSyclEventStatusType.rst
	enum_DPCTLSyclUSMType.rst
	struct_MDLocalAccessorTy.rst
	struct_RawWorkGroupMemoryTy.rst

Overview
~~~~~~~~




.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	
	// namespaces

	namespace :ref:`dpctl<doxid-d2/df1/namespacedpctl>`;
		namespace :ref:`dpctl::syclinterface<doxid-d1/d06/namespacedpctl_1_1syclinterface>`;

	// typedefs

	typedef void :ref:`error_handler_callback<doxid-de/d75/dpctl__error__handler__type_8h_1aeb0f262687ced57ead8f8b7d0b7dcefe>`(int err_code);
	typedef struct DPCTLOpaqueSyclWorkGroupMemory* :target:`DPCTLSyclWorkGroupMemoryRef<doxid-dd/db8/dpctl__sycl__extension__interface_8h_1ab3a8275f34098811f89278732d5dc8a7>`;
	typedef :ref:`DPCTL_C_EXTERN_C_BEGIN<doxid-d7/d31/_extern_c_8h_1ad85f54ad0bab1d5206255e5920261be3>` struct :ref:`RawWorkGroupMemoryTy<doxid-db/d1d/struct_raw_work_group_memory_ty>` :target:`RawWorkGroupMemory<doxid-dd/db8/dpctl__sycl__extension__interface_8h_1ace3e58dbaa53288d9b7272fe9a6d03b3>`;
	typedef struct :ref:`MDLocalAccessorTy<doxid-db/dfd/struct_m_d_local_accessor_ty>` :ref:`MDLocalAccessor<doxid-da/db8/dpctl__sycl__queue__interface_8h_1a7779ae83e3fd4db1174768e1ba62f30b>`;
	typedef  struct DPCTLOpaqueSyclContext* :ref:`DPCTLSyclContextRef<doxid-df/d57/dpctl__sycl__types_8h_1accf78808322af80b73da617cb2f15f08>`;
	typedef struct DPCTLOpaqueSyclDevice* :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>`;
	typedef struct DPCTLOpaqueSyclDeviceSelector* :ref:`DPCTLSyclDeviceSelectorRef<doxid-df/d57/dpctl__sycl__types_8h_1a50a1c6c98f4ca4a27a88e53a7f3eeb83>`;
	typedef struct DPCTLOpaqueSyclEvent* :ref:`DPCTLSyclEventRef<doxid-df/d57/dpctl__sycl__types_8h_1a42590892ae4324c54f6ddef34009ca03>`;
	typedef struct DPCTLOpaqueSyclKernelBundle* :ref:`DPCTLSyclKernelBundleRef<doxid-df/d57/dpctl__sycl__types_8h_1a6d9c52ea7d2e9394ddf7ba7e7f01bebd>`;
	typedef struct DPCTLOpaqueSyclKernel* :ref:`DPCTLSyclKernelRef<doxid-df/d57/dpctl__sycl__types_8h_1a3f6be07fdf695c015719ce0b0c237844>`;
	typedef struct DPCTLOpaqueSyclPlatform* :ref:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>`;
	typedef struct DPCTLOpaqueSyclQueue* :ref:`DPCTLSyclQueueRef<doxid-df/d57/dpctl__sycl__types_8h_1af23137a8bf20ff63b10db9f7f987799a>`;
	typedef struct DPCTLOpaqueSyclUSM* :ref:`DPCTLSyclUSMRef<doxid-df/d57/dpctl__sycl__types_8h_1a8c78ad1413045f90e15f5b6a2727d2e6>`;

	// enums

	enum :ref:`DPCTLGlobalMemCacheType<doxid-d3/d94/dpctl__sycl__enum__types_8h_1a229ff3945c2347aa0999fe2e28aaa94d>`;
	enum :ref:`DPCTLKernelArgType<doxid-d3/d94/dpctl__sycl__enum__types_8h_1a2b3d2dd8e0c358370eac0a59fb3fe089>`;
	enum :ref:`DPCTLPartitionAffinityDomainType<doxid-d3/d94/dpctl__sycl__enum__types_8h_1a27908eb4caace370bd771904e6a48670>`;
	enum :ref:`DPCTLQueuePropertyType<doxid-d3/d94/dpctl__sycl__enum__types_8h_1a439a88c8e537df22ac3e2c66fce3ad4f>`;
	enum :ref:`DPCTLSyclAspectType<doxid-d3/d94/dpctl__sycl__enum__types_8h_1a5f57a140cfab264daf4500bdac0be389>`;
	enum :ref:`DPCTLSyclBackendType<doxid-d3/d94/dpctl__sycl__enum__types_8h_1aa217d239d7e3752c49bd9fd42c71c933>`;
	enum :ref:`DPCTLSyclDeviceType<doxid-d3/d94/dpctl__sycl__enum__types_8h_1a15d8954e4e712e2ec00838a9283d13ff>`;
	enum :ref:`DPCTLSyclEventStatusType<doxid-d3/d94/dpctl__sycl__enum__types_8h_1ac950d7ef3975b7c553971613f4a27021>`;
	enum :ref:`DPCTLSyclUSMType<doxid-d3/d94/dpctl__sycl__enum__types_8h_1a61bd8b72de91212af565a9be9b913844>`;

	// structs

	struct :ref:`MDLocalAccessorTy<doxid-db/dfd/struct_m_d_local_accessor_ty>`;
	struct :ref:`RawWorkGroupMemoryTy<doxid-db/d1d/struct_raw_work_group_memory_ty>`;

	// global functions

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` uint32_t
	:ref:`DPCTLDevice_GetGlobalMemCacheLineSize<doxid-d4/d5a/dpctl__sycl__device__interface_8h_1ac47e84e08c40272eb54358b6ab76c0f0>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` uint64_t
	:ref:`DPCTLDevice_GetGlobalMemCacheSize<doxid-d4/d5a/dpctl__sycl__device__interface_8h_1ae4641fb22da8c78a1c5b3c9a0c0fd913>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`DPCTLGlobalMemCacheType<doxid-d3/d94/dpctl__sycl__enum__types_8h_1a229ff3945c2347aa0999fe2e28aaa94d>`
	:ref:`DPCTLDevice_GetGlobalMemCacheType<doxid-d4/d5a/dpctl__sycl__device__interface_8h_1a34aef85cc31edf294aece8d68f5bccba>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` size_t
	:ref:`DPCTLDevice_GetImage2dMaxHeight<doxid-d4/d5a/dpctl__sycl__device__interface_8h_1a4ef25a38cbf63e618016302e8ebf480d>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` size_t
	:ref:`DPCTLDevice_GetImage2dMaxWidth<doxid-d4/d5a/dpctl__sycl__device__interface_8h_1ad1f6957fdc5fb51ed873fa444af17c13>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` size_t
	:ref:`DPCTLDevice_GetImage3dMaxDepth<doxid-d4/d5a/dpctl__sycl__device__interface_8h_1ac64423a160a010d1841b36ae2ab48658>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` size_t
	:ref:`DPCTLDevice_GetImage3dMaxHeight<doxid-d4/d5a/dpctl__sycl__device__interface_8h_1ac041263954e4e4c2a5bf58eeb08c0b7e>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` size_t
	:ref:`DPCTLDevice_GetImage3dMaxWidth<doxid-d4/d5a/dpctl__sycl__device__interface_8h_1a775e74dcd25c38e1d1575df3262b6f60>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` uint32_t
	:ref:`DPCTLDevice_GetMaxClockFrequency<doxid-d4/d5a/dpctl__sycl__device__interface_8h_1a8a86e895dc25e747f8f4349100d85809>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` uint64_t
	:ref:`DPCTLDevice_GetMaxMemAllocSize<doxid-d4/d5a/dpctl__sycl__device__interface_8h_1ad546933b32f0c9917982f39ddf0be5c6>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` uint32_t
	:ref:`DPCTLDevice_GetMaxReadImageArgs<doxid-d4/d5a/dpctl__sycl__device__interface_8h_1a9810a239416c53427e3742bfb72ea0a6>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` uint32_t
	:ref:`DPCTLDevice_GetMaxWriteImageArgs<doxid-d4/d5a/dpctl__sycl__device__interface_8h_1a34dbd5b5dbde22ba5f1d5205de298d81>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`__dpctl_give<doxid-d2/d43/group___memory_semantics_1ga836492a42cdfef6419378dbf8d81f452>` :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>`
	:ref:`DPCTLDevice_GetParentDevice<doxid-d4/d5a/dpctl__sycl__device__interface_8h_1acccdc3f034e6c5fd2a249907355169bc>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` uint32_t
	:ref:`DPCTLDevice_GetPartitionMaxSubDevices<doxid-d4/d5a/dpctl__sycl__device__interface_8h_1ab48d25118cd217ccd917993afba98570>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` size_t
	:ref:`DPCTLDevice_GetProfilingTimerResolution<doxid-d4/d5a/dpctl__sycl__device__interface_8h_1a5fe67bf4915e62ce08d80d810f0e8632>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` size_t
	:ref:`DPCTLDevice_Hash<doxid-d4/d5a/dpctl__sycl__device__interface_8h_1a28538fa8029a6d4c7ff4d972ec690b97>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` bool
	:target:`DPCTLWorkGroupMemory_Available<doxid-dd/db8/dpctl__sycl__extension__interface_8h_1ae822b8edf0c8c3192819037b4b8af68e>`();

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`__dpctl_give<doxid-d2/d43/group___memory_semantics_1ga836492a42cdfef6419378dbf8d81f452>` :ref:`DPCTLSyclWorkGroupMemoryRef<doxid-dd/db8/dpctl__sycl__extension__interface_8h_1ab3a8275f34098811f89278732d5dc8a7>`
	:target:`DPCTLWorkGroupMemory_Create<doxid-dd/db8/dpctl__sycl__extension__interface_8h_1adfba2a6815b16a79dd4d47eea6f0ec18>`(size_t nbytes);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` void
	:target:`DPCTLWorkGroupMemory_Delete<doxid-dd/db8/dpctl__sycl__extension__interface_8h_1a7a9cad89e434a7becb710176e7be9117>`(:ref:`__dpctl_take<doxid-d2/d43/group___memory_semantics_1ga17fe5722d78d8ce138ca952889d07bc6>` :ref:`DPCTLSyclWorkGroupMemoryRef<doxid-dd/db8/dpctl__sycl__extension__interface_8h_1ab3a8275f34098811f89278732d5dc8a7>` Ref);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`__dpctl_give<doxid-d2/d43/group___memory_semantics_1ga836492a42cdfef6419378dbf8d81f452>` :ref:`DPCTLSyclEventRef<doxid-df/d57/dpctl__sycl__types_8h_1a42590892ae4324c54f6ddef34009ca03>`
	:ref:`DPCTLQueue_SubmitBarrier<doxid-da/db8/dpctl__sycl__queue__interface_8h_1a2453786e50a7d7e51a0d240b2ce52f53>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclQueueRef<doxid-df/d57/dpctl__sycl__types_8h_1af23137a8bf20ff63b10db9f7f987799a>` QRef);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`__dpctl_give<doxid-d2/d43/group___memory_semantics_1ga836492a42cdfef6419378dbf8d81f452>` :ref:`DPCTLSyclEventRef<doxid-df/d57/dpctl__sycl__types_8h_1a42590892ae4324c54f6ddef34009ca03>`
	:ref:`DPCTLQueue_SubmitBarrierForEvents<doxid-da/db8/dpctl__sycl__queue__interface_8h_1a1666c1e2da52e7736cfc662a7c0ad6fb>`(
		:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclQueueRef<doxid-df/d57/dpctl__sycl__types_8h_1af23137a8bf20ff63b10db9f7f987799a>` QRef,
		:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclEventRef<doxid-df/d57/dpctl__sycl__types_8h_1a42590892ae4324c54f6ddef34009ca03>`* DepEvents,
		size_t NDepEvents
		);

	:ref:`DPCTL_C_EXTERN_C_BEGIN<doxid-d7/d31/_extern_c_8h_1ad85f54ad0bab1d5206255e5920261be3>` :ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` void
	:ref:`DPCTLCString_Delete<doxid-da/d48/dpctl__utils_8h_1a33267597953b5a15fc3a052e0d09ef06>`(:ref:`__dpctl_take<doxid-d2/d43/group___memory_semantics_1ga17fe5722d78d8ce138ca952889d07bc6>` const char* str);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` void
	:ref:`DPCTLSize_t_Array_Delete<doxid-da/d48/dpctl__utils_8h_1a8666dbbe5583326eb3b57293be168ffc>`(:ref:`__dpctl_take<doxid-d2/d43/group___memory_semantics_1ga17fe5722d78d8ce138ca952889d07bc6>` size_t* arr);

	// macros

	#define :target:`DPCTL_C_EXTERN_C_BEGIN<doxid-d7/d31/_extern_c_8h_1ad85f54ad0bab1d5206255e5920261be3>`
	#define :target:`DPCTL_C_EXTERN_C_END<doxid-d7/d31/_extern_c_8h_1a6956fffc46b54bcdd0e7fd53cd3a6619>`
	#define :target:`DPCTL_DECLARE_VECTOR<doxid-d4/d64/dpctl__vector_8h_1a43b2a4a7b634d5a56fa79397f629b705>`(EL)
	#define :target:`DPCTL_DECLARE_VECTOR_FN<doxid-d4/d64/dpctl__vector_8h_1acc5c1c7aff23c0d01882e6e82e0eea9d>`(EL)
	#define :ref:`DPCTL_DECLARE_VECTOR_TYPE<doxid-d4/d64/dpctl__vector_8h_1a83a0669601a2adec6b227cc2276a1538>`(EL)
	#define :target:`DPCTL_DPCPP_VERSION<doxid-d5/dc8/dpctl__config_8h_1a00ca2e61d36794f041736396d1e20124>`
	#define :target:`DPCTL_ENABLE_L0_PROGRAM_CREATION<doxid-d5/dc8/dpctl__config_8h_1a182f8dae06ea22e2c65172f1fb1182ea>`
	#define :target:`DPCTL_LIBCL_LOADER_FILENAME<doxid-d5/dc8/dpctl__config_8h_1ac0275ec42e77c34f20506d43687a9748>`
	#define :target:`DPCTL_LIBZE_LOADER_FILENAME<doxid-d5/dc8/dpctl__config_8h_1a034614d34ebcaa0b5e5dcdee4a0d2a4a>`
	#define :ref:`HUGE_VALF<doxid-dd/d1c/dpctl__data__types_8h_1acd69981d54c27fe0ff514645dbfc6359>`
	#define :ref:`INT64_MAX<doxid-dd/d1c/dpctl__data__types_8h_1ad0d744f05898e32d01f73f8af3cd2071>`
	#define :ref:`INT64_MIN<doxid-dd/d1c/dpctl__data__types_8h_1ab21f12f372f67b8ff0aa3432336ede67>`
	#define :ref:`UINT64_MAX<doxid-dd/d1c/dpctl__data__types_8h_1a30654b4b67d97c42ca3f9b6052dda916>`
	#define :target:`__SYCL_COMPILER_VERSION_REQUIRED<doxid-d5/dc8/dpctl__config_8h_1abc74b5b590f29184b233628c55569207>`

.. _details-global:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~



Typedefs
--------

.. index:: pair: typedef; error_handler_callback
.. _doxid-de/d75/dpctl__error__handler__type_8h_1aeb0f262687ced57ead8f8b7d0b7dcefe:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	typedef void error_handler_callback(int err_code)

Type of function to be used in SYCL async error handler provide by DPCTL.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- err_code

		- Error code extracted from an SYCL asynchronous error.

.. index:: pair: typedef; MDLocalAccessor
.. _doxid-da/db8/dpctl__sycl__queue__interface_8h_1a7779ae83e3fd4db1174768e1ba62f30b:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	typedef struct :ref:`MDLocalAccessorTy<doxid-db/dfd/struct_m_d_local_accessor_ty>` MDLocalAccessor

Structure to be used to specify dimensionality and type of local_accessor kernel type argument.

.. index:: pair: typedef; DPCTLSyclContextRef
.. _doxid-df/d57/dpctl__sycl__types_8h_1accf78808322af80b73da617cb2f15f08:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	typedef  struct DPCTLOpaqueSyclContext* DPCTLSyclContextRef

Opaque pointer to a ``sycl::context``

.. index:: pair: typedef; DPCTLSyclDeviceRef
.. _doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	typedef struct DPCTLOpaqueSyclDevice* DPCTLSyclDeviceRef

Opaque pointer to a ``sycl::device``

.. index:: pair: typedef; DPCTLSyclDeviceSelectorRef
.. _doxid-df/d57/dpctl__sycl__types_8h_1a50a1c6c98f4ca4a27a88e53a7f3eeb83:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	typedef struct DPCTLOpaqueSyclDeviceSelector* DPCTLSyclDeviceSelectorRef

Opaque pointer to a ``sycl::device_selector``

.. index:: pair: typedef; DPCTLSyclEventRef
.. _doxid-df/d57/dpctl__sycl__types_8h_1a42590892ae4324c54f6ddef34009ca03:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	typedef struct DPCTLOpaqueSyclEvent* DPCTLSyclEventRef

Opaque pointer to a ``sycl::event``

.. index:: pair: typedef; DPCTLSyclKernelBundleRef
.. _doxid-df/d57/dpctl__sycl__types_8h_1a6d9c52ea7d2e9394ddf7ba7e7f01bebd:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	typedef struct DPCTLOpaqueSyclKernelBundle* DPCTLSyclKernelBundleRef

Opaque pointer to a ``sycl::kernel_bundle<sycl::bundle_state::executable>``

.. index:: pair: typedef; DPCTLSyclKernelRef
.. _doxid-df/d57/dpctl__sycl__types_8h_1a3f6be07fdf695c015719ce0b0c237844:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	typedef struct DPCTLOpaqueSyclKernel* DPCTLSyclKernelRef

Opaque pointer to a ``sycl::kernel``

.. index:: pair: typedef; DPCTLSyclPlatformRef
.. _doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	typedef struct DPCTLOpaqueSyclPlatform* DPCTLSyclPlatformRef

Opaque pointer to a ``sycl::platform``

.. index:: pair: typedef; DPCTLSyclQueueRef
.. _doxid-df/d57/dpctl__sycl__types_8h_1af23137a8bf20ff63b10db9f7f987799a:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	typedef struct DPCTLOpaqueSyclQueue* DPCTLSyclQueueRef

Opaque pointer to a ``sycl::queue``

.. index:: pair: typedef; DPCTLSyclUSMRef
.. _doxid-df/d57/dpctl__sycl__types_8h_1a8c78ad1413045f90e15f5b6a2727d2e6:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	typedef struct DPCTLOpaqueSyclUSM* DPCTLSyclUSMRef

Used to pass a ``sycl::usm`` memory opaquely through DPCTL interfaces.

Global Functions
----------------

.. index:: pair: function; DPCTLDevice_GetGlobalMemCacheLineSize
.. _doxid-d4/d5a/dpctl__sycl__device__interface_8h_1ac47e84e08c40272eb54358b6ab76c0f0:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` uint32_t
	DPCTLDevice_GetGlobalMemCacheLineSize(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef)

Wrapper over device.get_info<info::device::global_mem_cache_line_size>



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- DRef

		- Opaque pointer to a sycl::device



.. rubric:: Returns:

Returns the size of global memory cache line in bytes as uint32_t.

.. index:: pair: function; DPCTLDevice_GetGlobalMemCacheSize
.. _doxid-d4/d5a/dpctl__sycl__device__interface_8h_1ae4641fb22da8c78a1c5b3c9a0c0fd913:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` uint64_t
	DPCTLDevice_GetGlobalMemCacheSize(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef)

Wrapper over device.get_info<info::device::global_mem_cache_size>



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- DRef

		- Opaque pointer to a sycl::device



.. rubric:: Returns:

Returns the size of global memory cache in bytes as uint64_t.

.. index:: pair: function; DPCTLDevice_GetGlobalMemCacheType
.. _doxid-d4/d5a/dpctl__sycl__device__interface_8h_1a34aef85cc31edf294aece8d68f5bccba:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`DPCTLGlobalMemCacheType<doxid-d3/d94/dpctl__sycl__enum__types_8h_1a229ff3945c2347aa0999fe2e28aaa94d>`
	DPCTLDevice_GetGlobalMemCacheType(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef)

Wrapper over device.get_info<info::device::global_mem_cache_type>



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- DRef

		- Opaque pointer to a sycl::device



.. rubric:: Returns:

Returns the type of global memory cache supported.

.. index:: pair: function; DPCTLDevice_GetImage2dMaxHeight
.. _doxid-d4/d5a/dpctl__sycl__device__interface_8h_1a4ef25a38cbf63e618016302e8ebf480d:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` size_t
	DPCTLDevice_GetImage2dMaxHeight(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef)

Wrapper over device.get_info<info::device::image2d_max_height>().



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- DRef

		- Opaque pointer to a sycl::device



.. rubric:: Returns:

Returns the maximum height of a 2D image or 1D image in pixels. The minimum value is 8192 if the SYCL device has aspect::image.

.. index:: pair: function; DPCTLDevice_GetImage2dMaxWidth
.. _doxid-d4/d5a/dpctl__sycl__device__interface_8h_1ad1f6957fdc5fb51ed873fa444af17c13:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` size_t
	DPCTLDevice_GetImage2dMaxWidth(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef)

Wrapper over device.get_info<info::device::image2d_max_width>().



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- DRef

		- Opaque pointer to a sycl::device



.. rubric:: Returns:

Returns the maximum width of a 2D image or 1D image in pixels. The minimum value is 8192 if the SYCL device has aspect::image.

.. index:: pair: function; DPCTLDevice_GetImage3dMaxDepth
.. _doxid-d4/d5a/dpctl__sycl__device__interface_8h_1ac64423a160a010d1841b36ae2ab48658:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` size_t
	DPCTLDevice_GetImage3dMaxDepth(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef)

Wrapper over device.get_info<info::device::image3d_max_depth>().



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- DRef

		- Opaque pointer to a sycl::device



.. rubric:: Returns:

Returns the maximum depth of a 3D image The minimum value is 2048 if the SYCL device has aspect::image.

.. index:: pair: function; DPCTLDevice_GetImage3dMaxHeight
.. _doxid-d4/d5a/dpctl__sycl__device__interface_8h_1ac041263954e4e4c2a5bf58eeb08c0b7e:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` size_t
	DPCTLDevice_GetImage3dMaxHeight(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef)

Wrapper over device.get_info<info::device::image3d_max_height>().



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- DRef

		- Opaque pointer to a sycl::device



.. rubric:: Returns:

Returns the maximum height of a 3D image The minimum value is 2048 if the SYCL device has aspect::image.

.. index:: pair: function; DPCTLDevice_GetImage3dMaxWidth
.. _doxid-d4/d5a/dpctl__sycl__device__interface_8h_1a775e74dcd25c38e1d1575df3262b6f60:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` size_t
	DPCTLDevice_GetImage3dMaxWidth(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef)

Wrapper over device.get_info<info::device::image3d_max_width>().



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- DRef

		- Opaque pointer to a sycl::device



.. rubric:: Returns:

Returns the maximum width of a 3D image in pixels. The minimum value is 2048 if the SYCL device has aspect::image.

.. index:: pair: function; DPCTLDevice_GetMaxClockFrequency
.. _doxid-d4/d5a/dpctl__sycl__device__interface_8h_1a8a86e895dc25e747f8f4349100d85809:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` uint32_t
	DPCTLDevice_GetMaxClockFrequency(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef)

Wrapper over device.get_info<info::device::max_clock_frequency>



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- DRef

		- Opaque pointer to a sycl::device



.. rubric:: Returns:

Returns the maximum clock frequency in MHz as uint32_t.

.. index:: pair: function; DPCTLDevice_GetMaxMemAllocSize
.. _doxid-d4/d5a/dpctl__sycl__device__interface_8h_1ad546933b32f0c9917982f39ddf0be5c6:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` uint64_t
	DPCTLDevice_GetMaxMemAllocSize(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef)

Wrapper over device.get_info<info::device::max_mem_alloc_size>



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- DRef

		- Opaque pointer to a sycl::device



.. rubric:: Returns:

Returns the maximum size of memory object in bytes as uint64_t.

.. index:: pair: function; DPCTLDevice_GetMaxReadImageArgs
.. _doxid-d4/d5a/dpctl__sycl__device__interface_8h_1a9810a239416c53427e3742bfb72ea0a6:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` uint32_t
	DPCTLDevice_GetMaxReadImageArgs(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef)

Wrapper over device.get_info<info::device::max_read_image_args>().



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- DRef

		- Opaque pointer to a sycl::device



.. rubric:: Returns:

Returns the maximum number of simultaneous image objects that can be read from by a kernel. The minimum value is 128 if the SYCL device has aspect::image.

.. index:: pair: function; DPCTLDevice_GetMaxWriteImageArgs
.. _doxid-d4/d5a/dpctl__sycl__device__interface_8h_1a34dbd5b5dbde22ba5f1d5205de298d81:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` uint32_t
	DPCTLDevice_GetMaxWriteImageArgs(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef)

Wrapper over device.get_info<info::device::max_write_image_args>().



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- DRef

		- Opaque pointer to a sycl::device



.. rubric:: Returns:

Returns the maximum number of simultaneous image objects that can be written to by a kernel. The minimum value is 8 if the SYCL device has aspect::image.

.. index:: pair: function; DPCTLDevice_GetParentDevice
.. _doxid-d4/d5a/dpctl__sycl__device__interface_8h_1acccdc3f034e6c5fd2a249907355169bc:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`__dpctl_give<doxid-d2/d43/group___memory_semantics_1ga836492a42cdfef6419378dbf8d81f452>` :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>`
	DPCTLDevice_GetParentDevice(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef)

Wrapper over device.get_info<info::device::parent_device>



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- DRef

		- Opaque pointer to a sycl::device



.. rubric:: Returns:

Returns an opaque pointer to the parent device for a sub-device, or nullptr otherwise.

.. index:: pair: function; DPCTLDevice_GetPartitionMaxSubDevices
.. _doxid-d4/d5a/dpctl__sycl__device__interface_8h_1ab48d25118cd217ccd917993afba98570:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` uint32_t
	DPCTLDevice_GetPartitionMaxSubDevices(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef)

Wrapper over device.get_info<info::device::partition_max_sub_devices>



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- DRef

		- Opaque pointer to a sycl::device



.. rubric:: Returns:

Returns the maximum number of sub-devices that can be created when this device is partitioned.

.. index:: pair: function; DPCTLDevice_GetProfilingTimerResolution
.. _doxid-d4/d5a/dpctl__sycl__device__interface_8h_1a5fe67bf4915e62ce08d80d810f0e8632:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` size_t
	DPCTLDevice_GetProfilingTimerResolution(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef)

Wrapper over device.get_info<info::device::profiling_timer_resolution>



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- DRef

		- Opaque pointer to a sycl::device



.. rubric:: Returns:

Returns the resolution of device timer in nanoseconds.

.. index:: pair: function; DPCTLDevice_Hash
.. _doxid-d4/d5a/dpctl__sycl__device__interface_8h_1a28538fa8029a6d4c7ff4d972ec690b97:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` size_t
	DPCTLDevice_Hash(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef)

Wrapper over std::hash<sycl::device>'s operator()



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- DRef

		- Opaque pointer to a sycl::device



.. rubric:: Returns:

Returns hash value.

.. index:: pair: function; DPCTLQueue_SubmitBarrier
.. _doxid-da/db8/dpctl__sycl__queue__interface_8h_1a2453786e50a7d7e51a0d240b2ce52f53:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`__dpctl_give<doxid-d2/d43/group___memory_semantics_1ga836492a42cdfef6419378dbf8d81f452>` :ref:`DPCTLSyclEventRef<doxid-df/d57/dpctl__sycl__types_8h_1a42590892ae4324c54f6ddef34009ca03>`
	DPCTLQueue_SubmitBarrier(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclQueueRef<doxid-df/d57/dpctl__sycl__types_8h_1af23137a8bf20ff63b10db9f7f987799a>` QRef)

C-API wrapper for ``sycl::queue::submit_barrier()``.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- QRef

		- An opaque pointer to the ``sycl::queue``.



.. rubric:: Returns:

An opaque pointer to the ``sycl::event`` returned by the ``sycl::queue::submit_barrier()`` function.

.. index:: pair: function; DPCTLQueue_SubmitBarrierForEvents
.. _doxid-da/db8/dpctl__sycl__queue__interface_8h_1a1666c1e2da52e7736cfc662a7c0ad6fb:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`__dpctl_give<doxid-d2/d43/group___memory_semantics_1ga836492a42cdfef6419378dbf8d81f452>` :ref:`DPCTLSyclEventRef<doxid-df/d57/dpctl__sycl__types_8h_1a42590892ae4324c54f6ddef34009ca03>`
	DPCTLQueue_SubmitBarrierForEvents(
		:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclQueueRef<doxid-df/d57/dpctl__sycl__types_8h_1af23137a8bf20ff63b10db9f7f987799a>` QRef,
		:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclEventRef<doxid-df/d57/dpctl__sycl__types_8h_1a42590892ae4324c54f6ddef34009ca03>`* DepEvents,
		size_t NDepEvents
		)

C-API wrapper for ``sycl::queue::submit_barrier(event_vector)``.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- QRef

		- An opaque pointer to the ``sycl::queue``.

	*
		- DepEvents

		- List of dependent DPCTLSyclEventRef objects (events) for the barrier. We call ``sycl::handler.depends_on`` for each of the provided events.

	*
		- NDepEvents

		- Size of the DepEvents list.



.. rubric:: Returns:

An opaque pointer to the ``sycl::event`` returned by the ``sycl::queue::submit_barrier()`` function.

.. index:: pair: function; DPCTLCString_Delete
.. _doxid-da/d48/dpctl__utils_8h_1a33267597953b5a15fc3a052e0d09ef06:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_C_EXTERN_C_BEGIN<doxid-d7/d31/_extern_c_8h_1ad85f54ad0bab1d5206255e5920261be3>` :ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` void
	DPCTLCString_Delete(:ref:`__dpctl_take<doxid-d2/d43/group___memory_semantics_1ga17fe5722d78d8ce138ca952889d07bc6>` const char* str)

Deletes the C String argument.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- str

		- C string to be deleted

.. index:: pair: function; DPCTLSize_t_Array_Delete
.. _doxid-da/d48/dpctl__utils_8h_1a8666dbbe5583326eb3b57293be168ffc:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` void
	DPCTLSize_t_Array_Delete(:ref:`__dpctl_take<doxid-d2/d43/group___memory_semantics_1ga17fe5722d78d8ce138ca952889d07bc6>` size_t* arr)

Deletes an array of size_t elements.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- arr

		- Array to be deleted.

Macros
------

.. index:: pair: define; DPCTL_DECLARE_VECTOR_TYPE
.. _doxid-d4/d64/dpctl__vector_8h_1a83a0669601a2adec6b227cc2276a1538:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define DPCTL_DECLARE_VECTOR_TYPE(EL)

Declare an opaque pointer type for a std::vector of opaque pointers wrapping SYCL data types.

.. index:: pair: define; HUGE_VALF
.. _doxid-dd/d1c/dpctl__data__types_8h_1acd69981d54c27fe0ff514645dbfc6359:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define HUGE_VALF

Represents a positive expression of type float.

.. index:: pair: define; INT64_MAX
.. _doxid-dd/d1c/dpctl__data__types_8h_1ad0d744f05898e32d01f73f8af3cd2071:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define INT64_MAX

Represents the largest possible value of a 64 bit signed integer.

.. index:: pair: define; INT64_MIN
.. _doxid-dd/d1c/dpctl__data__types_8h_1ab21f12f372f67b8ff0aa3432336ede67:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define INT64_MIN

Represents the smallest possible value of a 64 bit signed integer.

.. index:: pair: define; UINT64_MAX
.. _doxid-dd/d1c/dpctl__data__types_8h_1a30654b4b67d97c42ca3f9b6052dda916:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define UINT64_MAX

Represents the largest possible value of a 64bit unsigned integer.