sycl::_V1::queue Class Reference

Encapsulates a single SYCL queue which schedules kernels on a SYCL device. More...

#include <sycl/queue.hpp>

Inheritance diagram for sycl::_V1::queue:

Collaboration diagram for sycl::_V1::queue:

Public Member Functions
	queue (const property_list &PropList={})
	Constructs a SYCL queue instance using the device returned by an instance of default_selector. More...
	queue (const async_handler &AsyncHandler, const property_list &PropList={})
	Constructs a SYCL queue instance with an async_handler using the device returned by an instance of default_selector. More...
template<typename DeviceSelector , typename = detail::EnableIfSYCL2020DeviceSelectorInvocable<DeviceSelector>>
	queue (const DeviceSelector &deviceSelector, const async_handler &AsyncHandler, const property_list &PropList={})
	Constructs a SYCL queue instance using the device identified by the device selector provided. More...
template<typename DeviceSelector , typename = detail::EnableIfSYCL2020DeviceSelectorInvocable<DeviceSelector>>
	queue (const DeviceSelector &deviceSelector, const property_list &PropList={})
	Constructs a SYCL queue instance using the device identified by the device selector provided. More...
template<typename DeviceSelector , typename = detail::EnableIfSYCL2020DeviceSelectorInvocable<DeviceSelector>>
	queue (const context &syclContext, const DeviceSelector &deviceSelector, const property_list &propList={})
	Constructs a SYCL queue instance using the device identified by the device selector provided. More...
template<typename DeviceSelector , typename = detail::EnableIfSYCL2020DeviceSelectorInvocable<DeviceSelector>>
	queue (const context &syclContext, const DeviceSelector &deviceSelector, const async_handler &AsyncHandler, const property_list &propList={})
	Constructs a SYCL queue instance using the device identified by the device selector provided. More...
	__SYCL2020_DEPRECATED ("SYCL 1.2.1 device selectors are deprecated. Please " "use SYCL 2020 device selectors instead.") queue(const device_selector &DeviceSelector
	Constructs a SYCL queue instance using the device returned by the DeviceSelector provided. More...
	__SYCL2020_DEPRECATED ("SYCL 1.2.1 device selectors are deprecated. Please " "use SYCL 2020 device selectors instead.") queue(const context &SyclContext
	Constructs a SYCL queue instance that is associated with the context provided, using the device returned by the device selector. More...
	__SYCL2020_DEPRECATED ("SYCL 1.2.1 device selectors are deprecated. Please " "use SYCL 2020 device selectors instead.") queue(const context &SyclContext
	Constructs a SYCL queue instance with an async_handler that is associated with the context provided, using the device returned by the device selector. More...
	queue (const context &SyclContext, const device &SyclDevice, const property_list &PropList={})
	Constructs a SYCL queue associated with the given context, device and optional properties list. More...
	queue (const context &SyclContext, const device &SyclDevice, const async_handler &AsyncHandler, const property_list &PropList={})
	Constructs a SYCL queue associated with the given context, device, asynchronous exception handler and optional properties list. More...
	queue (const queue &RHS)=default
	Constructs a SYCL queue with an optional async_handler from an OpenCL cl_command_queue. More...
	queue (queue &&RHS)=default
queue &	operator= (const queue &RHS)=default
queue &	operator= (queue &&RHS)=default
bool	operator== (const queue &RHS) const
bool	operator!= (const queue &RHS) const
context	get_context () const
device	get_device () const
	__SYCL2020_DEPRECATED ("is_host() is deprecated as the host device is no longer supported.") bool is_host() const
template<typename Param >
detail::is_queue_info_desc< Param >::return_type	get_info () const
	Queries SYCL queue for information. More...
template<typename T >
event	submit (T CGF _CODELOCPARAM(&CodeLoc))
	Submits a command group function object to the queue, in order to be scheduled for execution on the device. More...
template<typename T >
event	submit (T CGF, queue &SecondaryQueue _CODELOCPARAM(&CodeLoc))
	Submits a command group function object to the queue, in order to be scheduled for execution on the device. More...
event	ext_oneapi_submit_barrier (_CODELOCONLYPARAM(&CodeLoc))
	Prevents any commands submitted afterward to this queue from executing until all commands previously submitted to this queue have entered the complete state. More...
event	submit_barrier (_CODELOCONLYPARAM(&CodeLoc))
	Prevents any commands submitted afterward to this queue from executing until all commands previously submitted to this queue have entered the complete state. More...
event	ext_oneapi_submit_barrier (const std::vector< event > &WaitList _CODELOCPARAM(&CodeLoc))
	Prevents any commands submitted afterward to this queue from executing until all events in WaitList have entered the complete state. More...
event	submit_barrier (const std::vector< event > &WaitList _CODELOCPARAM(&CodeLoc))
	Prevents any commands submitted afterward to this queue from executing until all events in WaitList have entered the complete state. More...
void	wait (_CODELOCONLYPARAM(&CodeLoc))
	Performs a blocking wait for the completion of all enqueued tasks in the queue. More...
void	wait_and_throw (_CODELOCONLYPARAM(&CodeLoc))
	Performs a blocking wait for the completion of all enqueued tasks in the queue. More...
void	wait_proxy (const detail::code_location &CodeLoc)
	Proxy method for wait to forward the code location information to the implementation. More...
void	wait_and_throw_proxy (const detail::code_location &CodeLoc)
	Proxy method for wait_and_throw to forward the code location information to the implementation. More...
void	throw_asynchronous ()
	Checks if any asynchronous errors have been produced by the queue and if so reports them to the async_handler passed on the queue construction. More...
template<typename PropertyT >
bool	has_property () const noexcept
template<typename PropertyT >
PropertyT	get_property () const
template<typename T >
event	fill (void *Ptr, const T &Pattern, size_t Count)
	Fills the specified memory with the specified pattern. More...
template<typename T >
event	fill (void *Ptr, const T &Pattern, size_t Count, event DepEvent)
	Fills the specified memory with the specified pattern. More...
template<typename T >
event	fill (void *Ptr, const T &Pattern, size_t Count, const std::vector< event > &DepEvents)
	Fills the specified memory with the specified pattern. More...
event	memset (void *Ptr, int Value, size_t Count)
	Fills the memory pointed by a USM pointer with the value specified. More...
event	memset (void *Ptr, int Value, size_t Count, event DepEvent)
	Fills the memory pointed by a USM pointer with the value specified. More...
event	memset (void *Ptr, int Value, size_t Count, const std::vector< event > &DepEvents)
	Fills the memory pointed by a USM pointer with the value specified. More...
event	memcpy (void *Dest, const void *Src, size_t Count)
	Copies data from one memory region to another, each is either a host pointer or a pointer within USM allocation accessible on the device associated with this queue. More...
event	memcpy (void *Dest, const void *Src, size_t Count, event DepEvent)
	Copies data from one memory region to another, each is either a host pointer or a pointer within USM allocation accessible on the device associated with this queue. More...
event	memcpy (void *Dest, const void *Src, size_t Count, const std::vector< event > &DepEvents)
	Copies data from one memory region to another, each is either a host pointer or a pointer within USM allocation accessible on the device associated with this queue. More...
template<typename T >
event	copy (const T *Src, T *Dest, size_t Count _CODELOCPARAM(&CodeLoc))
	Copies data from one memory region to another, each is either a host pointer or a pointer within USM allocation accessible on the device associated with this queue. More...
template<typename T >
event	copy (const T *Src, T *Dest, size_t Count, event DepEvent _CODELOCPARAM(&CodeLoc))
	Copies data from one memory region to another, each is either a host pointer or a pointer within USM allocation accessible on the device associated with this queue. More...
template<typename T >
event	copy (const T *Src, T *Dest, size_t Count, const std::vector< event > &DepEvents _CODELOCPARAM(&CodeLoc))
	Copies data from one memory region to another, each is either a host pointer or a pointer within USM allocation accessible on the device associated with this queue. More...
event	mem_advise (const void *Ptr, size_t Length, pi_mem_advice Advice)
	Provides additional information to the underlying runtime about how different allocations are used. More...
event	mem_advise (const void *Ptr, size_t Length, int Advice)
	Provides additional information to the underlying runtime about how different allocations are used. More...
event	mem_advise (const void *Ptr, size_t Length, int Advice, event DepEvent)
	Provides additional information to the underlying runtime about how different allocations are used. More...
event	mem_advise (const void *Ptr, size_t Length, int Advice, const std::vector< event > &DepEvents)
	Provides additional information to the underlying runtime about how different allocations are used. More...
event	prefetch (const void *Ptr, size_t Count)
	Provides hints to the runtime library that data should be made available on a device earlier than Unified Shared Memory would normally require it to be available. More...
event	prefetch (const void *Ptr, size_t Count, event DepEvent)
	Provides hints to the runtime library that data should be made available on a device earlier than Unified Shared Memory would normally require it to be available. More...
event	prefetch (const void *Ptr, size_t Count, const std::vector< event > &DepEvents)
	Provides hints to the runtime library that data should be made available on a device earlier than Unified Shared Memory would normally require it to be available. More...
template<typename T = unsigned char, typename = std::enable_if_t<std::is_same_v<T, unsigned char>>>
event	ext_oneapi_memcpy2d (void *Dest, size_t DestPitch, const void *Src, size_t SrcPitch, size_t Width, size_t Height _CODELOCPARAM(&CodeLoc))
	Copies data from one 2D memory region to another, both pointed by USM pointers. More...
template<typename T = unsigned char, typename = std::enable_if_t<std::is_same_v<T, unsigned char>>>
event	ext_oneapi_memcpy2d (void *Dest, size_t DestPitch, const void *Src, size_t SrcPitch, size_t Width, size_t Height, event DepEvent _CODELOCPARAM(&CodeLoc))
	Copies data from one 2D memory region to another, both pointed by USM pointers. More...
template<typename T = unsigned char, typename = std::enable_if_t<std::is_same_v<T, unsigned char>>>
event	ext_oneapi_memcpy2d (void *Dest, size_t DestPitch, const void *Src, size_t SrcPitch, size_t Width, size_t Height, const std::vector< event > &DepEvents _CODELOCPARAM(&CodeLoc))
	Copies data from one 2D memory region to another, both pointed by USM pointers. More...
template<typename T >
event	ext_oneapi_copy2d (const T *Src, size_t SrcPitch, T *Dest, size_t DestPitch, size_t Width, size_t Height _CODELOCPARAM(&CodeLoc))
	Copies data from one 2D memory region to another, both pointed by USM pointers. More...
template<typename T >
event	ext_oneapi_copy2d (const T *Src, size_t SrcPitch, T *Dest, size_t DestPitch, size_t Width, size_t Height, event DepEvent _CODELOCPARAM(&CodeLoc))
	Copies data from one 2D memory region to another, both pointed by USM pointers. More...
template<typename T >
event	ext_oneapi_copy2d (const T *Src, size_t SrcPitch, T *Dest, size_t DestPitch, size_t Width, size_t Height, const std::vector< event > &DepEvents _CODELOCPARAM(&CodeLoc))
	Copies data from one 2D memory region to another, both pointed by USM pointers. More...
template<typename T = unsigned char, typename = std::enable_if_t<std::is_same_v<T, unsigned char>>>
event	ext_oneapi_memset2d (void *Dest, size_t DestPitch, int Value, size_t Width, size_t Height _CODELOCPARAM(&CodeLoc))
	Fills the memory pointed by a USM pointer with the value specified. More...
template<typename T = unsigned char, typename = std::enable_if_t<std::is_same_v<T, unsigned char>>>
event	ext_oneapi_memset2d (void *Dest, size_t DestPitch, int Value, size_t Width, size_t Height, event DepEvent _CODELOCPARAM(&CodeLoc))
	Fills the memory pointed by a USM pointer with the value specified. More...
template<typename T = unsigned char, typename = std::enable_if_t<std::is_same_v<T, unsigned char>>>
event	ext_oneapi_memset2d (void *Dest, size_t DestPitch, int Value, size_t Width, size_t Height, const std::vector< event > &DepEvents _CODELOCPARAM(&CodeLoc))
	Fills the memory pointed by a USM pointer with the value specified. More...
template<typename T >
event	ext_oneapi_fill2d (void *Dest, size_t DestPitch, const T &Pattern, size_t Width, size_t Height _CODELOCPARAM(&CodeLoc))
	Fills the memory pointed by a USM pointer with the value specified. More...
template<typename T >
event	ext_oneapi_fill2d (void *Dest, size_t DestPitch, const T &Pattern, size_t Width, size_t Height, event DepEvent _CODELOCPARAM(&CodeLoc))
	Fills the memory pointed by a USM pointer with the value specified. More...
template<typename T >
event	ext_oneapi_fill2d (void *Dest, size_t DestPitch, const T &Pattern, size_t Width, size_t Height, const std::vector< event > &DepEvents _CODELOCPARAM(&CodeLoc))
	Fills the memory pointed by a USM pointer with the value specified. More...
template<typename KernelName = detail::auto_name, typename KernelType , typename PropertiesT >
std::enable_if_t< ext::oneapi::experimental::is_property_list< PropertiesT >::value, event >	single_task (PropertiesT Properties, _KERNELFUNCPARAM(KernelFunc) _CODELOCPARAM(&CodeLoc))
	single_task version with a kernel represented as a lambda. More...
template<typename KernelName = detail::auto_name, typename KernelType >
event	single_task (_KERNELFUNCPARAM(KernelFunc) _CODELOCPARAM(&CodeLoc))
	single_task version with a kernel represented as a lambda. More...
template<typename KernelName = detail::auto_name, typename KernelType , typename PropertiesT >
std::enable_if_t< ext::oneapi::experimental::is_property_list< PropertiesT >::value, event >	single_task (event DepEvent, PropertiesT Properties, _KERNELFUNCPARAM(KernelFunc) _CODELOCPARAM(&CodeLoc))
	single_task version with a kernel represented as a lambda. More...
template<typename KernelName = detail::auto_name, typename KernelType >
event	single_task (event DepEvent, _KERNELFUNCPARAM(KernelFunc) _CODELOCPARAM(&CodeLoc))
	single_task version with a kernel represented as a lambda. More...
template<typename KernelName = detail::auto_name, typename KernelType , typename PropertiesT >
std::enable_if_t< ext::oneapi::experimental::is_property_list< PropertiesT >::value, event >	single_task (const std::vector< event > &DepEvents, PropertiesT Properties, _KERNELFUNCPARAM(KernelFunc) _CODELOCPARAM(&CodeLoc))
	single_task version with a kernel represented as a lambda. More...
template<typename KernelName = detail::auto_name, typename KernelType >
event	single_task (const std::vector< event > &DepEvents, _KERNELFUNCPARAM(KernelFunc) _CODELOCPARAM(&CodeLoc))
	single_task version with a kernel represented as a lambda. More...
template<typename KernelName = detail::auto_name, typename... RestT>
event	parallel_for (range< 1 > Range, RestT &&...Rest)
	parallel_for version with a kernel represented as a lambda + range that specifies global size only. More...
template<typename KernelName = detail::auto_name, typename... RestT>
event	parallel_for (range< 2 > Range, RestT &&...Rest)
	parallel_for version with a kernel represented as a lambda + range that specifies global size only. More...
template<typename KernelName = detail::auto_name, typename... RestT>
event	parallel_for (range< 3 > Range, RestT &&...Rest)
	parallel_for version with a kernel represented as a lambda + range that specifies global size only. More...
template<typename KernelName = detail::auto_name, typename... RestT>
event	parallel_for (range< 1 > Range, event DepEvent, RestT &&...Rest)
	parallel_for version with a kernel represented as a lambda + range that specifies global size only. More...
template<typename KernelName = detail::auto_name, typename... RestT>
event	parallel_for (range< 2 > Range, event DepEvent, RestT &&...Rest)
	parallel_for version with a kernel represented as a lambda + range that specifies global size only. More...
template<typename KernelName = detail::auto_name, typename... RestT>
event	parallel_for (range< 3 > Range, event DepEvent, RestT &&...Rest)
	parallel_for version with a kernel represented as a lambda + range that specifies global size only. More...
template<typename KernelName = detail::auto_name, typename... RestT>
event	parallel_for (range< 1 > Range, const std::vector< event > &DepEvents, RestT &&...Rest)
	parallel_for version with a kernel represented as a lambda + range that specifies global size only. More...
template<typename KernelName = detail::auto_name, typename... RestT>
event	parallel_for (range< 2 > Range, const std::vector< event > &DepEvents, RestT &&...Rest)
	parallel_for version with a kernel represented as a lambda + range that specifies global size only. More...
template<typename KernelName = detail::auto_name, typename... RestT>
event	parallel_for (range< 3 > Range, const std::vector< event > &DepEvents, RestT &&...Rest)
	parallel_for version with a kernel represented as a lambda + range that specifies global size only. More...
template<typename KernelName = detail::auto_name, typename KernelType , int Dim>
event	parallel_for (range< Dim > Range, id< Dim > WorkItemOffset, const std::vector< event > &DepEvents, _KERNELFUNCPARAM(KernelFunc))
	parallel_for version with a kernel represented as a lambda + range and offset that specify global size and global offset correspondingly. More...
template<typename KernelName = detail::auto_name, typename KernelType , int Dims>
event	parallel_for_impl (range< Dims > Range, id< Dims > WorkItemOffset, _KERNELFUNCPARAM(KernelFunc))
	parallel_for version with a kernel represented as a lambda + range and offset that specify global size and global offset correspondingly. More...
template<typename KernelName = detail::auto_name, typename KernelType , int Dims>
event	parallel_for_impl (range< Dims > Range, id< Dims > WorkItemOffset, event DepEvent, _KERNELFUNCPARAM(KernelFunc))
	parallel_for version with a kernel represented as a lambda + range and offset that specify global size and global offset correspondingly. More...
template<typename KernelName = detail::auto_name, typename KernelType , int Dims>
event	parallel_for_impl (range< Dims > Range, id< Dims > WorkItemOffset, const std::vector< event > &DepEvents, _KERNELFUNCPARAM(KernelFunc))
	parallel_for version with a kernel represented as a lambda + range and offset that specify global size and global offset correspondingly. More...
template<typename KernelName = detail::auto_name, int Dims, typename PropertiesT , typename... RestT>
std::enable_if_t< detail::AreAllButLastReductions< RestT... >::value &&ext::oneapi::experimental::is_property_list< PropertiesT >::value, event >	parallel_for (nd_range< Dims > Range, PropertiesT Properties, RestT &&...Rest)
	parallel_for version with a kernel represented as a lambda + nd_range that specifies global, local sizes and offset. More...
template<typename KernelName = detail::auto_name, int Dims, typename... RestT>
std::enable_if_t< detail::AreAllButLastReductions< RestT... >::value, event >	parallel_for (nd_range< Dims > Range, RestT &&...Rest)
	parallel_for version with a kernel represented as a lambda + nd_range that specifies global, local sizes and offset. More...
template<typename KernelName = detail::auto_name, int Dims, typename... RestT>
event	parallel_for (nd_range< Dims > Range, event DepEvent, RestT &&...Rest)
	parallel_for version with a kernel represented as a lambda + nd_range that specifies global, local sizes and offset. More...
template<typename KernelName = detail::auto_name, int Dims, typename... RestT>
event	parallel_for (nd_range< Dims > Range, const std::vector< event > &DepEvents, RestT &&...Rest)
	parallel_for version with a kernel represented as a lambda + nd_range that specifies global, local sizes and offset. More...
template<typename SrcT , int SrcDims, access_mode SrcMode, target SrcTgt, access::placeholder IsPlaceholder, typename DestT >
event	copy (accessor< SrcT, SrcDims, SrcMode, SrcTgt, IsPlaceholder > Src, std::shared_ptr< DestT > Dest _CODELOCPARAM(&CodeLoc))
	Copies data from a memory region pointed to by a placeholder accessor to another memory region pointed to by a shared_ptr. More...
template<typename SrcT , typename DestT , int DestDims, access_mode DestMode, target DestTgt, access::placeholder IsPlaceholder>
event	copy (std::shared_ptr< SrcT > Src, accessor< DestT, DestDims, DestMode, DestTgt, IsPlaceholder > Dest _CODELOCPARAM(&CodeLoc))
	Copies data from a memory region pointed to by a shared_ptr to another memory region pointed to by a placeholder accessor. More...
template<typename SrcT , int SrcDims, access_mode SrcMode, target SrcTgt, access::placeholder IsPlaceholder, typename DestT >
event	copy (accessor< SrcT, SrcDims, SrcMode, SrcTgt, IsPlaceholder > Src, DestT *Dest _CODELOCPARAM(&CodeLoc))
	Copies data from a memory region pointed to by a placeholder accessor to another memory region pointed to by a raw pointer. More...
template<typename SrcT , typename DestT , int DestDims, access_mode DestMode, target DestTgt, access::placeholder IsPlaceholder>
event	copy (const SrcT *Src, accessor< DestT, DestDims, DestMode, DestTgt, IsPlaceholder > Dest _CODELOCPARAM(&CodeLoc))
	Copies data from a memory region pointed to by a raw pointer to another memory region pointed to by a placeholder accessor. More...
template<typename SrcT , int SrcDims, access_mode SrcMode, target SrcTgt, access::placeholder IsSrcPlaceholder, typename DestT , int DestDims, access_mode DestMode, target DestTgt, access::placeholder IsDestPlaceholder>
event	copy (accessor< SrcT, SrcDims, SrcMode, SrcTgt, IsSrcPlaceholder > Src, accessor< DestT, DestDims, DestMode, DestTgt, IsDestPlaceholder > Dest _CODELOCPARAM(&CodeLoc))
	Copies data from one memory region to another, both pointed by placeholder accessors. More...
template<typename T , int Dims, access_mode Mode, target Tgt, access::placeholder IsPlaceholder>
event	update_host (accessor< T, Dims, Mode, Tgt, IsPlaceholder > Acc _CODELOCPARAM(&CodeLoc))
	Provides guarantees that the memory object accessed via Acc is updated on the host after operation is complete. More...
template<typename T , int Dims, access_mode Mode, target Tgt, access::placeholder IsPlaceholder>
event	fill (accessor< T, Dims, Mode, Tgt, IsPlaceholder > Dest, const T &Src _CODELOCPARAM(&CodeLoc))
	Fills the specified memory with the specified data. More...
bool	ext_codeplay_supports_fusion () const
	Returns true if the queue was created with the ext::codeplay::experimental::property::queue::enable_fusion property. More...
bool	is_in_order () const
	Returns whether the queue is in order or OoO. More...
backend	get_backend () const noexcept
	Returns the backend associated with this queue. More...
bool	ext_oneapi_empty () const
	Allows to check status of the queue (completed vs noncompleted). More...
Public Member Functions inherited from sycl::_V1::detail::OwnerLessBase< queue >
bool	ext_oneapi_owner_before (const ext::oneapi::detail::weak_object_base< queue > &Other) const noexcept
	Compares the object against a weak object using an owner-based implementation-defined ordering. More...
bool	ext_oneapi_owner_before (const queue &Other) const noexcept
	Compares the object against another object using an owner-based implementation-defined ordering. More...

Public Attributes
const property_list &	PropList
const device_selector &	DeviceSelector
const device_selector const property_list &	PropList = {})
const device_selector const async_handler &	AsyncHandler
const device_selector const async_handler const property_list &	PropList = {})

Friends
template<class T >
T	detail::createSyclObjFromImpl (decltype(T::impl) ImplObj)
template<backend BackendName, class SyclObjectT >
auto	get_native (const SyclObjectT &Obj) -> backend_return_t< BackendName, SyclObjectT >

Detailed Description

Encapsulates a single SYCL queue which schedules kernels on a SYCL device.

A SYCL queue can be used to submit command groups to be executed by the SYCL runtime.

See also

device

handler

event

kernel

Definition at line 88 of file queue.hpp.

Constructor & Destructor Documentation

queue() [1/10]

sycl::_V1::queue::queue ( const property_list &  PropList = {} )

inlineexplicit

Constructs a SYCL queue instance using the device returned by an instance of default_selector.

Parameters

PropList

is a list of properties for queue construction.

Definition at line 94 of file queue.hpp.

queue() [2/10]

sycl::_V1::queue::queue ( const async_handler &  AsyncHandler, const property_list &  PropList = {}  )

inline

Constructs a SYCL queue instance with an async_handler using the device returned by an instance of default_selector.

Parameters

AsyncHandler	is a SYCL asynchronous exception handler.
PropList	is a list of properties for queue construction.

Definition at line 102 of file queue.hpp.

queue() [3/10]

template<typename DeviceSelector , typename = detail::EnableIfSYCL2020DeviceSelectorInvocable<DeviceSelector>>

sycl::_V1::queue::queue ( const DeviceSelector &  deviceSelector, const async_handler &  AsyncHandler, const property_list &  PropList = {}  )

inlineexplicit

Constructs a SYCL queue instance using the device identified by the device selector provided.

Parameters

DeviceSelector	is SYCL 2020 Device Selector, a simple callable that takes a device and returns an int
AsyncHandler	is a SYCL asynchronous exception handler.
PropList	is a list of properties for queue construction.

Definition at line 114 of file queue.hpp.

queue() [4/10]

template<typename DeviceSelector , typename = detail::EnableIfSYCL2020DeviceSelectorInvocable<DeviceSelector>>

sycl::_V1::queue::queue ( const DeviceSelector &  deviceSelector, const property_list &  PropList = {}  )

inlineexplicit

Constructs a SYCL queue instance using the device identified by the device selector provided.

Parameters

DeviceSelector	is SYCL 2020 Device Selector, a simple callable that takes a device and returns an int
PropList	is a list of properties for queue construction.

Definition at line 127 of file queue.hpp.

queue() [5/10]

template<typename DeviceSelector , typename = detail::EnableIfSYCL2020DeviceSelectorInvocable<DeviceSelector>>

sycl::_V1::queue::queue ( const context &  syclContext, const DeviceSelector &  deviceSelector, const property_list &  propList = {}  )

inlineexplicit

Constructs a SYCL queue instance using the device identified by the device selector provided.

Parameters

SyclContext	is an instance of SYCL context.
DeviceSelector	is SYCL 2020 Device Selector, a simple callable that takes a device and returns an int
PropList	is a list of properties for queue construction.

Definition at line 141 of file queue.hpp.

queue() [6/10]

template<typename DeviceSelector , typename = detail::EnableIfSYCL2020DeviceSelectorInvocable<DeviceSelector>>

sycl::_V1::queue::queue ( const context &  syclContext, const DeviceSelector &  deviceSelector, const async_handler &  AsyncHandler, const property_list &  propList = {}  )

inlineexplicit

Constructs a SYCL queue instance using the device identified by the device selector provided.

Parameters

SyclContext	is an instance of SYCL context.
DeviceSelector	is SYCL 2020 Device Selector, a simple callable that takes a device and returns an int
AsyncHandler	is a SYCL asynchronous exception handler.
PropList	is a list of properties for queue construction.

Definition at line 157 of file queue.hpp.

queue() [7/10]

sycl::_V1::queue::queue	(	const context &	SyclContext,
		const device &	SyclDevice,
		const property_list &	PropList = {}
	)

Constructs a SYCL queue associated with the given context, device and optional properties list.

Parameters

SyclContext	is an instance of SYCL context.
SyclDevice	is an instance of SYCL device.
PropList	is a list of properties for queue construction.

Definition at line 67 of file queue.cpp.

queue() [8/10]

sycl::_V1::queue::queue	(	const context &	SyclContext,
		const device &	SyclDevice,
		const async_handler &	AsyncHandler,
		const property_list &	PropList = {}
	)

Constructs a SYCL queue associated with the given context, device, asynchronous exception handler and optional properties list.

Parameters

SyclContext	is an instance of SYCL context.
SyclDevice	is an instance of SYCL device.
AsyncHandler	is a SYCL asynchronous exception handler.
PropList	is a list of properties for queue construction.

Definition at line 41 of file queue.cpp.

References sycl::_V1::detail::getSyclObjImpl().

queue() [9/10]

sycl::_V1::queue::queue ( const queue &  RHS )

default

Constructs a SYCL queue with an optional async_handler from an OpenCL cl_command_queue.

The instance of cl_command_queue is retained on construction.

Parameters

ClQueue	is a valid instance of OpenCL queue.
SyclContext	is a valid SYCL context.
AsyncHandler	is a SYCL asynchronous exception handler.

queue() [10/10]

sycl::_V1::queue::queue ( queue &&  RHS )

default

Member Function Documentation

__SYCL2020_DEPRECATED() [1/4]

sycl::_V1::queue::__SYCL2020_DEPRECATED

(

"is_host() is deprecated as the host device is no longer supported."

)

const

Returns

true if this queue is a SYCL host queue.

__SYCL2020_DEPRECATED() [2/4]

sycl::_V1::queue::__SYCL2020_DEPRECATED

(

"SYCL 1.2.1 device selectors are deprecated. Please " "use SYCL 2020 device selectors instead."

)

const &

Constructs a SYCL queue instance that is associated with the context provided, using the device returned by the device selector.

Parameters

SyclContext	is an instance of SYCL context.
DeviceSelector	is an instance of SYCL device selector.
PropList	is a list of properties for queue construction.

__SYCL2020_DEPRECATED() [3/4]

sycl::_V1::queue::__SYCL2020_DEPRECATED

(

"SYCL 1.2.1 device selectors are deprecated. Please " "use SYCL 2020 device selectors instead."

)

const &

Constructs a SYCL queue instance with an async_handler that is associated with the context provided, using the device returned by the device selector.

Parameters

SyclContext	is an instance of SYCL context.
DeviceSelector	is an instance of SYCL device selector.
AsyncHandler	is a SYCL asynchronous exception handler.
PropList	is a list of properties for queue construction.

__SYCL2020_DEPRECATED() [4/4]

sycl::_V1::queue::__SYCL2020_DEPRECATED

(

"SYCL 1.2.1 device selectors are deprecated. Please " "use SYCL 2020 device selectors instead."

)

const &

Constructs a SYCL queue instance using the device returned by the DeviceSelector provided.

Parameters

DeviceSelector	is an instance of a SYCL 1.2.1 device_selector.
PropList	is a list of properties for queue construction.

copy() [1/8]

template<typename SrcT , int SrcDims, access_mode SrcMode, target SrcTgt, access::placeholder IsPlaceholder, typename DestT >

event sycl::_V1::queue::copy ( accessor< SrcT, SrcDims, SrcMode, SrcTgt, IsPlaceholder >  Src, DestT *Dest _CODELOCPARAM &  CodeLoc  )

inline

Copies data from a memory region pointed to by a placeholder accessor to another memory region pointed to by a raw pointer.

Parameters

Src	is a placeholder accessor to the source memory.
Dest	is a raw pointer to the destination memory.

Returns

an event representing copy operation.

Definition at line 1515 of file queue.hpp.

References _CODELOCFW, sycl::_V1::handler::copy(), and sycl::_V1::handler::require().

copy() [2/8]

template<typename SrcT , int SrcDims, access_mode SrcMode, target SrcTgt, access::placeholder IsPlaceholder, typename DestT >

event sycl::_V1::queue::copy ( accessor< SrcT, SrcDims, SrcMode, SrcTgt, IsPlaceholder >  Src, std::shared_ptr< DestT > Dest _CODELOCPARAM &  CodeLoc  )

inline

Copies data from a memory region pointed to by a placeholder accessor to another memory region pointed to by a shared_ptr.

Parameters

Src	is a placeholder accessor to the source memory.
Dest	is a shared_ptr to the destination memory.

Returns

an event representing copy operation.

Definition at line 1482 of file queue.hpp.

References _CODELOCFW, sycl::_V1::handler::copy(), and sycl::_V1::handler::require().

copy() [3/8]

template<typename SrcT , int SrcDims, access_mode SrcMode, target SrcTgt, access::placeholder IsSrcPlaceholder, typename DestT , int DestDims, access_mode DestMode, target DestTgt, access::placeholder IsDestPlaceholder>

event sycl::_V1::queue::copy ( accessor< SrcT, SrcDims, SrcMode, SrcTgt, IsSrcPlaceholder >  Src, accessor< DestT, DestDims, DestMode, DestTgt, IsDestPlaceholder > Dest _CODELOCPARAM &  CodeLoc  )

inline

Copies data from one memory region to another, both pointed by placeholder accessors.

Parameters

Src	is a placeholder accessor to the source memory.
Dest	is a placeholder accessor to the destination memory.

Returns

an event representing copy operation.

Definition at line 1551 of file queue.hpp.

References _CODELOCFW, sycl::_V1::handler::copy(), and sycl::_V1::handler::require().

copy() [4/8]

template<typename SrcT , typename DestT , int DestDims, access_mode DestMode, target DestTgt, access::placeholder IsPlaceholder>

event sycl::_V1::queue::copy ( const SrcT *  Src, accessor< DestT, DestDims, DestMode, DestTgt, IsPlaceholder > Dest _CODELOCPARAM &  CodeLoc  )

inline

Copies data from a memory region pointed to by a raw pointer to another memory region pointed to by a placeholder accessor.

Parameters

Src	is a raw pointer to the source memory.
Dest	is a placeholder accessor to the destination memory.

Returns

an event representing copy operation.

Definition at line 1531 of file queue.hpp.

References _CODELOCFW, sycl::_V1::handler::copy(), and sycl::_V1::handler::require().

copy() [5/8]

template<typename T >

event sycl::_V1::queue::copy ( const T *  Src, T *  Dest, size_t Count _CODELOCPARAM &  CodeLoc  )

inline

Copies data from one memory region to another, each is either a host pointer or a pointer within USM allocation accessible on the device associated with this queue.

No operations is done if

Parameters

Count	is zero. An exception is thrown if either
Dest	or
Src	is nullptr. The behavior is undefined if any of the pointer parameters is invalid.
Src	is a USM pointer to the source memory.
Dest	is a USM pointer to the destination memory.
Count	is a number of elements of type T to copy.
CodeLoc	contains the code location of user code

Returns

an event representing copy operation.

Definition at line 613 of file queue.hpp.

References _CODELOCARG, and sycl::_V1::detail::memcpy().

copy() [6/8]

template<typename T >

event sycl::_V1::queue::copy ( const T *  Src, T *  Dest, size_t  Count, const std::vector< event > &DepEvents _CODELOCPARAM &  CodeLoc  )

inline

Copies data from one memory region to another, each is either a host pointer or a pointer within USM allocation accessible on the device associated with this queue.

No operations is done if

Parameters

Count	is zero. An exception is thrown if either
Dest	or
Src	is nullptr. The behavior is undefined if any of the pointer parameters is invalid.
Src	is a USM pointer to the source memory.
Dest	is a USM pointer to the destination memory.
Count	is a number of elements of type T to copy.
DepEvents	is a vector of events that specifies the kernel
CodeLoc	contains the code location of user code

Returns

an event representing copy operation.

Definition at line 654 of file queue.hpp.

References _CODELOCARG, and sycl::_V1::detail::memcpy().

copy() [7/8]

template<typename T >

event sycl::_V1::queue::copy ( const T *  Src, T *  Dest, size_t  Count, event DepEvent _CODELOCPARAM &  CodeLoc  )

inline

Copies data from one memory region to another, each is either a host pointer or a pointer within USM allocation accessible on the device associated with this queue.

No operations is done if

Parameters

Count	is zero. An exception is thrown if either
Dest	or
Src	is nullptr. The behavior is undefined if any of the pointer parameters is invalid.
Src	is a USM pointer to the source memory.
Dest	is a USM pointer to the destination memory.
Count	is a number of elements of type T to copy.
DepEvent	is an event that specifies the kernel dependencies.
CodeLoc	contains the code location of user code

Returns

an event representing copy operation.

Definition at line 633 of file queue.hpp.

References _CODELOCARG, and sycl::_V1::detail::memcpy().

copy() [8/8]

template<typename SrcT , typename DestT , int DestDims, access_mode DestMode, target DestTgt, access::placeholder IsPlaceholder>

event sycl::_V1::queue::copy ( std::shared_ptr< SrcT >  Src, accessor< DestT, DestDims, DestMode, DestTgt, IsPlaceholder > Dest _CODELOCPARAM &  CodeLoc  )

inline

Copies data from a memory region pointed to by a shared_ptr to another memory region pointed to by a placeholder accessor.

Parameters

Src	is a shared_ptr to the source memory.
Dest	is a placeholder accessor to the destination memory.

Returns

an event representing copy operation.

Definition at line 1498 of file queue.hpp.

References _CODELOCFW, sycl::_V1::handler::copy(), and sycl::_V1::handler::require().

ext_codeplay_supports_fusion()

bool sycl::_V1::queue::ext_codeplay_supports_fusion

(

)

const

Returns true if the queue was created with the ext::codeplay::experimental::property::queue::enable_fusion property.

Equivalent to has_property<ext::codeplay::experimental::property::queue::enable_fusion>().

Definition at line 221 of file queue.cpp.

Referenced by sycl::_V1::ext::codeplay::experimental::fusion_wrapper::fusion_wrapper().

ext_oneapi_copy2d() [1/3]

template<typename T >

event sycl::_V1::queue::ext_oneapi_copy2d ( const T *  Src, size_t  SrcPitch, T *  Dest, size_t  DestPitch, size_t  Width, size_t Height _CODELOCPARAM &  CodeLoc  )

inline

Copies data from one 2D memory region to another, both pointed by USM pointers.

No operations is done if

Parameters

Width	or
Height	is zero. An exception is thrown if either
Dest	or
Src	is nullptr or if
Width	is strictly greater than either
DestPitch	or
SrcPitch.	The behavior is undefined if any of the pointer parameters is invalid.
Src	is a USM pointer to the source memory.
SrcPitch	is the pitch of the rows in
Src.
Dest	is a USM pointer to the destination memory.
DestPitch	is the pitch of the rows in
Dest.
Width	is the width in number of elements of the 2D region to copy.
Height	is the height in number of rows of the 2D region to copy.

Returns

an event representing the copy operation.

Definition at line 851 of file queue.hpp.

References _CODELOCFW, and sycl::_V1::handler::ext_oneapi_copy2d().

ext_oneapi_copy2d() [2/3]

template<typename T >

event sycl::_V1::queue::ext_oneapi_copy2d ( const T *  Src, size_t  SrcPitch, T *  Dest, size_t  DestPitch, size_t  Width, size_t  Height, const std::vector< event > &DepEvents _CODELOCPARAM &  CodeLoc  )

inline

Copies data from one 2D memory region to another, both pointed by USM pointers.

No operations is done if

Parameters

Width	or
Height	is zero. An exception is thrown if either
Dest	or
Src	is nullptr or if
Width	is strictly greater than either
DestPitch	or
SrcPitch.	The behavior is undefined if any of the pointer parameters is invalid.
Src	is a USM pointer to the source memory.
SrcPitch	is the pitch of the rows in
Src.
Dest	is a USM pointer to the destination memory.
DestPitch	is the pitch of the rows in
Dest.
Width	is the width in number of elements of the 2D region to copy.
Height	is the height in number of rows of the 2D region to copy.
DepEvents	is a vector of events that specifies the kernel dependencies.

Returns

an event representing the copy operation.

Definition at line 903 of file queue.hpp.

References _CODELOCFW, sycl::_V1::handler::depends_on(), and sycl::_V1::handler::ext_oneapi_copy2d().

ext_oneapi_copy2d() [3/3]

template<typename T >

event sycl::_V1::queue::ext_oneapi_copy2d ( const T *  Src, size_t  SrcPitch, T *  Dest, size_t  DestPitch, size_t  Width, size_t  Height, event DepEvent _CODELOCPARAM &  CodeLoc  )

inline

Copies data from one 2D memory region to another, both pointed by USM pointers.

No operations is done if

Parameters

Width	or
Height	is zero. An exception is thrown if either
Dest	or
Src	is nullptr or if
Width	is strictly greater than either
DestPitch	or
SrcPitch.	The behavior is undefined if any of the pointer parameters is invalid.
Src	is a USM pointer to the source memory.
SrcPitch	is the pitch of the rows in
Src.
Dest	is a USM pointer to the destination memory.
DestPitch	is the pitch of the rows in
Dest.
Width	is the width in number of elements of the 2D region to copy.
Height	is the height in number of rows of the 2D region to copy.
DepEvent	is an event that specifies the kernel dependencies.

Returns

an event representing the copy operation.

Definition at line 876 of file queue.hpp.

References _CODELOCFW, sycl::_V1::handler::depends_on(), and sycl::_V1::handler::ext_oneapi_copy2d().

ext_oneapi_empty()

bool sycl::_V1::queue::ext_oneapi_empty

(

)

const

Allows to check status of the queue (completed vs noncompleted).

Returns

returns true if all enqueued commands in the queue have been completed, otherwise returns false.

Definition at line 208 of file queue.cpp.

ext_oneapi_fill2d() [1/3]

template<typename T >

event sycl::_V1::queue::ext_oneapi_fill2d ( void *  Dest, size_t  DestPitch, const T &  Pattern, size_t  Width, size_t Height _CODELOCPARAM &  CodeLoc  )

inline

Fills the memory pointed by a USM pointer with the value specified.

No operations is done if

Parameters

Width	or
Height	is zero. An exception is thrown if either
Dest	or
Src	is nullptr or if
Width	is strictly greater than
DestPitch.	The behavior is undefined if any of the pointer parameters is invalid.
Dest	is a USM pointer to the destination memory.
DestPitch	is the pitch of the rows in
Dest.
Pattern	is the pattern to fill into the memory. T should be trivially copyable.
Width	is the width in number of elements of the 2D region to fill.
Height	is the height in number of rows of the 2D region to fill.

Returns

an event representing the fill operation.

Definition at line 1010 of file queue.hpp.

References _CODELOCFW, and sycl::_V1::handler::ext_oneapi_fill2d().

ext_oneapi_fill2d() [2/3]

template<typename T >

event sycl::_V1::queue::ext_oneapi_fill2d ( void *  Dest, size_t  DestPitch, const T &  Pattern, size_t  Width, size_t  Height, const std::vector< event > &DepEvents _CODELOCPARAM &  CodeLoc  )

inline

Fills the memory pointed by a USM pointer with the value specified.

No operations is done if

Parameters

Width	or
Height	is zero. An exception is thrown if either
Dest	or
Src	is nullptr or if
Width	is strictly greater than
DestPitch.	The behavior is undefined if any of the pointer parameters is invalid.
Dest	is a USM pointer to the destination memory.
DestPitch	is the pitch of the rows in
Dest.
Pattern	is the pattern to fill into the memory. T should be trivially copyable.
Width	is the width in number of elements of the 2D region to fill.
Height	is the height in number of rows of the 2D region to fill.
DepEvents	is a vector of events that specifies the kernel dependencies.

Returns

an event representing the fill operation.

Definition at line 1057 of file queue.hpp.

References _CODELOCFW, sycl::_V1::handler::depends_on(), and sycl::_V1::handler::ext_oneapi_fill2d().

ext_oneapi_fill2d() [3/3]

template<typename T >

event sycl::_V1::queue::ext_oneapi_fill2d ( void *  Dest, size_t  DestPitch, const T &  Pattern, size_t  Width, size_t  Height, event DepEvent _CODELOCPARAM &  CodeLoc  )

inline

Fills the memory pointed by a USM pointer with the value specified.

No operations is done if

Parameters

Width	or
Height	is zero. An exception is thrown if either
Dest	or
Src	is nullptr or if
Width	is strictly greater than
DestPitch.	The behavior is undefined if any of the pointer parameters is invalid.
Dest	is a USM pointer to the destination memory.
DestPitch	is the pitch of the rows in
Dest.
Pattern	is the pattern to fill into the memory. T should be trivially copyable.
Width	is the width in number of elements of the 2D region to fill.
Height	is the height in number of rows of the 2D region to fill.
DepEvent	is an event that specifies the kernel dependencies.

Returns

an event representing the fill operation.

Definition at line 1032 of file queue.hpp.

References _CODELOCFW, sycl::_V1::handler::depends_on(), and sycl::_V1::handler::ext_oneapi_fill2d().

ext_oneapi_memcpy2d() [1/3]

template<typename T = unsigned char, typename = std::enable_if_t<std::is_same_v<T, unsigned char>>>

event sycl::_V1::queue::ext_oneapi_memcpy2d ( void *  Dest, size_t  DestPitch, const void *  Src, size_t  SrcPitch, size_t  Width, size_t Height _CODELOCPARAM &  CodeLoc  )

inline

Copies data from one 2D memory region to another, both pointed by USM pointers.

No operations is done if

Parameters

Width	or
Height	is zero. An exception is thrown if either
Dest	or
Src	is nullptr or if
Width	is strictly greater than either
DestPitch	or
SrcPitch.	The behavior is undefined if any of the pointer parameters is invalid.

NOTE: Function is dependent to prevent the fallback kernels from materializing without the use of the function.

Parameters

Dest	is a USM pointer to the destination memory.
DestPitch	is the pitch of the rows in
Dest.
Src	is a USM pointer to the source memory.
SrcPitch	is the pitch of the rows in
Src.
Width	is the width in bytes of the 2D region to copy.
Height	is the height in number of rows of the 2D region to copy.

Returns

an event representing the copy operation.

Definition at line 765 of file queue.hpp.

References _CODELOCFW, and sycl::_V1::handler::ext_oneapi_memcpy2d().

ext_oneapi_memcpy2d() [2/3]

template<typename T = unsigned char, typename = std::enable_if_t<std::is_same_v<T, unsigned char>>>

event sycl::_V1::queue::ext_oneapi_memcpy2d ( void *  Dest, size_t  DestPitch, const void *  Src, size_t  SrcPitch, size_t  Width, size_t  Height, const std::vector< event > &DepEvents _CODELOCPARAM &  CodeLoc  )

inline

Copies data from one 2D memory region to another, both pointed by USM pointers.

No operations is done if

Parameters

Width	or
Height	is zero. An exception is thrown if either
Dest	or
Src	is nullptr or if
Width	is strictly greater than either
DestPitch	or
SrcPitch.	The behavior is undefined if any of the pointer parameters is invalid.

NOTE: Function is dependent to prevent the fallback kernels from materializing without the use of the function.

Parameters

Dest	is a USM pointer to the destination memory.
DestPitch	is the pitch of the rows in
Dest.
Src	is a USM pointer to the source memory.
SrcPitch	is the pitch of the rows in
Src.
Width	is the width in bytes of the 2D region to copy.
Height	is the height in number of rows of the 2D region to copy.
DepEvents	is a vector of events that specifies the kernel dependencies.

Returns

an event representing the copy operation.

Definition at line 825 of file queue.hpp.

References _CODELOCFW, sycl::_V1::handler::depends_on(), and sycl::_V1::handler::ext_oneapi_memcpy2d().

ext_oneapi_memcpy2d() [3/3]

template<typename T = unsigned char, typename = std::enable_if_t<std::is_same_v<T, unsigned char>>>

event sycl::_V1::queue::ext_oneapi_memcpy2d ( void *  Dest, size_t  DestPitch, const void *  Src, size_t  SrcPitch, size_t  Width, size_t  Height, event DepEvent _CODELOCPARAM &  CodeLoc  )

inline

Copies data from one 2D memory region to another, both pointed by USM pointers.

No operations is done if

Parameters

Width	or
Height	is zero. An exception is thrown if either
Dest	or
Src	is nullptr or if
Width	is strictly greater than either
DestPitch	or
SrcPitch.	The behavior is undefined if any of the pointer parameters is invalid.

NOTE: Function is dependent to prevent the fallback kernels from materializing without the use of the function.

Parameters

Dest	is a USM pointer to the destination memory.
DestPitch	is the pitch of the rows in
Dest.
Src	is a USM pointer to the source memory.
SrcPitch	is the pitch of the rows in
Src.
Width	is the width in bytes of the 2D region to copy.
Height	is the height in number of rows of the 2D region to copy.
DepEvent	is an event that specifies the kernel dependencies.

Returns

an event representing the copy operation.

Definition at line 794 of file queue.hpp.

References _CODELOCFW, sycl::_V1::handler::depends_on(), and sycl::_V1::handler::ext_oneapi_memcpy2d().

ext_oneapi_memset2d() [1/3]

template<typename T = unsigned char, typename = std::enable_if_t<std::is_same_v<T, unsigned char>>>

event sycl::_V1::queue::ext_oneapi_memset2d ( void *  Dest, size_t  DestPitch, int  Value, size_t  Width, size_t Height _CODELOCPARAM &  CodeLoc  )

inline

Fills the memory pointed by a USM pointer with the value specified.

No operations is done if

Parameters

Width	or
Height	is zero. An exception is thrown if either
Dest	or
Src	is nullptr or if
Width	is strictly greater than
DestPitch.	The behavior is undefined if any of the pointer parameters is invalid.

NOTE: Function is dependent to prevent the fallback kernels from materializing without the use of the function.

Parameters

Dest	is a USM pointer to the destination memory.
DestPitch	is the pitch of the rows in
Dest.
Value	is the value to fill into the region in
Dest.	Value is cast as an unsigned char.
Width	is the width in number of elements of the 2D region to fill.
Height	is the height in number of rows of the 2D region to fill.

Returns

an event representing the fill operation.

Definition at line 931 of file queue.hpp.

References _CODELOCFW, and sycl::_V1::handler::ext_oneapi_memset2d().

ext_oneapi_memset2d() [2/3]

template<typename T = unsigned char, typename = std::enable_if_t<std::is_same_v<T, unsigned char>>>

event sycl::_V1::queue::ext_oneapi_memset2d ( void *  Dest, size_t  DestPitch, int  Value, size_t  Width, size_t  Height, const std::vector< event > &DepEvents _CODELOCPARAM &  CodeLoc  )

inline

Fills the memory pointed by a USM pointer with the value specified.

No operations is done if

Parameters

Width	or
Height	is zero. An exception is thrown if either
Dest	or
Src	is nullptr or if
Width	is strictly greater than
DestPitch.	The behavior is undefined if any of the pointer parameters is invalid.

NOTE: Function is dependent to prevent the fallback kernels from materializing without the use of the function.

Parameters

Dest	is a USM pointer to the destination memory.
DestPitch	is the pitch of the rows in
Dest.
Value	is the value to fill into the region in
Dest.	Value is cast as an unsigned char.
Width	is the width in number of elements of the 2D region to fill.
Height	is the height in number of rows of the 2D region to fill.
DepEvents	is a vector of events that specifies the kernel dependencies.

Returns

an event representing the fill operation.

Definition at line 987 of file queue.hpp.

References _CODELOCFW, sycl::_V1::handler::depends_on(), and sycl::_V1::handler::ext_oneapi_memset2d().

ext_oneapi_memset2d() [3/3]

template<typename T = unsigned char, typename = std::enable_if_t<std::is_same_v<T, unsigned char>>>

event sycl::_V1::queue::ext_oneapi_memset2d ( void *  Dest, size_t  DestPitch, int  Value, size_t  Width, size_t  Height, event DepEvent _CODELOCPARAM &  CodeLoc  )

inline

Fills the memory pointed by a USM pointer with the value specified.

No operations is done if

Parameters

Width	or
Height	is zero. An exception is thrown if either
Dest	or
Src	is nullptr or if
Width	is strictly greater than
DestPitch.	The behavior is undefined if any of the pointer parameters is invalid.

NOTE: Function is dependent to prevent the fallback kernels from materializing without the use of the function.

Parameters

Dest	is a USM pointer to the destination memory.
DestPitch	is the pitch of the rows in
Dest.
Value	is the value to fill into the region in
Dest.	Value is cast as an unsigned char.
Width	is the width in number of elements of the 2D region to fill.
Height	is the height in number of rows of the 2D region to fill.
DepEvent	is an event that specifies the kernel dependencies.

Returns

an event representing the fill operation.

Definition at line 958 of file queue.hpp.

References _CODELOCFW, sycl::_V1::handler::depends_on(), and sycl::_V1::handler::ext_oneapi_memset2d().

ext_oneapi_submit_barrier() [1/2]

event sycl::_V1::queue::ext_oneapi_submit_barrier ( _CODELOCONLYPARAM &  CodeLoc )

inline

Prevents any commands submitted afterward to this queue from executing until all commands previously submitted to this queue have entered the complete state.

Parameters

CodeLoc

is the code location of the submit call (default argument)

Returns

a SYCL event object, which corresponds to the queue the command group is being enqueued on.

Definition at line 377 of file queue.hpp.

References _CODELOCFW, and sycl::_V1::handler::ext_oneapi_barrier().

ext_oneapi_submit_barrier() [2/2]

event sycl::_V1::queue::ext_oneapi_submit_barrier ( const std::vector< event > &WaitList _CODELOCPARAM &  CodeLoc )

inline

Prevents any commands submitted afterward to this queue from executing until all events in WaitList have entered the complete state.

If WaitList is empty, then ext_oneapi_submit_barrier has no effect.

Parameters

WaitList	is a vector of valid SYCL events that need to complete before barrier command can be executed.
CodeLoc	is the code location of the submit call (default argument)

Returns

a SYCL event object, which corresponds to the queue the command group is being enqueued on.

Definition at line 404 of file queue.hpp.

References _CODELOCFW, and sycl::_V1::handler::ext_oneapi_barrier().

fill() [1/4]

template<typename T , int Dims, access_mode Mode, target Tgt, access::placeholder IsPlaceholder>

event sycl::_V1::queue::fill ( accessor< T, Dims, Mode, Tgt, IsPlaceholder >  Dest, const T &Src _CODELOCPARAM &  CodeLoc  )

inline

Fills the specified memory with the specified data.

Parameters

Dest	is the placeholder accessor to the memory to fill.
Src	is the data to fill the memory with. T should be trivially copyable.

Returns

an event representing fill operation.

Definition at line 1584 of file queue.hpp.

References _CODELOCFW, sycl::_V1::handler::fill(), and sycl::_V1::handler::require().

fill() [2/4]

template<typename T >

event sycl::_V1::queue::fill ( void *  Ptr, const T &  Pattern, size_t  Count  )

inline

Fills the specified memory with the specified pattern.

Parameters

Ptr	is the pointer to the memory to fill.
Pattern	is the pattern to fill into the memory. T should be trivially copyable.
Count	is the number of times to fill Pattern into Ptr.

Returns

an event representing fill operation.

Definition at line 482 of file queue.hpp.

References sycl::_V1::handler::fill().

fill() [3/4]

template<typename T >

event sycl::_V1::queue::fill ( void *  Ptr, const T &  Pattern, size_t  Count, const std::vector< event > &  DepEvents  )

inline

Fills the specified memory with the specified pattern.

Parameters

Ptr	is the pointer to the memory to fill.
Pattern	is the pattern to fill into the memory. T should be trivially copyable.
Count	is the number of times to fill Pattern into Ptr.
DepEvents	is a vector of events that specifies the kernel dependencies.

Returns

an event representing fill operation.

Definition at line 512 of file queue.hpp.

References sycl::_V1::handler::depends_on(), and sycl::_V1::handler::fill().

fill() [4/4]

template<typename T >

event sycl::_V1::queue::fill ( void *  Ptr, const T &  Pattern, size_t  Count, event  DepEvent  )

inline

Fills the specified memory with the specified pattern.

Parameters

Ptr	is the pointer to the memory to fill.
Pattern	is the pattern to fill into the memory. T should be trivially copyable.
Count	is the number of times to fill Pattern into Ptr.
DepEvent	is an event that specifies the kernel dependencies.

Returns

an event representing fill operation.

Definition at line 495 of file queue.hpp.

References sycl::_V1::handler::depends_on(), and sycl::_V1::handler::fill().

get_backend()

backend sycl::_V1::queue::get_backend ( ) const

noexcept

Returns the backend associated with this queue.

Returns

the backend associated with this queue.

Definition at line 206 of file queue.cpp.

References sycl::_V1::detail::getImplBackend().

get_context()

context sycl::_V1::queue::get_context

(

)

const

Returns

a valid instance of OpenCL queue, which is retained before being returned.

an associated SYCL context.

Definition at line 75 of file queue.cpp.

Referenced by sycl::_V1::aligned_alloc(), sycl::_V1::aligned_alloc_device(), sycl::_V1::aligned_alloc_host(), sycl::_V1::aligned_alloc_shared(), sycl::_V1::free(), sycl::_V1::malloc(), sycl::_V1::malloc_device(), sycl::_V1::malloc_host(), and sycl::_V1::malloc_shared().

get_device()

device sycl::_V1::queue::get_device

(

)

const

Returns

SYCL device this queue was constructed with.

Definition at line 77 of file queue.cpp.

Referenced by sycl::_V1::aligned_alloc(), sycl::_V1::aligned_alloc_device(), sycl::_V1::aligned_alloc_shared(), sycl::_V1::detail::reduction_impl_algo< T, BinaryOperation, Dims, Extent, RedOutVar >::getGroupsCounterAccDiscrete(), sycl::_V1::malloc(), sycl::_V1::malloc_device(), and sycl::_V1::malloc_shared().

get_info()

template<typename Param >

detail::is_queue_info_desc< Param >::return_type sycl::_V1::queue::get_info

Queries SYCL queue for information.

The return type depends on information being queried.

Definition at line 172 of file queue.cpp.

get_property()

template<typename PropertyT >

PropertyT sycl::_V1::queue::get_property

Returns

a copy of the property of type PropertyT that the queue was constructed with. If the queue was not constructed with the PropertyT property, an invalid_object_error SYCL exception.

Definition at line 187 of file queue.cpp.

has_property()

template<typename PropertyT >

bool sycl::_V1::queue::has_property

noexcept

Returns

true if the queue was constructed with property specified by PropertyT.

Definition at line 183 of file queue.cpp.

is_in_order()

bool sycl::_V1::queue::is_in_order

(

)

const

Returns whether the queue is in order or OoO.

Equivalent to has_property<property::queue::in_order>()

Definition at line 202 of file queue.cpp.

mem_advise() [1/4]

event sycl::_V1::queue::mem_advise	(	const void *	Ptr,
		size_t	Length,
		int	Advice
	)

Provides additional information to the underlying runtime about how different allocations are used.

Parameters

Ptr	is a USM pointer to the allocation.
Length	is a number of bytes in the allocation.
Advice	is a device-defined advice for the specified allocation.

Returns

an event representing advice operation.

Definition at line 117 of file queue.cpp.

mem_advise() [2/4]

event sycl::_V1::queue::mem_advise	(	const void *	Ptr,
		size_t	Length,
		int	Advice,
		const std::vector< event > &	DepEvents
	)

Provides additional information to the underlying runtime about how different allocations are used.

Parameters

Ptr	is a USM pointer to the allocation.
Length	is a number of bytes in the allocation.
Advice	is a device-defined advice for the specified allocation.
DepEvents	is a vector of events that specifies the kernel dependencies.

Returns

an event representing advice operation.

Definition at line 126 of file queue.cpp.

mem_advise() [3/4]

event sycl::_V1::queue::mem_advise	(	const void *	Ptr,
		size_t	Length,
		int	Advice,
		event	DepEvent
	)

Provides additional information to the underlying runtime about how different allocations are used.

Parameters

Ptr	is a USM pointer to the allocation.
Length	is a number of bytes in the allocation.
Advice	is a device-defined advice for the specified allocation.
DepEvent	is an event that specifies the kernel dependencies.

Returns

an event representing advice operation.

Definition at line 121 of file queue.cpp.

mem_advise() [4/4]

event sycl::_V1::queue::mem_advise	(	const void *	Ptr,
		size_t	Length,
		pi_mem_advice	Advice
	)

Provides additional information to the underlying runtime about how different allocations are used.

Parameters

Ptr	is a USM pointer to the allocation.
Length	is a number of bytes in the allocation.
Advice	is a device-defined advice for the specified allocation.

Returns

an event representing advice operation.

Definition at line 113 of file queue.cpp.

memcpy() [1/3]

event sycl::_V1::queue::memcpy	(	void *	Dest,
		const void *	Src,
		size_t	Count
	)

Copies data from one memory region to another, each is either a host pointer or a pointer within USM allocation accessible on the device associated with this queue.

No operations is done if

Parameters

Count	is zero. An exception is thrown if either
Dest	or
Src	is nullptr. The behavior is undefined if any of the pointer parameters is invalid.
Dest	is a USM pointer to the destination memory.
Src	is a USM pointer to the source memory.
Count	is a number of bytes to copy.

Returns

an event representing copy operation.

Definition at line 100 of file queue.cpp.

memcpy() [2/3]

event sycl::_V1::queue::memcpy	(	void *	Dest,
		const void *	Src,
		size_t	Count,
		const std::vector< event > &	DepEvents
	)

Copies data from one memory region to another, each is either a host pointer or a pointer within USM allocation accessible on the device associated with this queue.

No operations is done if

Parameters

Count	is zero. An exception is thrown if either
Dest	or
Src	is nullptr. The behavior is undefined if any of the pointer parameters is invalid.
Dest	is a USM pointer to the destination memory.
Src	is a USM pointer to the source memory.
Count	is a number of bytes to copy.
DepEvents	is a vector of events that specifies the kernel dependencies.

Returns

an event representing copy operation.

Definition at line 108 of file queue.cpp.

memcpy() [3/3]

event sycl::_V1::queue::memcpy	(	void *	Dest,
		const void *	Src,
		size_t	Count,
		event	DepEvent
	)

Copies data from one memory region to another, each is either a host pointer or a pointer within USM allocation accessible on the device associated with this queue.

No operations is done if

Parameters

Count	is zero. An exception is thrown if either
Dest	or
Src	is nullptr. The behavior is undefined if any of the pointer parameters is invalid.
Dest	is a USM pointer to the destination memory.
Src	is a USM pointer to the source memory.
Count	is a number of bytes to copy.
DepEvent	is an event that specifies the kernel dependencies.

Returns

an event representing copy operation.

Definition at line 104 of file queue.cpp.

memset() [1/3]

event sycl::_V1::queue::memset	(	void *	Ptr,
		int	Value,
		size_t	Count
	)

Fills the memory pointed by a USM pointer with the value specified.

No operations is done if

Parameters

Count	is zero. An exception is thrown if
Ptr	is nullptr. The behavior is undefined if
Ptr	is invalid.
Ptr	is a USM pointer to the memory to fill.
Value	is a value to be set. Value is cast as an unsigned char.
Count	is a number of bytes to fill.

Returns

an event representing fill operation.

Definition at line 87 of file queue.cpp.

Referenced by sycl::_V1::detail::reduction_impl_algo< T, BinaryOperation, Dims, Extent, RedOutVar >::getGroupsCounterAccDiscrete().

memset() [2/3]

event sycl::_V1::queue::memset	(	void *	Ptr,
		int	Value,
		size_t	Count,
		const std::vector< event > &	DepEvents
	)

Fills the memory pointed by a USM pointer with the value specified.

No operations is done if

Parameters

Count	is zero. An exception is thrown if
Ptr	is nullptr. The behavior is undefined if
Ptr	is invalid.
Ptr	is a USM pointer to the memory to fill.
Value	is a value to be set. Value is cast as an unsigned char.
Count	is a number of bytes to fill.
DepEvents	is a vector of events that specifies the kernel dependencies.

Returns

an event representing fill operation.

Definition at line 95 of file queue.cpp.

memset() [3/3]

event sycl::_V1::queue::memset	(	void *	Ptr,
		int	Value,
		size_t	Count,
		event	DepEvent
	)

Fills the memory pointed by a USM pointer with the value specified.

No operations is done if

Parameters

Count	is zero. An exception is thrown if
Ptr	is nullptr. The behavior is undefined if
Ptr	is invalid.
Ptr	is a USM pointer to the memory to fill.
Value	is a value to be set. Value is cast as an unsigned char.
Count	is a number of bytes to fill.
DepEvent	is an event that specifies the kernel dependencies.

Returns

an event representing fill operation.

Definition at line 91 of file queue.cpp.

operator!=()

bool sycl::_V1::queue::operator!= ( const queue &  RHS ) const

inline

Definition at line 270 of file queue.hpp.

operator=() [1/2]

queue& sycl::_V1::queue::operator= ( const queue &  RHS )

default

operator=() [2/2]

queue& sycl::_V1::queue::operator= ( queue &&  RHS )

default

operator==()

bool sycl::_V1::queue::operator== ( const queue &  RHS ) const

inline

Definition at line 268 of file queue.hpp.

parallel_for() [1/14]

template<typename KernelName = detail::auto_name, int Dims, typename... RestT>

event sycl::_V1::queue::parallel_for ( nd_range< Dims >  Range, const std::vector< event > &  DepEvents, RestT &&...  Rest  )

inline

parallel_for version with a kernel represented as a lambda + nd_range that specifies global, local sizes and offset.

Parameters

Range	specifies the global and local work spaces of the kernel
DepEvents	is a vector of events that specifies the kernel dependencies
Rest	acts as-if: "ReductionTypes&&... Reductions, const KernelType &KernelFunc".

Definition at line 1462 of file queue.hpp.

References sycl::_V1::handler::depends_on().

parallel_for() [2/14]

template<typename KernelName = detail::auto_name, int Dims, typename... RestT>

event sycl::_V1::queue::parallel_for ( nd_range< Dims >  Range, event  DepEvent, RestT &&...  Rest  )

inline

parallel_for version with a kernel represented as a lambda + nd_range that specifies global, local sizes and offset.

Parameters

Range	specifies the global and local work spaces of the kernel
DepEvent	is an event that specifies the kernel dependencies
Rest	acts as-if: "ReductionTypes&&... Reductions, const KernelType &KernelFunc".

Definition at line 1441 of file queue.hpp.

References sycl::_V1::handler::depends_on().

parallel_for() [3/14]

template<typename KernelName = detail::auto_name, int Dims, typename PropertiesT , typename... RestT>

std::enable_if_t< detail::AreAllButLastReductions<RestT...>::value && ext::oneapi::experimental::is_property_list<PropertiesT>::value, event> sycl::_V1::queue::parallel_for ( nd_range< Dims >  Range, PropertiesT  Properties, RestT &&...  Rest  )

inline

parallel_for version with a kernel represented as a lambda + nd_range that specifies global, local sizes and offset.

Parameters

Range	specifies the global and local work spaces of the kernel
Properties	is the kernel properties.
Rest	acts as-if: "ReductionTypes&&... Reductions, const KernelType &KernelFunc".

Definition at line 1407 of file queue.hpp.

parallel_for() [4/14]

template<typename KernelName = detail::auto_name, int Dims, typename... RestT>

std::enable_if_t<detail::AreAllButLastReductions<RestT...>::value, event> sycl::_V1::queue::parallel_for ( nd_range< Dims >  Range, RestT &&...  Rest  )

inline

parallel_for version with a kernel represented as a lambda + nd_range that specifies global, local sizes and offset.

Parameters

Range	specifies the global and local work spaces of the kernel
Rest	acts as-if: "ReductionTypes&&... Reductions, const KernelType &KernelFunc".

Definition at line 1426 of file queue.hpp.

parallel_for() [5/14]

template<typename KernelName = detail::auto_name, typename... RestT>

event sycl::_V1::queue::parallel_for ( range< 1 >  Range, const std::vector< event > &  DepEvents, RestT &&...  Rest  )

inline

parallel_for version with a kernel represented as a lambda + range that specifies global size only.

Parameters

Range	specifies the global work space of the kernel
DepEvents	is a vector of events that specifies the kernel dependencies
Rest	acts as-if: "ReductionTypes&&... Reductions, const KernelType &KernelFunc".

Definition at line 1269 of file queue.hpp.

parallel_for() [6/14]

template<typename KernelName = detail::auto_name, typename... RestT>

event sycl::_V1::queue::parallel_for ( range< 1 >  Range, event  DepEvent, RestT &&...  Rest  )

inline

parallel_for version with a kernel represented as a lambda + range that specifies global size only.

Parameters

Range	specifies the global work space of the kernel
DepEvent	is an event that specifies the kernel dependencies
Rest	acts as-if: "ReductionTypes&&... Reductions, const KernelType &KernelFunc".

Definition at line 1232 of file queue.hpp.

parallel_for() [7/14]

template<typename KernelName = detail::auto_name, typename... RestT>

event sycl::_V1::queue::parallel_for ( range< 1 >  Range, RestT &&...  Rest  )

inline

parallel_for version with a kernel represented as a lambda + range that specifies global size only.

Parameters

Range	specifies the global work space of the kernel
Rest	acts as-if: "ReductionTypes&&... Reductions, const KernelType &KernelFunc".

Definition at line 1198 of file queue.hpp.

parallel_for() [8/14]

template<typename KernelName = detail::auto_name, typename... RestT>

event sycl::_V1::queue::parallel_for ( range< 2 >  Range, const std::vector< event > &  DepEvents, RestT &&...  Rest  )

inline

parallel_for version with a kernel represented as a lambda + range that specifies global size only.

Parameters

Range	specifies the global work space of the kernel
DepEvents	is a vector of events that specifies the kernel dependencies
Rest	acts as-if: "ReductionTypes&&... Reductions, const KernelType &KernelFunc".

Definition at line 1283 of file queue.hpp.

parallel_for() [9/14]

template<typename KernelName = detail::auto_name, typename... RestT>

event sycl::_V1::queue::parallel_for ( range< 2 >  Range, event  DepEvent, RestT &&...  Rest  )

inline

parallel_for version with a kernel represented as a lambda + range that specifies global size only.

Parameters

Range	specifies the global work space of the kernel
DepEvent	is an event that specifies the kernel dependencies
Rest	acts as-if: "ReductionTypes&&... Reductions, const KernelType &KernelFunc".

Definition at line 1244 of file queue.hpp.

parallel_for() [10/14]

template<typename KernelName = detail::auto_name, typename... RestT>

event sycl::_V1::queue::parallel_for ( range< 2 >  Range, RestT &&...  Rest  )

inline

parallel_for version with a kernel represented as a lambda + range that specifies global size only.

Parameters

Range	specifies the global work space of the kernel
Rest	acts as-if: "ReductionTypes&&... Reductions, const KernelType &KernelFunc".

Definition at line 1209 of file queue.hpp.

parallel_for() [11/14]

template<typename KernelName = detail::auto_name, typename... RestT>

event sycl::_V1::queue::parallel_for ( range< 3 >  Range, const std::vector< event > &  DepEvents, RestT &&...  Rest  )

inline

parallel_for version with a kernel represented as a lambda + range that specifies global size only.

Parameters

Range	specifies the global work space of the kernel
DepEvents	is a vector of events that specifies the kernel dependencies
Rest	acts as-if: "ReductionTypes&&... Reductions, const KernelType &KernelFunc".

Definition at line 1297 of file queue.hpp.

parallel_for() [12/14]

template<typename KernelName = detail::auto_name, typename... RestT>

event sycl::_V1::queue::parallel_for ( range< 3 >  Range, event  DepEvent, RestT &&...  Rest  )

inline

parallel_for version with a kernel represented as a lambda + range that specifies global size only.

Parameters

Range	specifies the global work space of the kernel
DepEvent	is an event that specifies the kernel dependencies
Rest	acts as-if: "ReductionTypes&&... Reductions, const KernelType &KernelFunc".

Definition at line 1256 of file queue.hpp.

parallel_for() [13/14]

template<typename KernelName = detail::auto_name, typename... RestT>

event sycl::_V1::queue::parallel_for ( range< 3 >  Range, RestT &&...  Rest  )

inline

parallel_for version with a kernel represented as a lambda + range that specifies global size only.

Parameters

Range	specifies the global work space of the kernel
Rest	acts as-if: "ReductionTypes&&... Reductions, const KernelType &KernelFunc".

Definition at line 1220 of file queue.hpp.

parallel_for() [14/14]

template<typename KernelName = detail::auto_name, typename KernelType , int Dim>

event sycl::_V1::queue::parallel_for ( range< Dim >  Range, id< Dim >  WorkItemOffset, const std::vector< event > &  DepEvents, _KERNELFUNCPARAM(KernelFunc)    )

inline

parallel_for version with a kernel represented as a lambda + range and offset that specify global size and global offset correspondingly.

Parameters

Range	specifies the global work space of the kernel
WorkItemOffset	specifies the offset for each work item id
KernelFunc	is the Kernel functor or lambda
CodeLoc	contains the code location of user code

Definition at line 1314 of file queue.hpp.

parallel_for_impl() [1/3]

template<typename KernelName = detail::auto_name, typename KernelType , int Dims>

event sycl::_V1::queue::parallel_for_impl ( range< Dims >  Range, id< Dims >  WorkItemOffset, _KERNELFUNCPARAM(KernelFunc)    )

inline

parallel_for version with a kernel represented as a lambda + range and offset that specify global size and global offset correspondingly.

Parameters

Range	specifies the global work space of the kernel
WorkItemOffset	specifies the offset for each work item id
KernelFunc	is the Kernel functor or lambda
CodeLoc	contains the code location of user code

Definition at line 1332 of file queue.hpp.

parallel_for_impl() [2/3]

template<typename KernelName = detail::auto_name, typename KernelType , int Dims>

event sycl::_V1::queue::parallel_for_impl ( range< Dims >  Range, id< Dims >  WorkItemOffset, const std::vector< event > &  DepEvents, _KERNELFUNCPARAM(KernelFunc)    )

inline

parallel_for version with a kernel represented as a lambda + range and offset that specify global size and global offset correspondingly.

Parameters

Range	specifies the global work space of the kernel
WorkItemOffset	specifies the offset for each work item id
DepEvents	is a vector of events that specifies the kernel dependencies
KernelFunc	is the Kernel functor or lambda
CodeLoc	contains the code location of user code

Definition at line 1380 of file queue.hpp.

References sycl::_V1::handler::depends_on().

parallel_for_impl() [3/3]

template<typename KernelName = detail::auto_name, typename KernelType , int Dims>

event sycl::_V1::queue::parallel_for_impl ( range< Dims >  Range, id< Dims >  WorkItemOffset, event  DepEvent, _KERNELFUNCPARAM(KernelFunc)    )

inline

parallel_for version with a kernel represented as a lambda + range and offset that specify global size and global offset correspondingly.

Parameters

Range	specifies the global work space of the kernel
WorkItemOffset	specifies the offset for each work item id
DepEvent	is an event that specifies the kernel dependencies
KernelFunc	is the Kernel functor or lambda
CodeLoc	contains the code location of user code

Definition at line 1355 of file queue.hpp.

References sycl::_V1::handler::depends_on().

prefetch() [1/3]

event sycl::_V1::queue::prefetch ( const void *  Ptr, size_t  Count  )

inline

Provides hints to the runtime library that data should be made available on a device earlier than Unified Shared Memory would normally require it to be available.

Parameters

Ptr	is a USM pointer to the memory to be prefetched to the device.
Count	is a number of bytes to be prefetched.

Returns

an event representing prefetch operation.

Definition at line 709 of file queue.hpp.

References sycl::_V1::handler::prefetch().

prefetch() [2/3]

event sycl::_V1::queue::prefetch ( const void *  Ptr, size_t  Count, const std::vector< event > &  DepEvents  )

inline

Provides hints to the runtime library that data should be made available on a device earlier than Unified Shared Memory would normally require it to be available.

Parameters

Ptr	is a USM pointer to the memory to be prefetched to the device.
Count	is a number of bytes to be prefetched.
DepEvents	is a vector of events that specifies the kernel dependencies.

Returns

an event representing prefetch operation.

Definition at line 737 of file queue.hpp.

References sycl::_V1::handler::depends_on(), and sycl::_V1::handler::prefetch().

prefetch() [3/3]

event sycl::_V1::queue::prefetch ( const void *  Ptr, size_t  Count, event  DepEvent  )

inline

Provides hints to the runtime library that data should be made available on a device earlier than Unified Shared Memory would normally require it to be available.

Parameters

Ptr	is a USM pointer to the memory to be prefetched to the device.
Count	is a number of bytes to be prefetched.
DepEvent	is an event that specifies the kernel dependencies.

Returns

an event representing prefetch operation.

Definition at line 721 of file queue.hpp.

References sycl::_V1::handler::depends_on(), and sycl::_V1::handler::prefetch().

single_task() [1/6]

template<typename KernelName = detail::auto_name, typename KernelType >

event sycl::_V1::queue::single_task ( _KERNELFUNCPARAM(KernelFunc) _CODELOCPARAM &  CodeLoc )

inline

single_task version with a kernel represented as a lambda.

Parameters

KernelFunc	is the Kernel functor or lambda
CodeLoc	contains the code location of user code

Definition at line 1099 of file queue.hpp.

References _CODELOCFW.

single_task() [2/6]

template<typename KernelName = detail::auto_name, typename KernelType >

event sycl::_V1::queue::single_task ( const std::vector< event > &  DepEvents, _KERNELFUNCPARAM(KernelFunc) _CODELOCPARAM &  CodeLoc  )

inline

single_task version with a kernel represented as a lambda.

Parameters

DepEvents	is a vector of events that specifies the kernel dependencies
KernelFunc	is the Kernel functor or lambda
CodeLoc	contains the code location of user code

Definition at line 1184 of file queue.hpp.

References _CODELOCFW.

single_task() [3/6]

template<typename KernelName = detail::auto_name, typename KernelType , typename PropertiesT >

std::enable_if_t< ext::oneapi::experimental::is_property_list<PropertiesT>::value, event> sycl::_V1::queue::single_task ( const std::vector< event > &  DepEvents, PropertiesT  Properties, _KERNELFUNCPARAM(KernelFunc) _CODELOCPARAM &  CodeLoc  )

inline

single_task version with a kernel represented as a lambda.

Parameters

DepEvents	is a vector of events that specifies the kernel dependencies
Properties	is the kernel properties.
KernelFunc	is the Kernel functor or lambda
CodeLoc	contains the code location of user code

Definition at line 1158 of file queue.hpp.

References _CODELOCARG, and sycl::_V1::handler::depends_on().

single_task() [4/6]

template<typename KernelName = detail::auto_name, typename KernelType >

event sycl::_V1::queue::single_task ( event  DepEvent, _KERNELFUNCPARAM(KernelFunc) _CODELOCPARAM &  CodeLoc  )

inline

single_task version with a kernel represented as a lambda.

Parameters

DepEvent	is an event that specifies the kernel dependencies
KernelFunc	is the Kernel functor or lambda
CodeLoc	contains the code location of user code

Definition at line 1140 of file queue.hpp.

References _CODELOCFW.

single_task() [5/6]

template<typename KernelName = detail::auto_name, typename KernelType , typename PropertiesT >

std::enable_if_t< ext::oneapi::experimental::is_property_list<PropertiesT>::value, event> sycl::_V1::queue::single_task ( event  DepEvent, PropertiesT  Properties, _KERNELFUNCPARAM(KernelFunc) _CODELOCPARAM &  CodeLoc  )

inline

single_task version with a kernel represented as a lambda.

Parameters

DepEvent	is an event that specifies the kernel dependencies
Properties	is the kernel properties.
KernelFunc	is the Kernel functor or lambda
CodeLoc	contains the code location of user code

Definition at line 1115 of file queue.hpp.

References _CODELOCARG, and sycl::_V1::handler::depends_on().

single_task() [6/6]

template<typename KernelName = detail::auto_name, typename KernelType , typename PropertiesT >

std::enable_if_t< ext::oneapi::experimental::is_property_list<PropertiesT>::value, event> sycl::_V1::queue::single_task ( PropertiesT  Properties, _KERNELFUNCPARAM(KernelFunc) _CODELOCPARAM &  CodeLoc  )

inline

single_task version with a kernel represented as a lambda.

Parameters

Properties	is the kernel properties.
KernelFunc	is the Kernel functor or lambda
CodeLoc	contains the code location of user code

Definition at line 1076 of file queue.hpp.

References _CODELOCARG.

submit() [1/2]

template<typename T >

event sycl::_V1::queue::submit ( T CGF _CODELOCPARAM &  CodeLoc )

inline

Submits a command group function object to the queue, in order to be scheduled for execution on the device.

Parameters

CGF	is a function object containing command group.
CodeLoc	is the code location of the submit call (default argument)

Returns

a SYCL event object for the submitted command group.

Definition at line 307 of file queue.hpp.

References _CODELOCARG, and sycl::_V1::ext::oneapi::experimental::device_has.

submit() [2/2]

template<typename T >

event sycl::_V1::queue::submit ( T  CGF, queue &SecondaryQueue _CODELOCPARAM &  CodeLoc  )

inline

Submits a command group function object to the queue, in order to be scheduled for execution on the device.

On a kernel error, this command group function object is then scheduled for execution on a secondary queue.

Parameters

CGF	is a function object containing command group.
SecondaryQueue	is a fallback SYCL queue.
CodeLoc	is the code location of the submit call (default argument)

Returns

a SYCL event object, which corresponds to the queue the command group is being enqueued on.

Definition at line 343 of file queue.hpp.

References _CODELOCARG, and sycl::_V1::ext::oneapi::experimental::device_has.

submit_barrier() [1/2]

event sycl::_V1::queue::submit_barrier ( _CODELOCONLYPARAM &  CodeLoc )

inline

Prevents any commands submitted afterward to this queue from executing until all commands previously submitted to this queue have entered the complete state.

Parameters

CodeLoc

is the code location of the submit call (default argument)

Returns

a SYCL event object, which corresponds to the queue the command group is being enqueued on.

Definition at line 390 of file queue.hpp.

References _CODELOCARG.

submit_barrier() [2/2]

event sycl::_V1::queue::submit_barrier ( const std::vector< event > &WaitList _CODELOCPARAM &  CodeLoc )

inline

Prevents any commands submitted afterward to this queue from executing until all events in WaitList have entered the complete state.

If WaitList is empty, then submit_barrier has no effect.

Parameters

WaitList	is a vector of valid SYCL events that need to complete before barrier command can be executed.
CodeLoc	is the code location of the submit call (default argument)

Returns

a SYCL event object, which corresponds to the queue the command group is being enqueued on.

Definition at line 422 of file queue.hpp.

References _CODELOCARG.

throw_asynchronous()

void sycl::_V1::queue::throw_asynchronous

(

)

Checks if any asynchronous errors have been produced by the queue and if so reports them to the async_handler passed on the queue construction.

If no async_handler was provided then asynchronous exceptions will be lost.

Definition at line 85 of file queue.cpp.

update_host()

template<typename T , int Dims, access_mode Mode, target Tgt, access::placeholder IsPlaceholder>

event sycl::_V1::queue::update_host ( accessor< T, Dims, Mode, Tgt, IsPlaceholder > Acc _CODELOCPARAM &  CodeLoc )

inline

Provides guarantees that the memory object accessed via Acc is updated on the host after operation is complete.

Parameters

Acc	is a SYCL accessor that needs to be updated on host.

Returns

an event representing update_host operation.

Definition at line 1568 of file queue.hpp.

References _CODELOCFW, sycl::_V1::handler::require(), and sycl::_V1::handler::update_host().

wait()

void sycl::_V1::queue::wait ( _CODELOCONLYPARAM &  CodeLoc )

inline

Performs a blocking wait for the completion of all enqueued tasks in the queue.

Synchronous errors will be reported through SYCL exceptions.

Parameters

CodeLoc

is the code location of the submit call (default argument)

Definition at line 432 of file queue.hpp.

References _CODELOCARG.

wait_and_throw()

void sycl::_V1::queue::wait_and_throw ( _CODELOCONLYPARAM &  CodeLoc )

inline

Performs a blocking wait for the completion of all enqueued tasks in the queue.

Synchronous errors will be reported through SYCL exceptions. Asynchronous errors will be passed to the async_handler passed to the queue on construction. If no async_handler was provided then asynchronous exceptions will be lost.

Parameters

CodeLoc

is the code location of the submit call (default argument)

Definition at line 446 of file queue.hpp.

References _CODELOCARG.

wait_and_throw_proxy()

void sycl::_V1::queue::wait_and_throw_proxy

(

const detail::code_location &

CodeLoc

)

Proxy method for wait_and_throw to forward the code location information to the implementation.

Definition at line 166 of file queue.cpp.

wait_proxy()

void sycl::_V1::queue::wait_proxy

(

const detail::code_location &

CodeLoc

)

Proxy method for wait to forward the code location information to the implementation.

Definition at line 162 of file queue.cpp.

Friends And Related Function Documentation

detail::createSyclObjFromImpl

template<class T >

T detail::createSyclObjFromImpl ( decltype(T::impl)  ImplObj )

friend

get_native

template<backend BackendName, class SyclObjectT >

auto get_native ( const SyclObjectT &  Obj ) -> backend_return_t< BackendName, SyclObjectT >

friend

Definition at line 123 of file backend.hpp.

Member Data Documentation

AsyncHandler

const device_selector const async_handler& sycl::_V1::queue::AsyncHandler

Definition at line 226 of file queue.hpp.

DeviceSelector

const device_selector & sycl::_V1::queue::DeviceSelector

Definition at line 212 of file queue.hpp.

PropList [1/3]

const property_list& sycl::_V1::queue::PropList

Initial value:

= {})
      : queue(DeviceSelector.select_device(), detail::defaultAsyncHandler,
              PropList) {}
 
  
  __SYCL2020_DEPRECATED("SYCL 1.2.1 device selectors are deprecated. Please "
                        "use SYCL 2020 device selectors instead.")
  queue(const device_selector &DeviceSelector,
        const async_handler &AsyncHandler, const property_list &PropList = {})
      : queue(DeviceSelector.select_device(), AsyncHandler, PropList) {}
 
  
  explicit queue(const device &SyclDevice, const property_list &PropList = {})
      : queue(SyclDevice, detail::defaultAsyncHandler, PropList) {}
 
  
  explicit queue(const device &SyclDevice, const async_handler &AsyncHandler,
                 const property_list &PropList = {})

Definition at line 172 of file queue.hpp.

PropList [2/3]

const device_selector const property_list& sycl::_V1::queue::PropList = {})

Definition at line 213 of file queue.hpp.

PropList [3/3]

const device_selector const async_handler const property_list& sycl::_V1::queue::PropList = {})

Definition at line 226 of file queue.hpp.

---

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

• include/sycl/queue.hpp
• source/queue.cpp