FiberVISH 0.2
Fish - The Fiber Bundle API for the Vish Visualization Shell
Public Member Functions | List of all members
cl::CL_EXT_SUFFIX__VERSION_1_1_DEPRECATED Class Reference

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

#include <cl.hpp>

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

Public Member Functions

 Image2DGL (const Context &context, cl_mem_flags flags, GLenum target, GLint miplevel, GLuint texobj, cl_int *err=NULL)
 Constructs an Image2DGL in a specified context, from a given GL Texture.
 
 Image2DGL ()
 Default constructor - initializes to NULL.
 
 Image2DGL (const Image2DGL &image)
 Copy constructor - performs shallow copy.
 
__CL_EXPLICIT_CONSTRUCTORS Image2DGL (const cl_mem &image)
 Constructor from cl_mem - takes ownership.
 
Image2DGLoperator= (const Image2DGL &rhs)
 Assignment from Image2DGL - performs shallow copy.
 
Image2DGLoperator= (const cl_mem &rhs)
 Assignment from cl_mem - performs shallow copy.
 
- Public Member Functions inherited from cl::Image2D
 Image2D (const Context &context, cl_mem_flags flags, ImageFormat format, ::size_t width, ::size_t height, ::size_t row_pitch=0, void *host_ptr=NULL, cl_int *err=NULL)
 Constructs a 1D Image in a specified context.
 
 Image2D ()
 Default constructor - initializes to NULL.
 
 Image2D (const Image2D &image2D)
 Copy constructor - performs shallow copy.
 
__CL_EXPLICIT_CONSTRUCTORS Image2D (const cl_mem &image2D)
 Constructor from cl_mem - takes ownership.
 
Image2Doperator= (const Image2D &rhs)
 Assignment from Image2D - performs shallow copy.
 
Image2Doperator= (const cl_mem &rhs)
 Assignment from cl_mem - performs shallow copy.
 
- Public Member Functions inherited from cl::Image
template<typename T >
cl_int getImageInfo (cl_image_info name, T *param) const
 Wrapper for clGetImageInfo().
 
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.
 
- Public Member Functions inherited from cl::Memory
 ~Memory ()
 Destructor.
 
 Memory ()
 Default constructor - initializes to NULL.
 
 Memory (const Memory &memory)
 Copy constructor - performs shallow copy.
 
__CL_EXPLICIT_CONSTRUCTORS Memory (const cl_mem &memory)
 Constructor from cl_mem - takes ownership.
 
Memoryoperator= (const Memory &rhs)
 Assignment operator from Memory.
 
Memoryoperator= (const cl_mem &rhs)
 Assignment operator from cl_mem - takes ownership.
 
template<typename T >
cl_int getInfo (cl_mem_info name, T *param) const
 Wrapper for clGetMemObjectInfo().
 
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.
 
- Public Member Functions inherited from cl::detail::Wrapper< cl_mem >
 Wrapper (const cl_type &obj)
 
 Wrapper (const Wrapper< 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() ()
 

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.
 
 Image (const Image &image)
 Copy constructor - performs shallow copy.
 
__CL_EXPLICIT_CONSTRUCTORS Image (const cl_mem &image)
 Constructor from cl_mem - takes ownership.
 
Imageoperator= (const Image &rhs)
 Assignment from Image - performs shallow copy.
 
Imageoperator= (const cl_mem &rhs)
 Assignment from cl_mem - performs shallow copy.
 
- 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 GL 2D Image Memory objects.

This is provided to facilitate interoperability with OpenGL.

See Memory for details about copy semantics, etc.

See also
Memory
Note
Deprecated for OpenCL 1.2. Please use ImageGL instead.

Member Function Documentation

◆ Image2DGL() [1/3]

__CL_EXPLICIT_CONSTRUCTORS cl::CL_EXT_SUFFIX__VERSION_1_1_DEPRECATED::Image2DGL ( const cl_mem &  image)
inline

Constructor from cl_mem - takes ownership.

See Memory for further details.

◆ Image2DGL() [2/3]

cl::CL_EXT_SUFFIX__VERSION_1_1_DEPRECATED::Image2DGL ( const Context context,
cl_mem_flags  flags,
GLenum  target,
GLint  miplevel,
GLuint  texobj,
cl_int *  err = NULL 
)
inline

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

Wraps clCreateFromGLTexture2D().

◆ Image2DGL() [3/3]

cl::CL_EXT_SUFFIX__VERSION_1_1_DEPRECATED::Image2DGL ( const Image2DGL &  image)
inline

Copy constructor - performs shallow copy.

See Memory for further details.

◆ operator=() [1/2]

Image2DGL & cl::CL_EXT_SUFFIX__VERSION_1_1_DEPRECATED::operator= ( const cl_mem &  rhs)
inline

Assignment from cl_mem - performs shallow copy.

See Memory for further details.

◆ operator=() [2/2]

Image2DGL & cl::CL_EXT_SUFFIX__VERSION_1_1_DEPRECATED::operator= ( const Image2DGL rhs)
inline

Assignment from Image2DGL - performs shallow copy.

See Memory for further details.