dali/public-api/images/frame-buffer-image.h

   1 #ifndef __DALI_FRAME_BUFFER_IMAGE_H__
   2 #define __DALI_FRAME_BUFFER_IMAGE_H__
   3
   4 /*
   5  * Copyright (c) 2015 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/image.h>
  23 #include <dali/public-api/images/native-image-interface.h>
  24 #include <dali/public-api/images/pixel.h>
  25
  26 namespace Dali
  27 {
  28 /**
  29  * @addtogroup dali_core_images
  30  * @{
  31  */
  32
  33 namespace Internal DALI_INTERNAL
  34 {
  35 class FrameBufferImage;
  36 }
  37
  38 namespace RenderBuffer
  39 {
  40 /**
  41  * @brief Render Buffer formats
  42  *
  43  * The default format for framebuffer creation is COLOR, so If a depth buffer for 3D rendering is required use
  44  * COLOR_DEPTH instead
  45  * @SINCE_1_0.0
  46  */
  47 enum Format ///< Framebuffer format, default color depth is RGBA 32 bit with alpha @SINCE_1_0.0
  48 {
  49   COLOR,                ///< Framebuffer will be created with color buffer. @SINCE_1_0.0
  50   COLOR_DEPTH,          ///< Framebuffer will be created with color and depth buffer @SINCE_1_0.0
  51   COLOR_STENCIL,        ///< Framebuffer will be created with color and stencil buffer @SINCE_1_0.0
  52   COLOR_DEPTH_STENCIL   ///< Framebuffer will be created with color, depth and stencil buffer. @note May be not supported in all devices @SINCE_1_0.0
  53 };
  54 }
  55
  56 /**
  57  * @brief FrameBufferImage represents a GLES Frame Buffer Object and contains the result
  58  * of an 'off screen' render pass of a RenderTask.
  59  *
  60  * The FrameBufferImage can then be used with an @ref Dali::Toolkit::ImageView (with optional shader
  61  * effects) and rendered to the screen.
  62  * @SINCE_1_0.0
  63  */
  64 class DALI_IMPORT_API FrameBufferImage : public Image
  65 {
  66 public:
  67   /**
  68    * @brief Constructor which creates an uninitialized FrameBufferImage object.
  69    *
  70    * Use @ref FrameBufferImage::New to create an initialised object.
  71    * @SINCE_1_0.0
  72    */
  73   FrameBufferImage();
  74
  75   /**
  76    * @brief Create a new FrameBufferImage.
  77    *
  78    * The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.
  79    *
  80    * @SINCE_1_0.0
  81    * @param [in] width       The width in pixels. Setting to zero will use the width of the stage.
  82    * @param [in] height      The height in pixels. Setting to zero will use the height of the stage.
  83    * @param [in] pixelFormat The pixel format (rgba 32 bit by default)
  84    * @param [in] bufferFormat The format of the buffers that are going to be created for the FBO, (COLOR and DEPTH buffer as default)
  85    * @return A handle to a new instance of a FrameBufferImage.
  86    * @post When the FrameBufferImage is first used as a render target, an exception may be thrown if pixelFormat is not supported on the hardware platform.
  87    */
  88   static FrameBufferImage New(unsigned int width = 0, unsigned int height = 0, Pixel::Format pixelFormat = Pixel::RGBA8888,
  89                               RenderBuffer::Format bufferFormat = RenderBuffer::COLOR);
  90
  91   /**
  92    * @DEPRECATED_1_1.3. Use New() instead.
  93    *
  94    * @brief Create a new FrameBufferImage.
  95    *
  96    * The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.
  97    * @SINCE_1_0.0
  98    * @remarks Image::ReleasePolicy is an experimental feature and might not be supported in the next release.
  99    * We do recommend not to use this method.
 100    * Please refer the Remarks of ReleasePolicy for more information.
 101    * @param [in] width       The width in pixels. Setting to zero will use the width of the stage.
 102    * @param [in] height      The height in pixels. Setting to zero will use the height of the stage.
 103    * @param [in] pixelFormat The pixel format.
 104    * @param [in] releasePolicy The releasePolicy to apply to the FrameBufferImage.
 105    * @param [in] bufferFormat The format of the buffers that are going to be created for the FBO, (COLOR and DEPTH buffer as default)
 106    *
 107    * @return A handle to a new instance of a FrameBufferImage.
 108    * @post When the FrameBufferImage is first used as a render target, an exception may be thrown if pixelFormat is not supported on the hardware platform.
 109    */
 110   static FrameBufferImage New(unsigned int width, unsigned int height, Pixel::Format pixelFormat, ReleasePolicy releasePolicy,
 111                               RenderBuffer::Format bufferFormat = RenderBuffer::COLOR);
 112
 113   /**
 114    * @brief Create a new FrameBufferImage.
 115    *
 116    * The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.
 117    * @SINCE_1_0.0
 118    * @param [in] image       The native image.
 119    *
 120    * @return A handle to a new instance of a FrameBufferImage.
 121    * @post When the FrameBufferImage is first used as a render target, an exception may be thrown if the NativeImage cannot be mapped to a texture.
 122    */
 123   static FrameBufferImage New(NativeImageInterface& image);
 124
 125   /**
 126    * @DEPRECATED_1_1.3. Use New( NativeImageInterface& ) instead.
 127    *
 128    * @brief Create a new FrameBufferImage.
 129    *
 130    * The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.
 131    * @SINCE_1_0.0
 132    * @remarks Image::ReleasePolicy is an experimental feature and might not be supported in the next release.
 133    * We do recommend not to use this method.
 134    * Please refer the remarks of ReleasePolicy for more information.
 135    * @param [in] image       The native image.
 136    * @param [in] releasePolicy The releasePolicy to apply to the FrameBufferImage.
 137    *
 138    * @return A handle to a new instance of a FrameBufferImage.
 139    * @post When the FrameBufferImage is first used as a render target, an exception may be thrown if the NativeImage cannot be mapped to a texture.
 140    */
 141   static FrameBufferImage New(NativeImageInterface& image, ReleasePolicy releasePolicy);
 142
 143   /**
 144    * @brief Downcast a handle to FrameBufferImage handle.
 145    *
 146    * If handle points to a FrameBufferImage object the
 147    * downcast produces valid handle. If not the returned handle is left uninitialized.
 148    * @SINCE_1_0.0
 149    * @param[in] handle Handle to an object
 150    * @return Handle to a FrameBufferImage object or an uninitialized handle
 151    */
 152   static FrameBufferImage DownCast( BaseHandle handle );
 153
 154   /**
 155    * @brief Destructor
 156    *
 157    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 158    * @SINCE_1_0.0
 159    */
 160   ~FrameBufferImage();
 161
 162   /**
 163    * @brief This copy constructor is required for (smart) pointer semantics.
 164    *
 165    * @SINCE_1_0.0
 166    * @param [in] handle A reference to the copied handle
 167    */
 168   FrameBufferImage(const FrameBufferImage& handle);
 169
 170   /**
 171    * @brief This assignment operator is required for (smart) pointer semantics.
 172    *
 173    * @SINCE_1_0.0
 174    * @param [in] rhs  A reference to the copied handle
 175    * @return A reference to this
 176    */
 177   FrameBufferImage& operator=(const FrameBufferImage& rhs);
 178
 179 public: // Not intended for application developers
 180
 181   explicit DALI_INTERNAL FrameBufferImage(Internal::FrameBufferImage*);
 182 }; //class FrameBufferImage
 183
 184 /**
 185  * @}
 186  */
 187 } // namespace Dali
 188
 189 #endif // __DALI_FRAME_BUFFER_IMAGE_H__