.. index:: pair: group; Platform class C wrapper .. _doxid-db/df8/group__PlatformInterface: Platform class C wrapper ======================== .. toctree:: :hidden: Overview ~~~~~~~~ .. ref-code-block:: cpp :class: doxyrest-overview-code-block // global functions DPCTL_API __dpctl_give :ref:`DPCTLSyclPlatformRef` :ref:`DPCTLPlatform_Copy`(__dpctl_keep const :ref:`DPCTLSyclPlatformRef` PRef); DPCTL_API __dpctl_give :ref:`DPCTLSyclPlatformRef` :ref:`DPCTLPlatform_Create`(); DPCTL_API __dpctl_give :ref:`DPCTLSyclPlatformRef` :ref:`DPCTLPlatform_CreateFromSelector`(__dpctl_keep const :ref:`DPCTLSyclDeviceSelectorRef` DSRef); DPCTL_API void :ref:`DPCTLPlatform_Delete`(__dpctl_take :ref:`DPCTLSyclPlatformRef` PRef); DPCTL_API :ref:`DPCTLSyclBackendType` :ref:`DPCTLPlatform_GetBackend`(__dpctl_keep const :ref:`DPCTLSyclPlatformRef` PRef); DPCTL_API const __dpctl_give char* :ref:`DPCTLPlatform_GetName`(__dpctl_keep const :ref:`DPCTLSyclPlatformRef` PRef); DPCTL_API __dpctl_give :ref:`DPCTLPlatformVectorRef` :ref:`DPCTLPlatform_GetPlatforms`(); DPCTL_API const __dpctl_give char* :ref:`DPCTLPlatform_GetVendor`(__dpctl_keep const :ref:`DPCTLSyclPlatformRef` PRef); DPCTL_API const __dpctl_give char* :ref:`DPCTLPlatform_GetVersion`(__dpctl_keep const :ref:`DPCTLSyclPlatformRef` PRef); .. _details-db/df8/group__PlatformInterface: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Global Functions ---------------- .. index:: pair: function; DPCTLPlatform_Copy .. _doxid-db/df8/group__PlatformInterface_1ga5bddf303912d4344608af42735dfd6f8: .. ref-code-block:: cpp :class: doxyrest-title-code-block DPCTL_API __dpctl_give :ref:`DPCTLSyclPlatformRef` DPCTLPlatform_Copy(__dpctl_keep const :ref:`DPCTLSyclPlatformRef` 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-db/df8/group__PlatformInterface_1gacd673cdf058cee9a7422cc55ea0d0357: .. ref-code-block:: cpp :class: doxyrest-title-code-block DPCTL_API __dpctl_give :ref:`DPCTLSyclPlatformRef` DPCTLPlatform_Create() 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-db/df8/group__PlatformInterface_1ga71cf26d634573b7cc86b013f65374015: .. ref-code-block:: cpp :class: doxyrest-title-code-block DPCTL_API __dpctl_give :ref:`DPCTLSyclPlatformRef` DPCTLPlatform_CreateFromSelector(__dpctl_keep const :ref:`DPCTLSyclDeviceSelectorRef` DSRef) Creates a new DPCTLSyclPlatformRef for a SYCL platform constructed using the device_selector wrapped by DPCTLSyclDeviceSelectorRef. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - DSRef - An opaque pointer to a SYCL device_selector object. .. rubric:: Returns: A new DPCTLSyclPlatformRef pointer wrapping a SYCL platform object. .. index:: pair: function; DPCTLPlatform_Delete .. _doxid-db/df8/group__PlatformInterface_1gaa29d07ce2e25dda5ab2e19cba0e18be9: .. ref-code-block:: cpp :class: doxyrest-title-code-block DPCTL_API void DPCTLPlatform_Delete(__dpctl_take :ref:`DPCTLSyclPlatformRef` 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-db/df8/group__PlatformInterface_1ga1e33f8b1f629151fb9a20cdf983b3370: .. ref-code-block:: cpp :class: doxyrest-title-code-block DPCTL_API :ref:`DPCTLSyclBackendType` DPCTLPlatform_GetBackend(__dpctl_keep const :ref:`DPCTLSyclPlatformRef` 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_GetName .. _doxid-db/df8/group__PlatformInterface_1ga41ed6567a6cd47bc50a099d7a18e93e3: .. ref-code-block:: cpp :class: doxyrest-title-code-block DPCTL_API const __dpctl_give char* DPCTLPlatform_GetName(__dpctl_keep const :ref:`DPCTLSyclPlatformRef` 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-db/df8/group__PlatformInterface_1ga91988efbe3617c0edf35d3a0bc2bcf86: .. ref-code-block:: cpp :class: doxyrest-title-code-block DPCTL_API __dpctl_give :ref:`DPCTLPlatformVectorRef` DPCTLPlatform_GetPlatforms() Returns an opaque pointer to a vector of SYCL platforms available on the system. .. rubric:: Returns: A :ref:`DPCTLPlatformVectorRef ` containing :ref:`DPCTLSyclPlatformRef ` objects. .. index:: pair: function; DPCTLPlatform_GetVendor .. _doxid-db/df8/group__PlatformInterface_1ga06c2a3e1b352081fcc0cd7ae55b97766: .. ref-code-block:: cpp :class: doxyrest-title-code-block DPCTL_API const __dpctl_give char* DPCTLPlatform_GetVendor(__dpctl_keep const :ref:`DPCTLSyclPlatformRef` 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 provifing the platform. .. index:: pair: function; DPCTLPlatform_GetVersion .. _doxid-db/df8/group__PlatformInterface_1ga794fb8c5be5cf2a48f63c407cb05bc1f: .. ref-code-block:: cpp :class: doxyrest-title-code-block DPCTL_API const __dpctl_give char* DPCTLPlatform_GetVersion(__dpctl_keep const :ref:`DPCTLSyclPlatformRef` 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.