dali/public-api/rendering/texture.h

   1 #ifndef DALI_TEXTURE_H
   2 #define DALI_TEXTURE_H
   3
   4 /*
   5  * Copyright (c) 2022 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/public-api/images/native-image-interface.h>
  23 #include <dali/public-api/images/pixel-data.h>
  24 #include <dali/public-api/images/pixel.h>
  25 #include <dali/public-api/object/base-handle.h>
  26
  27 namespace Dali
  28 {
  29 /**
  30  * @addtogroup dali_core_rendering_effects
  31  * @{
  32  */
  33
  34 namespace Internal DALI_INTERNAL
  35 {
  36 class Texture;
  37 }
  38
  39 namespace TextureType
  40 {
  41 /**
  42  * @brief Enumeration for texture types.
  43  * @SINCE_1_1.43
  44  */
  45 enum Type
  46 {
  47   TEXTURE_2D,  ///< One 2D image                            @SINCE_1_1.43
  48   TEXTURE_CUBE ///< Six 2D images arranged in a cube-shape  @SINCE_1_1.43
  49 };
  50
  51 } // namespace TextureType
  52
  53 namespace CubeMapLayer
  54 {
  55 /**
  56    * @brief Faces of a cube map.
  57    * These constants should be used as the "layer" parameter when uploading a cube-map with Texture::Upload.
  58    * @SINCE_1_1.43
  59    */
  60 const uint32_t POSITIVE_X = 0u; ///< CubeMap image for +x @SINCE_1_1.43
  61 const uint32_t NEGATIVE_X = 1u; ///< CubeMap image for -x @SINCE_1_1.43
  62 const uint32_t POSITIVE_Y = 2u; ///< CubeMap image for +y @SINCE_1_1.43
  63 const uint32_t NEGATIVE_Y = 3u; ///< CubeMap image for -y @SINCE_1_1.43
  64 const uint32_t POSITIVE_Z = 4u; ///< CubeMap image for +z @SINCE_1_1.43
  65 const uint32_t NEGATIVE_Z = 5u; ///< CubeMap image for -z @SINCE_1_1.43
  66
  67 } // namespace CubeMapLayer
  68
  69 /**
  70  * @brief Texture represents a texture object used as input or output by shaders.
  71  * @SINCE_1_1.43
  72  */
  73 class DALI_CORE_API Texture : public BaseHandle
  74 {
  75 public:
  76   /**
  77    * @brief Creates a new Texture object.
  78    *
  79    * @SINCE_1_1.43
  80    * @param[in] type The type of the texture
  81    * @param[in] format The format of the pixel data
  82    * @param[in] width The width of the texture
  83    * @param[in] height The height of the texture
  84    * @return A handle to a newly allocated Texture
  85    */
  86   static Texture New(TextureType::Type type, Pixel::Format format, uint32_t width, uint32_t height);
  87
  88   /**
  89    * @brief Creates a new Texture object from a native image.
  90    *
  91    * @SINCE_1_1.43
  92    * @param[in] nativeImageInterface A native image
  93    * @return A handle to a newly allocated Texture
  94    * @note It is not possible to upload data to textures created from a native image using Upload methods
  95    * although there might be platform specific APIs to upload data to a native image.
  96    */
  97   static Texture New(NativeImageInterface& nativeImageInterface);
  98
  99   /**
 100    * @brief Default constructor, creates an empty handle.
 101    *
 102    * @SINCE_1_1.43
 103    */
 104   Texture();
 105
 106   /**
 107    * @brief Destructor.
 108    *
 109    * @SINCE_1_1.43
 110    */
 111   ~Texture();
 112
 113   /**
 114    * @brief Copy constructor, creates a new handle to the same object.
 115    *
 116    * @SINCE_1_1.43
 117    * @param[in] handle Handle to an object
 118    */
 119   Texture(const Texture& handle);
 120
 121   /**
 122    * @brief Downcasts to a texture.
 123    * If not, the returned handle is left uninitialized.
 124    *
 125    * @SINCE_1_1.43
 126    * @param[in] handle Handle to an object
 127    * @return Texture handle or an uninitialized handle
 128    */
 129   static Texture DownCast(BaseHandle handle);
 130
 131   /**
 132    * @brief Assignment operator, changes this handle to point at the same object.
 133    *
 134    * @SINCE_1_1.43
 135    * @param[in] handle Handle to an object
 136    * @return Reference to the assigned object
 137    */
 138   Texture& operator=(const Texture& handle);
 139
 140   /**
 141    * @brief Move constructor.
 142    *
 143    * @SINCE_1_9.22
 144    * @param[in] rhs A reference to the moved handle
 145    */
 146   Texture(Texture&& rhs);
 147
 148   /**
 149    * @brief Move assignment operator.
 150    *
 151    * @SINCE_1_9.22
 152    * @param[in] rhs A reference to the moved handle
 153    * @return A reference to this handle
 154    */
 155   Texture& operator=(Texture&& rhs);
 156
 157   /**
 158    * @brief Uploads data to the texture from a PixelData object.
 159    *
 160    * @SINCE_1_1.43
 161    * @param[in] pixelData The pixelData object
 162    * @return True if the PixelData object has compatible pixel format and fits within the texture, false otherwise
 163    */
 164   bool Upload(PixelData pixelData);
 165
 166   /**
 167    * @brief Uploads data to the texture from a PixelData object.
 168    * @note Upload does not upsample or downsample pixel data to fit the specified rectangular area in the texture.
 169    *
 170    * @SINCE_1_1.43
 171    * @param[in] pixelData The pixelData object
 172    * @param[in] layer Specifies the layer of a cube map or array texture (Unused for 2D textures). @see CubeMapLayer
 173    * @param[in] mipmap Specifies the level-of-detail number. Level 0 is the base image level. Level n is the nth mipmap reduction image
 174    * @param[in] xOffset Specifies an horizontal offset of the rectangular area in the texture that will be updated
 175    * @param[in] yOffset Specifies a vertical offset of the rectangular area in the texture that will be updated
 176    * @param[in] width Specifies the width of the rectangular area in the texture that will be updated
 177    * @param[in] height Specifies the height of the rectangular area in the texture that will be updated
 178    * @return True if the PixelData object has compatible pixel format and fits in the rectangle specified, false otherwise
 179    */
 180   bool Upload(PixelData pixelData,
 181               uint32_t  layer,
 182               uint32_t  mipmap,
 183               uint32_t  xOffset,
 184               uint32_t  yOffset,
 185               uint32_t  width,
 186               uint32_t  height);
 187
 188   /**
 189    * @brief Generates mipmaps for the texture.
 190    * This will auto generate all the mipmaps for the texture based on the data in the base level.
 191    *
 192    * @SINCE_1_1.43
 193    */
 194   void GenerateMipmaps();
 195
 196   /**
 197    * @brief Returns the width of the texture.
 198    *
 199    * @SINCE_1_1.43
 200    * @return The width, in pixels, of the texture
 201    */
 202   uint32_t GetWidth() const;
 203
 204   /**
 205    * @brief Returns the height of the texture.
 206    *
 207    * @SINCE_1_1.43
 208    * @return The height, in pixels, of the texture
 209    */
 210   uint32_t GetHeight() const;
 211
 212   /**
 213    * @brief Returns the pixel format of the texture.
 214    *
 215    * @SINCE_2_1.29
 216    * @return The pixel format of the texture
 217    */
 218   Pixel::Format GetPixelFormat() const;
 219
 220 public:
 221   /**
 222    * @brief The constructor.
 223    * @note  Not intended for application developers.
 224    * @SINCE_1_1.43
 225    * @param[in] pointer A pointer to a newly allocated Texture
 226    */
 227   explicit DALI_INTERNAL Texture(Internal::Texture* pointer);
 228 };
 229
 230 /**
 231  * @}
 232  */
 233 } //namespace Dali
 234
 235 #endif // DALI_TEXTURE_H