DPC++ Runtime
Runtime libraries for oneAPI DPC++
sycl::_V1::device_image< State > Class Template Reference

Objects of the class represents an instance of an image in a specific state. More...

#include <sycl/kernel_bundle.hpp>

Inheritance diagram for sycl::_V1::device_image< State >:
Collaboration diagram for sycl::_V1::device_image< State >:

Public Member Functions

 device_image ()=delete
 
bool has_kernel (const kernel_id &KernelID) const noexcept
 
bool has_kernel (const kernel_id &KernelID, const device &Dev) const noexcept
 
- Public Member Functions inherited from sycl::_V1::detail::device_image_plain
 device_image_plain (const detail::DeviceImageImplPtr &Impl)
 
bool operator== (const device_image_plain &RHS) const
 
bool operator!= (const device_image_plain &RHS) const
 
bool has_kernel (const kernel_id &KernelID) const noexcept
 
bool has_kernel (const kernel_id &KernelID, const device &Dev) const noexcept
 
pi_native_handle getNative () const
 
- Public Member Functions inherited from sycl::_V1::detail::OwnerLessBase< device_image< State > >
bool ext_oneapi_owner_before (const ext::oneapi::detail::weak_object_base< device_image< State > > &Other) const noexcept
 Compares the object against a weak object using an owner-based implementation-defined ordering. More...
 
bool ext_oneapi_owner_before (const device_image< State > &Other) const noexcept
 Compares the object against another object using an owner-based implementation-defined ordering. More...
 

Friends

template<class T >
detail::createSyclObjFromImpl (decltype(T::impl) ImplObj)
 

Additional Inherited Members

- Protected Member Functions inherited from sycl::_V1::detail::device_image_plain
template<class Obj >
decltype(Obj::impl) friend detail::getSyclObjImpl (const Obj &SyclObject)
 
- Protected Attributes inherited from sycl::_V1::detail::device_image_plain
detail::DeviceImageImplPtr impl
 

Detailed Description

template<sycl::bundle_state State>
class sycl::_V1::device_image< State >

Objects of the class represents an instance of an image in a specific state.

Definition at line 106 of file kernel_bundle.hpp.

Constructor & Destructor Documentation

◆ device_image()

template<sycl::bundle_state State>
sycl::_V1::device_image< State >::device_image ( )
delete

Member Function Documentation

◆ has_kernel() [1/2]

template<sycl::bundle_state State>
bool sycl::_V1::device_image< State >::has_kernel ( const kernel_id KernelID) const
inlinenoexcept
Returns
true if the device_image contains the kernel identified by the KernelID

Definition at line 113 of file kernel_bundle.hpp.

◆ has_kernel() [2/2]

template<sycl::bundle_state State>
bool sycl::_V1::device_image< State >::has_kernel ( const kernel_id KernelID,
const device Dev 
) const
inlinenoexcept
Returns
true if the device_image contains the kernel identified by the KernelID and is compatible with the passed Dev

Definition at line 119 of file kernel_bundle.hpp.

Friends And Related Function Documentation

◆ detail::createSyclObjFromImpl

template<sycl::bundle_state State>
template<class T >
T detail::createSyclObjFromImpl ( decltype(T::impl)  ImplObj)
friend

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