buffer is the public interface for the buffer object implementation. More...

#include <buffer.h>

Inheritance diagram for cl::sycl::buffer< T, dims, AllocatorT >:

Public Types
using	value_type = T
	Helper for the user, alias for type T. More...

using	reference = T &
	Helper for the user, alias for reference to type T. More...

using	const_reference = const T &
	Helper for the user, alias for const reference to type T. More...

using	allocator_type = AllocatorT
	Helper for the user, alias for the type of the allocator. More...

Public Member Functions
	buffer (const range< dims > &r, const property_list &propList={})
	Constructs a buffer without a host pointer. More...

	buffer (const range< dims > &r, AllocatorT allocator, const property_list &propList={})
	Constructs a buffer without a host pointer. More...

	buffer (T *hostPointer, const range< dims > &r, const property_list &propList={})
	Constructs a buffer with a host pointer. More...

	buffer (T *hostPointer, const range< dims > &r, AllocatorT allocator, const property_list &propList={})
	Constructs a buffer with a host pointer. More...

	buffer (const T *hostPointer, const range< dims > &r, const property_list &propList={})
	Constructs a buffer with host pointer. More...

	buffer (const T *hostPointer, const range< dims > &r, AllocatorT allocator, const property_list &propList={})
	Constructs a buffer with host pointer. More...

	buffer (const shared_ptr_class< T > &hostPointer, const range< dims > &r, const property_list &propList={})
	Constructs a buffer with a host pointer. More...

	buffer (const shared_ptr_class< T > &hostPointer, const range< dims > &r, AllocatorT allocator, const property_list &propList={})
	Constructs a buffer with a host pointer. More...

	buffer (buffer< T, dims > &b, const id< dims > &base_index, const range< dims > &sub_range)
	Construct a buffer as a subset from an existing buffer. More...

	COMPUTECPP_DEPRECATED_BY_SYCL_VER (201703, "Use the OpenCL interop constructor which takes a SYCL context instead.") buffer(cl_mem mem_object
	Construct a buffer from an OpenCL object. More...

template<access::mode accessMode>
COMPUTECPP_SET_IGNORE_DEPRECATED_API accessor< T, dims, accessMode, access::target::host_buffer >	get_access ()
	Returns an accessor to the buffer, only used on the host side. More...

template<access::mode accessMode, access::target accessTarget = COMPUTECPP_ACCESS_TARGET_DEVICE>
accessor< T, dims, accessMode, accessTarget >	get_access (handler &cgh)
	this function returns an accessor to the buffer in the given command_group scope. More...

template<access::mode accessMode, access::target accessTarget = COMPUTECPP_ACCESS_TARGET_DEVICE>
	COMPUTECPP_DEPRECATED_BY_SYCL_VER (201703, "Use overload where the range comes before the offset.") accessor< T
	Returns an accessor to the buffer in the given command_group scope. More...

accessTarget	get_access (handler &cgh, id< dims > offset, range< dims > range)

template<access::mode accessMode, access::target accessTarget = COMPUTECPP_ACCESS_TARGET_DEVICE>
accessor< T, dims, accessMode, accessTarget >	get_access (handler &cgh, range< dims > range, id< dims > offset={})
	Returns an accessor to the buffer in the given command group scope. More...

template<access::mode accessMode>
COMPUTECPP_SET_IGNORE_DEPRECATED_API	COMPUTECPP_DEPRECATED_BY_SYCL_VER (201703, "Use overload where the range comes before the offset.") accessor< T
	Returns an accessor to the buffer, only used on the host side. More...

COMPUTECPP_SET_IGNORE_DEPRECATED_API access::target::host_buffer	get_access (id< dims > offset, range< dims > range)

template<access::mode accessMode>
COMPUTECPP_SET_IGNORE_DEPRECATED_API accessor< T, dims, accessMode, access::target::host_buffer >	get_access (range< dims > range, id< dims > offset={})
	Returns an accessor to the buffer, only used on the host side. More...

cl::sycl::range< dims >	get_range () const
	Returns the range of the buffer. More...

template<typename propertyT >
bool	has_property () const noexcept
	Returns whether this SYCL buffer was constructed with the property specified by propertyT. More...

template<typename propertyT >
propertyT	get_property () const
	Returns a copy of the property of type propertyT that this SYCL buffer was constructed with. More...

AllocatorT	get_allocator () const
	Returns the allocator provided to the buffer. More...

template<typename ReinterpretT , int ReinterpretDim>
buffer< ReinterpretT, ReinterpretDim, AllocatorT >	reinterpret (range< ReinterpretDim > reinterpretRange) const
	Creates and returns a reinterpreted SYCL buffer. More...

template<typename ReinterpretT , int ReinterpretDim = dims>
buffer< ReinterpretT, ReinterpretDim, AllocatorT >	reinterpret () const
	Creates and returns a reinterpreted SYCL buffer. More...

Public Attributes
queue &	fromQueue

queue event	available_event

	dims

	accessMode

COMPUTECPP_SET_IGNORE_DEPRECATED_API	dims

COMPUTECPP_SET_IGNORE_DEPRECATED_API	accessMode

Static Public Attributes
static constexpr const auto	dimensions = dims
	Number of buffer dimensions (Codeplay extension) More...

Detailed Description

template<typename T, int dims, typename AllocatorT>
class cl::sycl::buffer< T, dims, AllocatorT >

buffer is the public interface for the buffer object implementation.

The template allows the creation of specific types and number of dimensions.

Definition at line 50 of file buffer.h.

Member Typedef Documentation

◆ allocator_type

template<typename T, int dims, typename AllocatorT>

using cl::sycl::buffer< T, dims, AllocatorT >::allocator_type = AllocatorT

Helper for the user, alias for the type of the allocator.

Definition at line 343 of file buffer.h.

◆ const_reference

template<typename T, int dims, typename AllocatorT>

using cl::sycl::buffer< T, dims, AllocatorT >::const_reference = const T&

Helper for the user, alias for const reference to type T.

Definition at line 340 of file buffer.h.

◆ reference

template<typename T, int dims, typename AllocatorT>

using cl::sycl::buffer< T, dims, AllocatorT >::reference = T&

Helper for the user, alias for reference to type T.

Definition at line 337 of file buffer.h.

◆ value_type

template<typename T, int dims, typename AllocatorT>

using cl::sycl::buffer< T, dims, AllocatorT >::value_type = T

Helper for the user, alias for type T.

Definition at line 334 of file buffer.h.

Constructor & Destructor Documentation

◆ buffer() [1/9]

template<typename T, int dims, typename AllocatorT>

cl::sycl::buffer< T, dims, AllocatorT >::buffer	(	const range< dims > &	r,
		const property_list &	propList = `{}`
	)

inline

Constructs a buffer without a host pointer.

The runtime will only use internally allocated memory and no copy in or out is defined. The given allocator is used to create internal storage in case the runtime requires it.

Parameters

r	Range of the buffer
propList	List of buffer properties

Definition at line 357 of file buffer.h.

◆ buffer() [2/9]

template<typename T, int dims, typename AllocatorT>

cl::sycl::buffer< T, dims, AllocatorT >::buffer	(	const range< dims > &	r,
		AllocatorT	allocator,
		const property_list &	propList = `{}`
	)

inline

Constructs a buffer without a host pointer.

The runtime will only use internally allocated memory and no copy in or out is defined. The given allocator is used to create internal storage in case the runtime requires it.

Parameters

r	Range of the buffer
allocator	The allocator used to create internal storage in case the runtime requires it.
propList	List of buffer properties

Definition at line 375 of file buffer.h.

◆ buffer() [3/9]

template<typename T, int dims, typename AllocatorT>

cl::sycl::buffer< T, dims, AllocatorT >::buffer	(	T *	hostPointer,
		const range< dims > &	r,
		const property_list &	propList = `{}`
	)

inline

Constructs a buffer with a host pointer.

In this case there is a host pointer, potentially initialized, but the user has not given the runtime any ownership, therefore the deleter has to be null. A Copy in is performed if the pointer is not null. If it is null, the data is initialized (new) inside the runtime. A copy out to hostPointer is performed by default.

Parameters

hostPointer	Pointer to host data
r	Range of the buffer
propList	List of buffer properties

Definition at line 396 of file buffer.h.

◆ buffer() [4/9]

template<typename T, int dims, typename AllocatorT>

cl::sycl::buffer< T, dims, AllocatorT >::buffer	(	T *	hostPointer,
		const range< dims > &	r,
		AllocatorT	allocator,
		const property_list &	propList = `{}`
	)

inline

Constructs a buffer with a host pointer.

In this case there is a host pointer, potentially initialized, but the user has not given the runtime any ownership, therefore the deleter has to be null. A Copy in is performed if the pointer is not null. If it is null, the data is initialized (new) inside the runtime. A copy out to hostPointer is performed by default.

Parameters

hostPointer	Pointer to host data
r	Range of the buffer
allocator	The allocator used to create internal storage in case the runtime requires it.
propList	List of buffer properties

Definition at line 419 of file buffer.h.

◆ buffer() [5/9]

template<typename T, int dims, typename AllocatorT>

cl::sycl::buffer< T, dims, AllocatorT >::buffer	(	const T *	hostPointer,
		const range< dims > &	r,
		const property_list &	propList = `{}`
	)

inline

Constructs a buffer with host pointer.

The user has given a const pointer, but the buffer is not const, so the runtime copies the data into a temporary space created using the given allocator. If the given allocator is a null allocator, this fails.

Parameters

hostPointer	Pointer to host data
r	Range of the buffer
propList	List of buffer properties

Definition at line 438 of file buffer.h.

◆ buffer() [6/9]

template<typename T, int dims, typename AllocatorT>

cl::sycl::buffer< T, dims, AllocatorT >::buffer	(	const T *	hostPointer,
		const range< dims > &	r,
		AllocatorT	allocator,
		const property_list &	propList = `{}`
	)

inline

Constructs a buffer with host pointer.

The user has given a const pointer, but the buffer is not const, so the runtime copies the data into a temporary space created using the given allocator. If the given allocator is a null allocator, this fails.

Parameters

hostPointer	Pointer to host data
r	Range of the buffer
allocator	The allocator used to create internal storage
propList	List of buffer properties

Definition at line 456 of file buffer.h.

◆ buffer() [7/9]

template<typename T, int dims, typename AllocatorT>

cl::sycl::buffer< T, dims, AllocatorT >::buffer	(	const shared_ptr_class< T > &	hostPointer,
		const range< dims > &	r,
		const property_list &	propList = `{}`
	)

inline

Constructs a buffer with a host pointer.

The user has given a shared pointer, therefore the data is explicitly shared between the user and the runtime. If the hostPointer is null, no data is copied in, and data is initialized inside the runtime. Data is copied out if the reference count of the runtime is less than the reference count of the shared pointer.

Parameters

hostPointer	Shared pointer to host data
r	Range of the buffer
propList	List of buffer properties

Definition at line 476 of file buffer.h.

◆ buffer() [8/9]

template<typename T, int dims, typename AllocatorT>

cl::sycl::buffer< T, dims, AllocatorT >::buffer	(	const shared_ptr_class< T > &	hostPointer,
		const range< dims > &	r,
		AllocatorT	allocator,
		const property_list &	propList = `{}`
	)

inline

Constructs a buffer with a host pointer.

The user has given a shared pointer, therefore the data is explicitly shared between the user and the runtime. If the hostPointer is null, no data is copied in, and data is initialized inside the runtime. Data is copied out if the reference count of the runtime is less than the reference count of the shared pointer.

Parameters

hostPointer	Shared pointer to host data
r	Range of the buffer
allocator	The allocator used to create internal storage
propList	List of buffer properties

Definition at line 495 of file buffer.h.

◆ buffer() [9/9]

template<typename T, int dims, typename AllocatorT>

cl::sycl::buffer< T, dims, AllocatorT >::buffer	(	buffer< T, dims > &	b,
		const id< dims > &	base_index,
		const range< dims > &	sub_range
	)

inline

Construct a buffer as a subset from an existing buffer.

Parameters

b	Existing buffer that will act as the parent
base_index	Offset of the original data to where the sub-buffer data starts
sub_range	Range of the original data that will be used in the sub-buffer

Definition at line 512 of file buffer.h.

Member Function Documentation

◆ COMPUTECPP_DEPRECATED_BY_SYCL_VER() [1/3]

template<typename T, int dims, typename AllocatorT>

cl::sycl::buffer< T, dims, AllocatorT >::COMPUTECPP_DEPRECATED_BY_SYCL_VER	(	201703	,
		"Use the OpenCL interop constructor which takes a SYCL context instead."
	)

Construct a buffer from an OpenCL object.

Parameters

mem_object	the user-provided OpenCL object that will be used by the buffer
fromQueue	the queue holding the context associated with the mem_object object
available_event	if provided signals that the cl_mem object has been created and is ready to be used

◆ COMPUTECPP_DEPRECATED_BY_SYCL_VER() [2/3]

template<typename T, int dims, typename AllocatorT>

template<access::mode accessMode, access::target accessTarget = COMPUTECPP_ACCESS_TARGET_DEVICE>

cl::sycl::buffer< T, dims, AllocatorT >::COMPUTECPP_DEPRECATED_BY_SYCL_VER	(	201703	,
		"Use overload where the range comes before the offset."
	)

Returns an accessor to the buffer in the given command_group scope.

Template Parameters

accessMode	All access::mode values are accepted
accessTarget	Defaults to global_buffer, can accept global_buffer or constant_buffer

Parameters

cgh	Reference to the command group scope where the accessor is requested.
offset	the offset that the accessor will be able to update from.
range	the range in which the accessor will be updating the data.

Returns: Device accessor

Deprecated:: Need to reverse the order of the access offset and range, see 4.7.2.1 Buffer Interface in SYCL 1.2.1

◆ COMPUTECPP_DEPRECATED_BY_SYCL_VER() [3/3]

template<typename T, int dims, typename AllocatorT>

template<access::mode accessMode>

COMPUTECPP_SET_IGNORE_DEPRECATED_API cl::sycl::buffer< T, dims, AllocatorT >::COMPUTECPP_DEPRECATED_BY_SYCL_VER	(	201703	,
		"Use overload where the range comes before the offset."
	)

Returns an accessor to the buffer, only used on the host side.

Template Parameters

accessMode All access::mode values are accepted

Parameters

offset	The offset that the accessor will be able to update from.
range	The range in which the accessor will be updating the data.

Returns: Host accessor

Deprecated:: Need to reverse the order of the access offset and range, see 4.7.2.1 Buffer Interface in SYCL 1.2.1

◆ get_access() [1/6]

template<typename T, int dims, typename AllocatorT>

template<access::mode accessMode>

COMPUTECPP_SET_IGNORE_DEPRECATED_API accessor<T, dims, accessMode, access::target::host_buffer> cl::sycl::buffer< T, dims, AllocatorT >::get_access ( )

inline

Returns an accessor to the buffer, only used on the host side.

Template Parameters

accessMode All access::mode values are accepted

Returns: Host accessor

Definition at line 693 of file buffer.h.

◆ get_access() [2/6]

template<typename T, int dims, typename AllocatorT>

template<access::mode accessMode, access::target accessTarget = COMPUTECPP_ACCESS_TARGET_DEVICE>

accessor<T, dims, accessMode, accessTarget> cl::sycl::buffer< T, dims, AllocatorT >::get_access ( handler & cgh )

inline

this function returns an accessor to the buffer in the given command_group scope.

Template Parameters

accessMode	all access::mode values are accepted
accessTarget	defaults to global_buffer, can accept global_buffer or constant_buffer

Parameters

cgh	Reference to the command group scope where the accessor is requested.

Returns: Device accessor

Definition at line 737 of file buffer.h.

◆ get_access() [3/6]

template<typename T, int dims, typename AllocatorT>

accessTarget cl::sycl::buffer< T, dims, AllocatorT >::get_access	(	handler &	cgh,
		id< dims >	offset,
		range< dims >	range
	)

inline

Definition at line 760 of file buffer.h.

◆ get_access() [4/6]

template<typename T, int dims, typename AllocatorT>

template<access::mode accessMode, access::target accessTarget = COMPUTECPP_ACCESS_TARGET_DEVICE>

accessor<T, dims, accessMode, accessTarget> cl::sycl::buffer< T, dims, AllocatorT >::get_access	(	handler &	cgh,
		range< dims >	range,
		id< dims >	offset = `{}`
	)

inline

Returns an accessor to the buffer in the given command group scope.

Template Parameters

accessMode	All access::mode values are accepted
accessTarget	Defaults to global_buffer, can accept global_buffer or constant_buffer

Parameters

cgh	Reference to the command group scope where the accessor is requested
range	The range in which the accessor will be updating the data
offset	The offset that the accessor will be able to update from

Returns: Device accessor

Definition at line 783 of file buffer.h.

◆ get_access() [5/6]

template<typename T, int dims, typename AllocatorT>

COMPUTECPP_SET_IGNORE_DEPRECATED_API access::target::host_buffer cl::sycl::buffer< T, dims, AllocatorT >::get_access	(	id< dims >	offset,
		range< dims >	range
	)

inline

Definition at line 804 of file buffer.h.

◆ get_access() [6/6]

template<typename T, int dims, typename AllocatorT>

template<access::mode accessMode>

COMPUTECPP_SET_IGNORE_DEPRECATED_API accessor<T, dims, accessMode, access::target::host_buffer> cl::sycl::buffer< T, dims, AllocatorT >::get_access	(	range< dims >	range,
		id< dims >	offset = `{}`
	)

inline

Returns an accessor to the buffer, only used on the host side.

Template Parameters

accessMode All access::mode values are accepted

Parameters

range	The range in which the accessor will be updating the data
offset	The offset that the accessor will be able to update from

Returns: Host accessor

Definition at line 821 of file buffer.h.

◆ get_allocator()

template<typename T, int dims, typename AllocatorT>

AllocatorT cl::sycl::buffer< T, dims, AllocatorT >::get_allocator ( ) const

inline

Returns the allocator provided to the buffer.

Returns: Allocator that was provided to the buffer

Definition at line 870 of file buffer.h.

◆ get_property()

template<typename T, int dims, typename AllocatorT>

template<typename propertyT >

propertyT cl::sycl::buffer< T, dims, AllocatorT >::get_property ( ) const

inline

Returns a copy of the property of type propertyT that this SYCL buffer was constructed with.

Throws an error if buffer was not constructed with the property.

Template Parameters

propertyT Property to retrieve

Returns: Copy of the property

Definition at line 862 of file buffer.h.

◆ get_range()

template<typename T, int dims, typename AllocatorT>

cl::sycl::range<dims> cl::sycl::buffer< T, dims, AllocatorT >::get_range ( ) const

inline

Returns the range of the buffer.

Definition at line 839 of file buffer.h.

◆ has_property()

template<typename T, int dims, typename AllocatorT>

template<typename propertyT >

bool cl::sycl::buffer< T, dims, AllocatorT >::has_property ( ) const

inlinenoexcept

Returns whether this SYCL buffer was constructed with the property specified by propertyT.

Template Parameters

propertyT Property to check for

Returns: True if buffer constructed with the property

Definition at line 850 of file buffer.h.

◆ reinterpret() [1/2]

template<typename T, int dims, typename AllocatorT>

template<typename ReinterpretT , int ReinterpretDim>

buffer<ReinterpretT, ReinterpretDim, AllocatorT> cl::sycl::buffer< T, dims, AllocatorT >::reinterpret ( range< ReinterpretDim > reinterpretRange ) const

inline

Creates and returns a reinterpreted SYCL buffer.

Template Parameters

ReinterpretT	New underlying type
ReinterpretDim	New buffer dimension

Parameters

reinterpretRange New buffer range

Returns: Reinterpreted buffer with the requested parameters

Exceptions

invalid_object_error if the size of the reinterpreted buffer and the size of the original buffer do not match

Definition at line 883 of file buffer.h.

◆ reinterpret() [2/2]

template<typename T, int dims, typename AllocatorT>

template<typename ReinterpretT , int ReinterpretDim = dims>

buffer<ReinterpretT, ReinterpretDim, AllocatorT> cl::sycl::buffer< T, dims, AllocatorT >::reinterpret ( ) const

inline

Creates and returns a reinterpreted SYCL buffer.

Template Parameters

ReinterpretT	New underlying type
ReinterpretDim	New buffer dimension

Returns: Reinterpreted buffer with the requested parameters

Exceptions

invalid_object_error if the size of the reinterpreted buffer and the size of the original buffer do not match

Definition at line 898 of file buffer.h.

Member Data Documentation

◆ accessMode [1/2]

template<typename T, int dims, typename AllocatorT>

cl::sycl::buffer< T, dims, AllocatorT >::accessMode

Definition at line 760 of file buffer.h.

◆ accessMode [2/2]

template<typename T, int dims, typename AllocatorT>

COMPUTECPP_SET_IGNORE_DEPRECATED_API cl::sycl::buffer< T, dims, AllocatorT >::accessMode

Definition at line 804 of file buffer.h.

◆ available_event

template<typename T, int dims, typename AllocatorT>

queue event cl::sycl::buffer< T, dims, AllocatorT >::available_event

Definition at line 529 of file buffer.h.

◆ dimensions

template<typename T, int dims, typename AllocatorT>

constexpr const auto cl::sycl::buffer< T, dims, AllocatorT >::dimensions = dims

static

Number of buffer dimensions (Codeplay extension)

Definition at line 346 of file buffer.h.

◆ dims [1/2]

template<typename T, int dims, typename AllocatorT>

cl::sycl::buffer< T, dims, AllocatorT >::dims

Definition at line 760 of file buffer.h.

◆ dims [2/2]

template<typename T, int dims, typename AllocatorT>

COMPUTECPP_SET_IGNORE_DEPRECATED_API cl::sycl::buffer< T, dims, AllocatorT >::dims

Definition at line 804 of file buffer.h.

◆ fromQueue

template<typename T, int dims, typename AllocatorT>

queue& cl::sycl::buffer< T, dims, AllocatorT >::fromQueue

Definition at line 528 of file buffer.h.

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

buffer.h

menu_bookReference

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

template<typename T, int dims, typename AllocatorT> class cl::sycl::buffer< T, dims, AllocatorT >

Member Typedef Documentation

◆ allocator_type

◆ const_reference

◆ reference

◆ value_type

Constructor & Destructor Documentation

◆ buffer() [1/9]

◆ buffer() [2/9]

◆ buffer() [3/9]

◆ buffer() [4/9]

◆ buffer() [5/9]

◆ buffer() [6/9]

◆ buffer() [7/9]

◆ buffer() [8/9]

◆ buffer() [9/9]

Member Function Documentation

◆ COMPUTECPP_DEPRECATED_BY_SYCL_VER() [1/3]

◆ COMPUTECPP_DEPRECATED_BY_SYCL_VER() [2/3]

◆ COMPUTECPP_DEPRECATED_BY_SYCL_VER() [3/3]

◆ get_access() [1/6]

◆ get_access() [2/6]

◆ get_access() [3/6]

◆ get_access() [4/6]

◆ get_access() [5/6]

◆ get_access() [6/6]

◆ get_allocator()

◆ get_property()

◆ get_range()

◆ has_property()

◆ reinterpret() [1/2]

◆ reinterpret() [2/2]

Member Data Documentation

◆ accessMode [1/2]

◆ accessMode [2/2]

◆ available_event

◆ dimensions

◆ dims [1/2]

◆ dims [2/2]

◆ fromQueue

Select a Product

oneAPI

Dark Mode

Light Mode

Codeplay.com

SYCL.tech

Codeplay Developer

Codeplay Open Source

template<typename T, int dims, typename AllocatorT>
class cl::sycl::buffer< T, dims, AllocatorT >