arm_compute/core/CL/ICLMultiImage.h

   1 /*
   2  * Copyright (c) 2016-2018 ARM Limited.
   3  *
   4  * SPDX-License-Identifier: MIT
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to
   8  * deal in the Software without restriction, including without limitation the
   9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  10  * sell copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in all
  14  * copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22  * SOFTWARE.
  23  */
  24 #ifndef __ARM_COMPUTE_ICLMULTIIMAGE_H__
  25 #define __ARM_COMPUTE_ICLMULTIIMAGE_H__
  26
  27 #include "arm_compute/core/IMultiImage.h"
  28
  29 namespace arm_compute
  30 {
  31 class ICLTensor;
  32 /** Interface for OpenCL images */
  33 using ICLImage = ICLTensor;
  34
  35 /** Interface for OpenCL multi-planar images */
  36 class ICLMultiImage : public IMultiImage
  37 {
  38 public:
  39     /** Return a pointer to the requested OpenCL plane of the image.
  40      *
  41      * @param[in] index The index of the wanted planed.
  42      *
  43      * @return A pointer pointed to the OpenCL plane
  44      */
  45     virtual ICLImage *cl_plane(unsigned int index) = 0;
  46     /** Return a constant pointer to the requested OpenCL plane of the image.
  47      *
  48      * @param[in] index The index of the wanted planed.
  49      *
  50      * @return A constant pointer pointed to the OpenCL plane
  51      */
  52     virtual const ICLImage *cl_plane(unsigned int index) const = 0;
  53
  54     // Inherited methods overridden:
  55     IImage *plane(unsigned int index) override;
  56     const IImage *plane(unsigned int index) const override;
  57 };
  58 }
  59 #endif /*__ARM_COMPUTE_ICLMULTIIMAGE_H__ */