OpenCL C++ Bindings
cl::NDRange Class Reference

Class interface for specifying NDRange values. More...

#include <opencl.hpp>

Public Member Functions

 NDRange ()
 Default constructor - resulting range has zero dimensions. More...
 
 NDRange (size_type size0)
 Constructs one-dimensional range. More...
 
 NDRange (size_type size0, size_type size1)
 Constructs two-dimensional range. More...
 
 NDRange (size_type size0, size_type size1, size_type size2)
 Constructs three-dimensional range. More...
 
 operator const size_type * () const
 Conversion operator to const size_type *. More...
 
size_type dimensions () const
 Queries the number of dimensions in the range. More...
 
size_type size () const
 Returns the size of the object in bytes based on the. More...
 
size_type * get ()
 
const size_type * get () const
 

Detailed Description

Class interface for specifying NDRange values.

Definition at line 5784 of file opencl.hpp.

Constructor & Destructor Documentation

◆ NDRange() [1/4]

cl::NDRange::NDRange ( )
inline

Default constructor - resulting range has zero dimensions.

Definition at line 5792 of file opencl.hpp.

◆ NDRange() [2/4]

cl::NDRange::NDRange ( size_type  size0)
inline

Constructs one-dimensional range.

Definition at line 5801 of file opencl.hpp.

◆ NDRange() [3/4]

cl::NDRange::NDRange ( size_type  size0,
size_type  size1 
)
inline

Constructs two-dimensional range.

Definition at line 5810 of file opencl.hpp.

◆ NDRange() [4/4]

cl::NDRange::NDRange ( size_type  size0,
size_type  size1,
size_type  size2 
)
inline

Constructs three-dimensional range.

Definition at line 5819 of file opencl.hpp.

Member Function Documentation

◆ dimensions()

size_type cl::NDRange::dimensions ( ) const
inline

Queries the number of dimensions in the range.

Definition at line 5836 of file opencl.hpp.

◆ get() [1/2]

size_type * cl::NDRange::get ( )
inline

Definition at line 5848 of file opencl.hpp.

◆ get() [2/2]

const size_type * cl::NDRange::get ( ) const
inline

Definition at line 5853 of file opencl.hpp.

◆ operator const size_type *()

cl::NDRange::operator const size_type * ( ) const
inline

Conversion operator to const size_type *.

Returns
a pointer to the size of the first dimension.

Definition at line 5831 of file opencl.hpp.

◆ size()

size_type cl::NDRange::size ( ) const
inline

Returns the size of the object in bytes based on the.

Definition at line 5843 of file opencl.hpp.


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