vecmem 1.14.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
vecmem::sycl::queue_wrapper Class Reference

Wrapper class for ::sycl::queue. More...

#include <vecmem/utils/sycl/queue_wrapper.hpp>

Public Member Functions

VECMEM_SYCL_EXPORT queue_wrapper ()
 Construct a queue for the default device.
 
VECMEM_SYCL_EXPORT queue_wrapper (void *queue)
 Wrap an existing ::sycl::queue object.
 
VECMEM_SYCL_EXPORT queue_wrapper (const queue_wrapper &parent)
 Copy constructor.
 
VECMEM_SYCL_EXPORT queue_wrapper (queue_wrapper &&parent)
 Move constructor.
 
VECMEM_SYCL_EXPORT ~queue_wrapper ()
 Destructor.
 
VECMEM_SYCL_EXPORT queue_wrapperoperator= (const queue_wrapper &rhs)
 Copy assignment.
 
VECMEM_SYCL_EXPORT queue_wrapperoperator= (queue_wrapper &&rhs)
 Move assignment.
 
VECMEM_SYCL_EXPORT voidqueue ()
 Access a typeless pointer to the managed ::sycl::queue object.
 
VECMEM_SYCL_EXPORT const voidqueue () const
 Access a typeless pointer to the managed ::sycl::queue object.
 
VECMEM_SYCL_EXPORT void synchronize ()
 Wait for all tasks in the queue to complete.
 
VECMEM_SYCL_EXPORT std::string device_name () const
 Get the name of the device that the queue operates on.
 
bool is_cpu () const
 Check if it's a CPU queue.
 
bool is_gpu () const
 Check if it's a GPU queue.
 
bool is_accelerator () const
 Check if it's an accelerator (FPGA) queue.
 
bool is_opencl () const
 Check if it's an OpenCL queue.
 
bool is_level0 () const
 Check if it's a Level-0 queue.
 
bool is_cuda () const
 Check if it's a CUDA queue.
 
bool is_hip () const
 Check if it's a HIP queue.
 

Detailed Description

Wrapper class for ::sycl::queue.

It is necessary for passing around SYCL queue objects in code that should not be directly exposed to the SYCL headers.

Constructor & Destructor Documentation

◆ queue_wrapper()

VECMEM_SYCL_EXPORT vecmem::sycl::queue_wrapper::queue_wrapper ( void queue)

Wrap an existing ::sycl::queue object.

Without taking ownership of it!


The documentation for this class was generated from the following file: