cl::Image3DGL Class Reference

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

`#include <cl.hpp>`

Inheritance diagram for cl::Image3DGL:
[legend]
Collaboration diagram for cl::Image3DGL:
[legend]

## Public Member Functions

| Image3DGL (const Context &context, cl_mem_flags flags, cl_GLenum target, cl_GLint miplevel, cl_GLuint texobj, cl_int *err=NULL)
| Constructs an Image3DGL in a specified context, from a given GL Texture. More...
| Image3DGL ()
| Default constructor - initializes to NULL. More...
__CL_EXPLICIT_CONSTRUCTORS | Image3DGL (const cl_mem &image)
| Constructor from cl_mem - takes ownership. More...
Image3DGL & | operator= (const cl_mem &rhs)
| Assignment from cl_mem - performs shallow copy. More...
| Image3DGL (const Image3DGL &img)
| Copy constructor to forward copy to the superclass correctly. Required for MSVC. More...
Image3DGL & | operator= (const Image3DGL &img)
| Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...
| Image3DGL (const Context &context, cl_mem_flags flags, cl_GLenum target, cl_GLint miplevel, cl_GLuint texobj, cl_int *err=NULL)
| Constructs an Image3DGL in a specified context, from a given GL Texture. More...
| Image3DGL ()
| Default constructor - initializes to NULL. More...
__CL_EXPLICIT_CONSTRUCTORS | Image3DGL (const cl_mem &image)
| Constructor from cl_mem - takes ownership. More...
Image3DGL & | operator= (const cl_mem &rhs)
| Assignment from cl_mem - performs shallow copy. More...
| Image3DGL (const Image3DGL &img)
| Copy constructor to forward copy to the superclass correctly. Required for MSVC. More...
Image3DGL & | operator= (const Image3DGL &img)
| Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...
Public Member Functions inherited from 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)
| 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...
Image3D & | operator= (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...
Image3D & | operator= (const Image3D &img)
| Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...
| 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...
Image3D & | operator= (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...
Image3D & | operator= (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...
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...
Memory & | operator= (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...
Memory & | operator= (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...
| Memory ()
| Default constructor - initializes to NULL. More...
__CL_EXPLICIT_CONSTRUCTORS | Memory (const cl_mem &memory)
| Constructor from cl_mem - takes ownership. More...
Memory & | operator= (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...
Memory & | operator= (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 (const cl_type &obj)
| Wrapper (const Wrapper< cl_type > &rhs)
| ~Wrapper ()
| ~Wrapper ()
Wrapper< cl_type > & | operator= (const Wrapper< cl_type > &rhs)
Wrapper< cl_type > & | operator= (const cl_type &rhs)
Wrapper< cl_type > & | operator= (const Wrapper< cl_type > &rhs)
Wrapper< cl_type > & | operator= (const cl_type &rhs)
cl_type | operator() () const
cl_type & | operator() ()
cl_type | operator() () const
cl_type & | operator() ()

## Additional Inherited Members

Public Types inherited from cl::detail::Wrapper< cl_mem >
typedef cl_mem | cl_type
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...
Image & | operator= (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...
Image & | operator= (const Image &img)
| Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...
| Image ()
| Default constructor - initializes to NULL. More...
__CL_EXPLICIT_CONSTRUCTORS | Image (const cl_mem &image)
| Constructor from cl_mem - takes ownership. More...
Image & | operator= (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...
Image & | operator= (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 | retain () const
cl_int | release () const
cl_int | release () const
Protected Attributes inherited from cl::detail::Wrapper< cl_mem >
cl_type | object_

## Detailed Description

Class interface for GL 3D Image Memory objects.

This is provided to facilitate interoperability with OpenGL.

See Memory for details about copy semantics, etc.

See also
  Memory

Definition at line 4207 of file cl.hpp.

## Constructor & Destructor Documentation

## Image3DGL() [1/8]

cl::Image3DGL::Image3DGL | ( | const Context & | context,
|  | cl_mem_flags | flags,
|  | cl_GLenum | target,
|  | cl_GLint | miplevel,
|  | cl_GLuint | texobj,
|  | cl_int * | err = `NULL`
| ) |  |

inline

Constructs an Image3DGL in a specified context, from a given GL Texture.

Wraps clCreateFromGLTexture3D().

Definition at line 4215 of file cl.hpp.

## Image3DGL() [2/8]

cl::Image3DGL::Image3DGL | ( |  | ) |

inline

Default constructor - initializes to NULL.

Definition at line 4239 of file cl.hpp.

## Image3DGL() [3/8]

__CL_EXPLICIT_CONSTRUCTORS cl::Image3DGL::Image3DGL | ( | const cl_mem & | image | ) |

inline

Constructor from cl_mem - takes ownership.

See Memory for further details.

Definition at line 4245 of file cl.hpp.

## Image3DGL() [4/8]

cl::Image3DGL::Image3DGL | ( | const Image3DGL & | img | ) |

inline

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

Definition at line 4260 of file cl.hpp.

## Image3DGL() [5/8]

cl::Image3DGL::Image3DGL | ( | const Context & | context,
|  | cl_mem_flags | flags,
|  | cl_GLenum | target,
|  | cl_GLint | miplevel,
|  | cl_GLuint | texobj,
|  | cl_int * | err = `NULL`
| ) |  |

inline

Constructs an Image3DGL in a specified context, from a given GL Texture.

Wraps clCreateFromGLTexture3D().

Definition at line 4215 of file cl.hpp.

## Image3DGL() [6/8]

cl::Image3DGL::Image3DGL | ( |  | ) |

inline

Default constructor - initializes to NULL.

Definition at line 4239 of file cl.hpp.

## Image3DGL() [7/8]

__CL_EXPLICIT_CONSTRUCTORS cl::Image3DGL::Image3DGL | ( | const cl_mem & | image | ) |

inline

Constructor from cl_mem - takes ownership.

See Memory for further details.

Definition at line 4245 of file cl.hpp.

## Image3DGL() [8/8]

cl::Image3DGL::Image3DGL | ( | const Image3DGL & | img | ) |

inline

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

Definition at line 4260 of file cl.hpp.

## Member Function Documentation

## operator=() [1/4]

Image3DGL& cl::Image3DGL::operator= | ( | const cl_mem & | rhs | ) |

inline

Assignment from cl_mem - performs shallow copy.

See Memory for further details.

Definition at line 4251 of file cl.hpp.

## operator=() [2/4]

Image3DGL& cl::Image3DGL::operator= | ( | const cl_mem & | rhs | ) |

inline

Assignment from cl_mem - performs shallow copy.

See Memory for further details.

Definition at line 4251 of file cl.hpp.

## operator=() [3/4]

Image3DGL& cl::Image3DGL::operator= | ( | const Image3DGL & | img | ) |

inline

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

Definition at line 4265 of file cl.hpp.

## operator=() [4/4]

Image3DGL& cl::Image3DGL::operator= | ( | const Image3DGL & | img | ) |

inline

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

Definition at line 4265 of file cl.hpp.

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

- /build/asl-1Fw6fH/asl-0.1.7/debian/tmp/usr/include/ASL/acl/cl.hpp