OpenCL C++ Bindings
cl::ImageGL Class Reference

general image interface for GL interop. We abstract the 2D and 3D GL images into a single instance here that wraps all GL sourced images on the grounds that setup information was performed by OpenCL anyway. More...

#include <opencl.hpp>

Inheritance diagram for cl::ImageGL:
cl::Image cl::Memory cl::detail::Wrapper< cl_mem >

Public Member Functions

 ImageGL (const Context &context, cl_mem_flags flags, cl_GLenum target, cl_GLint miplevel, cl_GLuint texobj, cl_int *err=NULL)
 
 ImageGL (const cl_mem &image, bool retainObject=false)
 Constructor from cl_mem - takes ownership. More...
 
ImageGLoperator= (const cl_mem &rhs)
 
 ImageGL (const ImageGL &img)
 Copy constructor to forward copy to the superclass correctly. Required for MSVC. More...
 
ImageGLoperator= (const ImageGL &img)
 Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...
 
 ImageGL (ImageGL &&img) CL_HPP_NOEXCEPT_
 Move constructor to forward move to the superclass correctly. Required for MSVC. More...
 
ImageGLoperator= (ImageGL &&img)
 Move assignment to forward move 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_image_info 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...
 
 Memory (const cl_mem &memory, bool retainObject)
 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...
 
 Memory (Memory &&mem) CL_HPP_NOEXCEPT_
 Move constructor to forward move to the superclass correctly. Required for MSVC. More...
 
Memoryoperator= (Memory &&mem)
 Move assignment to forward move 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_mem_info 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...
 
cl_int setDestructorCallback (void(CL_CALLBACK *pfn_notify)(cl_mem, void *), void *user_data=NULL)
 Registers a callback function to be called when the memory object is no longer needed. More...
 
- Public Member Functions inherited from cl::detail::Wrapper< cl_mem >
 Wrapper (const cl_type &obj, bool retainObject)
 
 Wrapper (const Wrapper< cl_type > &rhs)
 
 Wrapper (Wrapper< cl_type > &&rhs) CL_HPP_NOEXCEPT_
 
Wrapper< cl_type > & operator= (const Wrapper< cl_type > &rhs)
 
Wrapper< cl_type > & operator= (Wrapper< cl_type > &&rhs)
 
Wrapper< cl_type > & operator= (const cl_type &rhs)
 
const cl_type & operator() () const
 
cl_type & operator() ()
 
cl_type get () const
 

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...
 
 Image (const cl_mem &image, bool retainObject=false)
 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...
 
 Image (Image &&img) CL_HPP_NOEXCEPT_
 Move constructor to forward move to the superclass correctly. Required for MSVC. More...
 
Imageoperator= (Image &&img)
 Move assignment to forward move 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

general image interface for GL interop. We abstract the 2D and 3D GL images into a single instance here that wraps all GL sourced images on the grounds that setup information was performed by OpenCL anyway.

Definition at line 5431 of file opencl.hpp.

Constructor & Destructor Documentation

◆ ImageGL() [1/5]

cl::ImageGL::ImageGL ( const Context context,
cl_mem_flags  flags,
cl_GLenum  target,
cl_GLint  miplevel,
cl_GLuint  texobj,
cl_int *  err = NULL 
)
inline

Definition at line 5434 of file opencl.hpp.

◆ ImageGL() [2/5]

cl::ImageGL::ImageGL ( )
inline

Definition at line 5457 of file opencl.hpp.

◆ ImageGL() [3/5]

cl::ImageGL::ImageGL ( const cl_mem &  image,
bool  retainObject = false 
)
inlineexplicit

Constructor from cl_mem - takes ownership.

Parameters
retainObjectwill cause the constructor to retain its cl object. Defaults to false to maintain compatibility with earlier versions. See Memory for further details.

Definition at line 5466 of file opencl.hpp.

◆ ImageGL() [4/5]

cl::ImageGL::ImageGL ( const ImageGL img)
inline

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

Definition at line 5478 of file opencl.hpp.

◆ ImageGL() [5/5]

cl::ImageGL::ImageGL ( ImageGL &&  img)
inline

Move constructor to forward move to the superclass correctly. Required for MSVC.

Definition at line 5492 of file opencl.hpp.

Member Function Documentation

◆ operator=() [1/3]

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

Definition at line 5469 of file opencl.hpp.

◆ operator=() [2/3]

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

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

Definition at line 5483 of file opencl.hpp.

◆ operator=() [3/3]

ImageGL & cl::ImageGL::operator= ( ImageGL &&  img)
inline

Move assignment to forward move to the superclass correctly. Required for MSVC.

Definition at line 5497 of file opencl.hpp.


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