OpenCL C++ Bindings: cl::Image3DGL Class Reference

OpenCL C++ Bindings

Public Member Functions | List of all members
cl::Image3DGL Class Reference

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

Inheritance diagram for cl::Image3DGL:

## 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.
| Image3DGL (const cl_mem &image, bool retainObject=false)
| 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.
Image3DGL & | operator= (const Image3DGL &img)
| Copy assignment to forward copy to the superclass correctly. Required for MSVC.
| Image3DGL (Image3DGL &&img) CL_HPP_NOEXCEPT_
| Move constructor to forward move to the superclass correctly. Required for MSVC.
Image3DGL & | operator= (Image3DGL &&img)
| Move assignment to forward move to the superclass correctly. Required for MSVC.
Public Member Functions inherited from cl::Image3D
| Image3D (const Context &context, cl_mem_flags flags, ImageFormat format, size_type width, size_type height, size_type depth, size_type row_pitch=0, size_type 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.
| Image3D (const cl_mem &image3D, bool retainObject=false)
| 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.
Image3D & | operator= (const Image3D &img)
| Copy assignment to forward copy to the superclass correctly. Required for MSVC.
| Image3D (Image3D &&img) CL_HPP_NOEXCEPT_
| Move constructor to forward move to the superclass correctly. Required for MSVC.
Image3D & | operator= (Image3D &&img)
| Move assignment to forward move to the superclass correctly. Required for MSVC.
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_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.
Public Member Functions inherited from cl::Memory
| Memory ()
| Default constructor - initializes to NULL.
| Memory (const cl_mem &memory, bool retainObject)
| 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.
Memory & | operator= (const Memory &mem)
| Copy assignment to forward copy to the superclass correctly. Required for MSVC.
| Memory (Memory &&mem) CL_HPP_NOEXCEPT_
| Move constructor to forward move to the superclass correctly. Required for MSVC.
Memory & | operator= (Memory &&mem)
| Move assignment to forward move to the superclass correctly. Required for MSVC.
template<typename T >
cl_int | getInfo (cl_mem_info name, T *param) const
| Wrapper for clGetMemObjectInfo().
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.
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.
| Image (const cl_mem &image, bool retainObject=false)
| 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.
Image & | operator= (const Image &img)
| Copy assignment to forward copy to the superclass correctly. Required for MSVC.
| Image (Image &&img) CL_HPP_NOEXCEPT_
| Move constructor to forward move to the superclass correctly. Required for MSVC.
Image & | operator= (Image &&img)
| Move assignment to forward move to the superclass correctly. Required for MSVC.
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 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 5302 of file opencl.hpp.

## Constructor & Destructor Documentation

## ◆ Image3DGL() [1/2]

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 5310 of file opencl.hpp.

## ◆ Image3DGL() [2/2]

cl::Image3DGL::Image3DGL | ( | const cl_mem & | image,
|  | bool | retainObject = `false`
| ) |  |
| inlineexplicit

Constructor from cl_mem - takes ownership.

Parameters

  retainObject | will 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 5343 of file opencl.hpp.

## Member Function Documentation

## ◆ operator=()

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

Assignment from cl_mem - performs shallow copy.

See Memory for further details.

Definition at line 5350 of file opencl.hpp.

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

- opencl.hpp