ASL  0.1.7
Advanced Simulation Library
Public Member Functions | List of all members
cl::Image3D Class Reference

Class interface for 3D Image Memory objects. More...

#include <cl.hpp>

Inheritance diagram for cl::Image3D:
Inheritance graph
[legend]
Collaboration diagram for cl::Image3D:
Collaboration graph
[legend]

Public Member Functions

 Image3D (const Context &context, cl_mem_flags flags, ImageFormat format, ::size_t width, ::size_t height, ::size_t depth, ::size_t row_pitch=0, ::size_t slice_pitch=0, void *host_ptr=NULL, cl_int *err=NULL)
 Constructs a 3D Image in a specified context. More...
 
 Image3D ()
 Default constructor - initializes to NULL. More...
 
__CL_EXPLICIT_CONSTRUCTORS Image3D (const cl_mem &image3D)
 Constructor from cl_mem - takes ownership. More...
 
Image3Doperator= (const cl_mem &rhs)
 Assignment from cl_mem - performs shallow copy. More...
 
 Image3D (const Image3D &img)
 Copy constructor to forward copy to the superclass correctly. Required for MSVC. More...
 
Image3Doperator= (const Image3D &img)
 Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...
 
- Public Member Functions inherited from cl::Image
template<typename T >
cl_int getImageInfo (cl_image_info name, T *param) const
 Wrapper for clGetImageInfo(). More...
 
template<cl_int name>
detail::param_traits< detail::cl_image_info, name >::param_type getImageInfo (cl_int *err=NULL) const
 Wrapper for clGetImageInfo() that returns by value. More...
 
- Public Member Functions inherited from cl::Memory
 Memory ()
 Default constructor - initializes to NULL. More...
 
__CL_EXPLICIT_CONSTRUCTORS Memory (const cl_mem &memory)
 Constructor from cl_mem - takes ownership. More...
 
Memoryoperator= (const cl_mem &rhs)
 Assignment operator from cl_mem - takes ownership. More...
 
 Memory (const Memory &mem)
 Copy constructor to forward copy to the superclass correctly. Required for MSVC. More...
 
Memoryoperator= (const Memory &mem)
 Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...
 
template<typename T >
cl_int getInfo (cl_mem_info name, T *param) const
 Wrapper for clGetMemObjectInfo(). More...
 
template<cl_int name>
detail::param_traits< detail::cl_mem_info, name >::param_type getInfo (cl_int *err=NULL) const
 Wrapper for clGetMemObjectInfo() that returns by value. More...
 
- Public Member Functions inherited from cl::detail::Wrapper< cl_mem >
 Wrapper ()
 
 Wrapper (const cl_type &obj)
 
 Wrapper (const Wrapper< cl_type > &rhs)
 
 ~Wrapper ()
 
Wrapper< cl_type > & operator= (const Wrapper< cl_type > &rhs)
 
Wrapper< cl_type > & operator= (const cl_type &rhs)
 
cl_type operator() () const
 
cl_typeoperator() ()
 

Additional Inherited Members

- Public Types inherited from cl::detail::Wrapper< cl_mem >
typedef cl_mem cl_type
 
- Protected Member Functions inherited from cl::Image
 Image ()
 Default constructor - initializes to NULL. More...
 
__CL_EXPLICIT_CONSTRUCTORS Image (const cl_mem &image)
 Constructor from cl_mem - takes ownership. More...
 
Imageoperator= (const cl_mem &rhs)
 Assignment from cl_mem - performs shallow copy. More...
 
 Image (const Image &img)
 Copy constructor to forward copy to the superclass correctly. Required for MSVC. More...
 
Imageoperator= (const Image &img)
 Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...
 
- Protected Member Functions inherited from cl::detail::Wrapper< cl_mem >
cl_int retain () const
 
cl_int release () const
 
- Protected Attributes inherited from cl::detail::Wrapper< cl_mem >
cl_type object_
 

Detailed Description

Class interface for 3D Image Memory objects.

See Memory for details about copy semantics, etc.

See also
Memory

Definition at line 4071 of file cl.hpp.

Constructor & Destructor Documentation

◆ Image3D() [1/4]

cl::Image3D::Image3D ( const Context context,
cl_mem_flags  flags,
ImageFormat  format,
::size_t  width,
::size_t  height,
::size_t  depth,
::size_t  row_pitch = 0,
::size_t  slice_pitch = 0,
void *  host_ptr = NULL,
cl_int *  err = NULL 
)
inline

Constructs a 3D Image in a specified context.

Wraps clCreateImage().

Definition at line 4078 of file cl.hpp.

◆ Image3D() [2/4]

cl::Image3D::Image3D ( )
inline

Default constructor - initializes to NULL.

Definition at line 4149 of file cl.hpp.

◆ Image3D() [3/4]

__CL_EXPLICIT_CONSTRUCTORS cl::Image3D::Image3D ( const cl_mem &  image3D)
inline

Constructor from cl_mem - takes ownership.

See Memory for further details.

Definition at line 4155 of file cl.hpp.

◆ Image3D() [4/4]

cl::Image3D::Image3D ( const Image3D img)
inline

Copy constructor to forward copy to the superclass correctly. Required for MSVC.

Definition at line 4170 of file cl.hpp.

Member Function Documentation

◆ operator=() [1/2]

Image3D& cl::Image3D::operator= ( const cl_mem &  rhs)
inline

Assignment from cl_mem - performs shallow copy.

See Memory for further details.

Definition at line 4161 of file cl.hpp.

◆ operator=() [2/2]

Image3D& cl::Image3D::operator= ( const Image3D img)
inline

Copy assignment to forward copy to the superclass correctly. Required for MSVC.

Definition at line 4175 of file cl.hpp.


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