.. index:: pair: group; Kernel class C wrapper
.. _doxid-d1/dcb/group__KernelInterface:

Kernel class C wrapper
======================

.. toctree::
	:hidden:

Overview
~~~~~~~~




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

	
	// global functions

	DPCTL_API void
	:ref:`DPCTLKernel_Delete<doxid-d1/dcb/group__KernelInterface_1ga02cb1ddc64d9f78d228a5dc222c8862b>`(__dpctl_take :ref:`DPCTLSyclKernelRef<doxid-df/d57/dpctl__sycl__types_8h_1a3f6be07fdf695c015719ce0b0c237844>` KRef);

	DPCTL_API const __dpctl_give char*
	:ref:`DPCTLKernel_GetFunctionName<doxid-d1/dcb/group__KernelInterface_1gae2ce409c1dc3b57349128438c9c9096b>`(__dpctl_keep const :ref:`DPCTLSyclKernelRef<doxid-df/d57/dpctl__sycl__types_8h_1a3f6be07fdf695c015719ce0b0c237844>` KRef);

	DPCTL_API size_t
	:ref:`DPCTLKernel_GetNumArgs<doxid-d1/dcb/group__KernelInterface_1gae585c0ae9e5e1826ca24aac6f9b2a71d>`(__dpctl_keep const :ref:`DPCTLSyclKernelRef<doxid-df/d57/dpctl__sycl__types_8h_1a3f6be07fdf695c015719ce0b0c237844>` KRef);

.. _details-d1/dcb/group__KernelInterface:

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



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

.. index:: pair: function; DPCTLKernel_Delete
.. _doxid-d1/dcb/group__KernelInterface_1ga02cb1ddc64d9f78d228a5dc222c8862b:

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

	DPCTL_API void
	DPCTLKernel_Delete(__dpctl_take :ref:`DPCTLSyclKernelRef<doxid-df/d57/dpctl__sycl__types_8h_1a3f6be07fdf695c015719ce0b0c237844>` KRef)

Deletes the DPCTLSyclKernelRef after casting it to a sycl::kernel.



.. rubric:: Parameters:

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

	*
		- KRef

		- DPCTLSyclKernelRef pointer to an OpenCL interoperability kernel.

.. index:: pair: function; DPCTLKernel_GetFunctionName
.. _doxid-d1/dcb/group__KernelInterface_1gae2ce409c1dc3b57349128438c9c9096b:

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

	DPCTL_API const __dpctl_give char*
	DPCTLKernel_GetFunctionName(__dpctl_keep const :ref:`DPCTLSyclKernelRef<doxid-df/d57/dpctl__sycl__types_8h_1a3f6be07fdf695c015719ce0b0c237844>` KRef)

Returns a C string for the kernel name.



.. rubric:: Parameters:

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

	*
		- KRef

		- DPCTLSyclKernelRef pointer to an OpenCL interoperability kernel.



.. rubric:: Returns:

If a kernel name exists then returns it as a C string, else returns a nullptr.

.. index:: pair: function; DPCTLKernel_GetNumArgs
.. _doxid-d1/dcb/group__KernelInterface_1gae585c0ae9e5e1826ca24aac6f9b2a71d:

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

	DPCTL_API size_t
	DPCTLKernel_GetNumArgs(__dpctl_keep const :ref:`DPCTLSyclKernelRef<doxid-df/d57/dpctl__sycl__types_8h_1a3f6be07fdf695c015719ce0b0c237844>` KRef)

Returns the number of arguments for the OpenCL kernel.



.. rubric:: Parameters:

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

	*
		- KRef

		- DPCTLSyclKernelRef pointer to an OpenCL interoperability kernel.



.. rubric:: Returns:

Returns the number of arguments for the OpenCL interoperability kernel.