1 /* 2 * Copyright (c) 2016-2019 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_MULTIIMAGEINFO_H 25 #define ARM_COMPUTE_MULTIIMAGEINFO_H 26 27 #include "arm_compute/core/Types.h" 28 29 namespace arm_compute 30 { 31 /** Store the multi-planar image's metadata */ 32 class MultiImageInfo 33 { 34 public: 35 /** Constructor */ 36 MultiImageInfo(); 37 /** Initialize the metadata structure with the given parameters 38 * 39 * @param[in] width Width of the image (in number of pixels) 40 * @param[in] height Height of the image (in number of pixels) 41 * @param[in] format Colour format of the image. 42 */ 43 void init(unsigned int width, unsigned int height, Format format); 44 /** Colour format of the image 45 * 46 * @return Colour format of the image 47 */ 48 Format format() const; 49 /** Width in pixels 50 * 51 * @return The width in pixels 52 */ 53 unsigned int width() const; 54 /** Height in pixels 55 * 56 * @return The height in pixels 57 */ 58 unsigned int height() const; 59 60 protected: 61 unsigned int _width; 62 unsigned int _height; 63 Format _format; 64 }; 65 } 66 #endif /*ARM_COMPUTE_MULTIIMAGEINFO_H */ 67