.. index:: pair: group; Platform class C wrapper
.. _doxid-da/dbd/group___platform_interface:

Platform class C wrapper
========================

.. toctree::
	:hidden:

Overview
~~~~~~~~




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

	
	// global functions

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` bool
	:ref:`DPCTLPlatform_AreEq<doxid-da/dbd/group___platform_interface_1ga47996ef38b50c957739808330bce7d98>`(
		:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>` PRef1,
		:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>` PRef2
		);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`__dpctl_give<doxid-d2/d43/group___memory_semantics_1ga836492a42cdfef6419378dbf8d81f452>` :ref:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>`
	:ref:`DPCTLPlatform_Copy<doxid-da/dbd/group___platform_interface_1ga5bddf303912d4344608af42735dfd6f8>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>` PRef);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`__dpctl_give<doxid-d2/d43/group___memory_semantics_1ga836492a42cdfef6419378dbf8d81f452>` :ref:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>`
	:ref:`DPCTLPlatform_Create<doxid-da/dbd/group___platform_interface_1ga6b3412dfc90659a68beb778747211115>`(void);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`__dpctl_give<doxid-d2/d43/group___memory_semantics_1ga836492a42cdfef6419378dbf8d81f452>` :ref:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>`
	:ref:`DPCTLPlatform_CreateFromSelector<doxid-da/dbd/group___platform_interface_1ga71cf26d634573b7cc86b013f65374015>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceSelectorRef<doxid-df/d57/dpctl__sycl__types_8h_1a50a1c6c98f4ca4a27a88e53a7f3eeb83>` DSRef);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` void
	:ref:`DPCTLPlatform_Delete<doxid-da/dbd/group___platform_interface_1gaa29d07ce2e25dda5ab2e19cba0e18be9>`(:ref:`__dpctl_take<doxid-d2/d43/group___memory_semantics_1ga17fe5722d78d8ce138ca952889d07bc6>` :ref:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>` PRef);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`DPCTLSyclBackendType<doxid-d3/d94/dpctl__sycl__enum__types_8h_1aa217d239d7e3752c49bd9fd42c71c933>`
	:ref:`DPCTLPlatform_GetBackend<doxid-da/dbd/group___platform_interface_1ga1e33f8b1f629151fb9a20cdf983b3370>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>` PRef);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`__dpctl_give<doxid-d2/d43/group___memory_semantics_1ga836492a42cdfef6419378dbf8d81f452>` :ref:`DPCTLSyclContextRef<doxid-df/d57/dpctl__sycl__types_8h_1accf78808322af80b73da617cb2f15f08>`
	:ref:`DPCTLPlatform_GetDefaultContext<doxid-da/dbd/group___platform_interface_1ga37bec32a093850b5edfb231586097652>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>` PRef);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`__dpctl_give<doxid-d2/d43/group___memory_semantics_1ga836492a42cdfef6419378dbf8d81f452>` const char*
	:ref:`DPCTLPlatform_GetName<doxid-da/dbd/group___platform_interface_1ga5d1642698b3c0fbf5e577742447f9618>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>` PRef);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`__dpctl_give<doxid-d2/d43/group___memory_semantics_1ga836492a42cdfef6419378dbf8d81f452>` :ref:`DPCTLPlatformVectorRef<doxid-d5/dcf/group___platform_manager_1ga18dc8588af45614eb2f4a9f7b25a6047>`
	:ref:`DPCTLPlatform_GetPlatforms<doxid-da/dbd/group___platform_interface_1gacdbf951bfb74e4578af431fa2a7063cb>`(void);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`__dpctl_give<doxid-d2/d43/group___memory_semantics_1ga836492a42cdfef6419378dbf8d81f452>` const char*
	:ref:`DPCTLPlatform_GetVendor<doxid-da/dbd/group___platform_interface_1ga9cdd99515c9e957cc6056c97d3ee12ad>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>` PRef);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`__dpctl_give<doxid-d2/d43/group___memory_semantics_1ga836492a42cdfef6419378dbf8d81f452>` const char*
	:ref:`DPCTLPlatform_GetVersion<doxid-da/dbd/group___platform_interface_1gae715cdc1ac7a46ae61e626600c269fb9>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>` PRef);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` size_t
	:ref:`DPCTLPlatform_Hash<doxid-da/dbd/group___platform_interface_1gac7cc24c940cc4956b736a5612c4777ef>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` :ref:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>` PRef);

.. _details-da/dbd/group___platform_interface:

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



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

.. index:: pair: function; DPCTLPlatform_AreEq
.. _doxid-da/dbd/group___platform_interface_1ga47996ef38b50c957739808330bce7d98:

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

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` bool
	DPCTLPlatform_AreEq(
		:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>` PRef1,
		:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>` PRef2
		)

Checks if two DPCTLSyclPlatformRef objects point to the same sycl::platform.



.. rubric:: Parameters:

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

	*
		- PRef1

		- First opaque pointer to a ``sycl::platform``.

	*
		- PRef2

		- Second opaque pointer to a ``sycl::platform``.



.. rubric:: Returns:

True if the underlying sycl::platform are same, false otherwise.

.. index:: pair: function; DPCTLPlatform_Copy
.. _doxid-da/dbd/group___platform_interface_1ga5bddf303912d4344608af42735dfd6f8:

.. 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:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>`
	DPCTLPlatform_Copy(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>` PRef)

Returns a copy of the DPCTLSyclPlatformRef object.



.. rubric:: Parameters:

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

	*
		- PRef

		- DPCTLSyclPlatformRef object to be copied.



.. rubric:: Returns:

A new DPCTLSyclPlatformRef created by copying the passed in DPCTLSyclPlatformRef object.

.. index:: pair: function; DPCTLPlatform_Create
.. _doxid-da/dbd/group___platform_interface_1ga6b3412dfc90659a68beb778747211115:

.. 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:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>`
	DPCTLPlatform_Create(void)

Creates a new DPCTLSyclPlatformRef for a SYCL platform constructed using SYCL's default_selector.



.. rubric:: Returns:

A new DPCTLSyclPlatformRef pointer wrapping a SYCL platform object.

.. index:: pair: function; DPCTLPlatform_CreateFromSelector
.. _doxid-da/dbd/group___platform_interface_1ga71cf26d634573b7cc86b013f65374015:

.. 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:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>`
	DPCTLPlatform_CreateFromSelector(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceSelectorRef<doxid-df/d57/dpctl__sycl__types_8h_1a50a1c6c98f4ca4a27a88e53a7f3eeb83>` DSRef)

Creates a new DPCTLSyclPlatformRef for a SYCL platform constructed using the dpctl_device_selector wrapped by DPCTLSyclDeviceSelectorRef.



.. rubric:: Parameters:

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

	*
		- DSRef

		- An opaque pointer to a SYCL dpctl_device_selector object.



.. rubric:: Returns:

A new DPCTLSyclPlatformRef pointer wrapping a SYCL platform object.

.. index:: pair: function; DPCTLPlatform_Delete
.. _doxid-da/dbd/group___platform_interface_1gaa29d07ce2e25dda5ab2e19cba0e18be9:

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

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` void
	DPCTLPlatform_Delete(:ref:`__dpctl_take<doxid-d2/d43/group___memory_semantics_1ga17fe5722d78d8ce138ca952889d07bc6>` :ref:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>` PRef)

Deletes the DPCTLSyclProgramRef pointer.



.. rubric:: Parameters:

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

	*
		- PRef

		- An opaque pointer to a sycl::platform.

.. index:: pair: function; DPCTLPlatform_GetBackend
.. _doxid-da/dbd/group___platform_interface_1ga1e33f8b1f629151fb9a20cdf983b3370:

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

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`DPCTLSyclBackendType<doxid-d3/d94/dpctl__sycl__enum__types_8h_1aa217d239d7e3752c49bd9fd42c71c933>`
	DPCTLPlatform_GetBackend(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>` PRef)

Returns a DPCTLSyclBackendType enum value identifying the SYCL backend associated with the platform.



.. rubric:: Parameters:

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

	*
		- PRef

		- Opaque pointer to a sycl::platform



.. rubric:: Returns:

A DPCTLSyclBackendType enum value identifying the SYCL backend associated with the platform.

.. index:: pair: function; DPCTLPlatform_GetDefaultContext
.. _doxid-da/dbd/group___platform_interface_1ga37bec32a093850b5edfb231586097652:

.. 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:`DPCTLSyclContextRef<doxid-df/d57/dpctl__sycl__types_8h_1accf78808322af80b73da617cb2f15f08>`
	DPCTLPlatform_GetDefaultContext(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>` PRef)

Returns a DPCTLSyclContextRef for default platform context.



.. rubric:: Parameters:

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

	*
		- PRef

		- Opaque pointer to a sycl::platform



.. rubric:: Returns:

A DPCTLSyclContextRef value for the default platform associated with this platform.

.. index:: pair: function; DPCTLPlatform_GetName
.. _doxid-da/dbd/group___platform_interface_1ga5d1642698b3c0fbf5e577742447f9618:

.. 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>` const char*
	DPCTLPlatform_GetName(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>` PRef)

Returns a C string for the platform name.



.. rubric:: Parameters:

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

	*
		- PRef

		- Opaque pointer to a sycl::platform



.. rubric:: Returns:

A C string containing the name of the sycl::platform.

.. index:: pair: function; DPCTLPlatform_GetPlatforms
.. _doxid-da/dbd/group___platform_interface_1gacdbf951bfb74e4578af431fa2a7063cb:

.. 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:`DPCTLPlatformVectorRef<doxid-d5/dcf/group___platform_manager_1ga18dc8588af45614eb2f4a9f7b25a6047>`
	DPCTLPlatform_GetPlatforms(void)

Returns an opaque pointer to a vector of SYCL platforms available on the system.



.. rubric:: Returns:

A :ref:`DPCTLPlatformVectorRef <doxid-d5/dcf/group___platform_manager_1ga18dc8588af45614eb2f4a9f7b25a6047>` containing :ref:`DPCTLSyclPlatformRef <doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>` objects.

.. index:: pair: function; DPCTLPlatform_GetVendor
.. _doxid-da/dbd/group___platform_interface_1ga9cdd99515c9e957cc6056c97d3ee12ad:

.. 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>` const char*
	DPCTLPlatform_GetVendor(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>` PRef)

Returns a C string corresponding to the vendor providing the platform.



.. rubric:: Parameters:

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

	*
		- PRef

		- Opaque pointer to a sycl::platform



.. rubric:: Returns:

A C string containing the name of the vendor providing the platform.

.. index:: pair: function; DPCTLPlatform_GetVersion
.. _doxid-da/dbd/group___platform_interface_1gae715cdc1ac7a46ae61e626600c269fb9:

.. 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>` const char*
	DPCTLPlatform_GetVersion(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>` PRef)

Returns the software driver version of the sycl::platform as a C string.



.. rubric:: Parameters:

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

	*
		- PRef

		- Opaque pointer to a sycl::platform



.. rubric:: Returns:

A C string containing the software driver version of the device associated with the platform.

.. index:: pair: function; DPCTLPlatform_Hash
.. _doxid-da/dbd/group___platform_interface_1gac7cc24c940cc4956b736a5612c4777ef:

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

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` size_t
	DPCTLPlatform_Hash(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` :ref:`DPCTLSyclPlatformRef<doxid-df/d57/dpctl__sycl__types_8h_1aae750289dcff2c3739f4870086ac7ed0>` PRef)

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



.. rubric:: Parameters:

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

	*
		- PRef

		- The DPCTLSyclPlatformRef pointer.



.. rubric:: Returns:

Hash value of the underlying ``sycl::platform`` instance.