Compute Library
 19.08
ICLMultiImage Class Referenceabstract

Interface for OpenCL multi-planar images. More...

#include <ICLMultiImage.h>

Collaboration diagram for ICLMultiImage:
[legend]

Public Member Functions

virtual ICLImagecl_plane (unsigned int index)=0
 Return a pointer to the requested OpenCL plane of the image. More...
 
virtual const ICLImagecl_plane (unsigned int index) const =0
 Return a constant pointer to the requested OpenCL plane of the image. More...
 
IImageplane (unsigned int index) override
 Return a pointer to the requested plane of the image. More...
 
const IImageplane (unsigned int index) const override
 Return a constant pointer to the requested plane of the image. More...
 
- Public Member Functions inherited from IMultiImage
virtual ~IMultiImage ()=default
 Destructor. More...
 
virtual const MultiImageInfoinfo () const =0
 Interface to be implemented by the child class to return the multi-planar image's metadata. More...
 

Detailed Description

Interface for OpenCL multi-planar images.

Definition at line 36 of file ICLMultiImage.h.

Member Function Documentation

◆ cl_plane() [1/2]

virtual ICLImage* cl_plane ( unsigned int  index)
pure virtual

Return a pointer to the requested OpenCL plane of the image.

Parameters
[in]indexThe index of the wanted planed.
Returns
A pointer pointed to the OpenCL plane

Implemented in CLMultiImage.

Referenced by CLChannelExtractKernel::configure(), CLColorConvertKernel::configure(), ICLMultiImage::plane(), CLChannelCombineKernel::run(), and CLColorConvertKernel::run().

◆ cl_plane() [2/2]

virtual const ICLImage* cl_plane ( unsigned int  index) const
pure virtual

Return a constant pointer to the requested OpenCL plane of the image.

Parameters
[in]indexThe index of the wanted planed.
Returns
A constant pointer pointed to the OpenCL plane

Implemented in CLMultiImage.

◆ plane() [1/2]

IImage * plane ( unsigned int  index)
overridevirtual

Return a pointer to the requested plane of the image.

Parameters
[in]indexThe index of the wanted planed.
Returns
A pointer pointed to the plane

Implements IMultiImage.

Definition at line 31 of file ICLMultiImage.cpp.

32 {
33  return cl_plane(index);
34 }
virtual ICLImage * cl_plane(unsigned int index)=0
Return a pointer to the requested OpenCL plane of the image.

References ICLMultiImage::cl_plane().

Referenced by CLColorConvertKernel::configure(), and CLChannelCombineKernel::configure().

◆ plane() [2/2]

const IImage * plane ( unsigned int  index) const
overridevirtual

Return a constant pointer to the requested plane of the image.

Parameters
[in]indexThe index of the wanted planed.
Returns
A constant pointer pointed to the plane

Implements IMultiImage.

Definition at line 36 of file ICLMultiImage.cpp.

37 {
38  return cl_plane(index);
39 }
virtual ICLImage * cl_plane(unsigned int index)=0
Return a pointer to the requested OpenCL plane of the image.

References ICLMultiImage::cl_plane().


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