1 #ifndef __DALI_FRAME_BUFFER_IMAGE_H__
2 #define __DALI_FRAME_BUFFER_IMAGE_H__
5 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
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>
29 * @addtogroup dali_core_images
33 namespace Internal DALI_INTERNAL
35 class FrameBufferImage;
38 namespace RenderBuffer
41 * @brief Render Buffer formats
42 * The default format for framebuffer creation is COLOR, so If a depth buffer for 3D rendering is required use
45 enum Format ///< Framebuffer format, default color depth is RGBA 32 bit with alpha @SINCE_1_0.0
47 COLOR, ///< Framebuffer will be created with color buffer. @SINCE_1_0.0
48 COLOR_DEPTH, ///< Framebuffer will be created with color and depth buffer @SINCE_1_0.0
49 COLOR_STENCIL, ///< Framebuffer will be created with color and stencil buffer @SINCE_1_0.0
50 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
55 * @brief FrameBufferImage represents a Open GL ES Frame Buffer Object
56 * It contains the result of an 'off screen' render pass of a RenderTask.
57 * The FrameBufferImage can then be used for rendering to the screen.
60 class DALI_IMPORT_API FrameBufferImage : public Image
64 * @brief Constructor which creates an uninitialized FrameBufferImage object.
66 * Use Image::New(...) to create an initialised object.
72 * @brief Create a new FrameBufferImage.
74 * The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.
77 * @param [in] width The width in pixels. Setting to zero will use the width of the stage.
78 * @param [in] height The height in pixels. Setting to zero will use the height of the stage.
79 * @param [in] pixelFormat The pixel format (rgba 32 bit by default)
80 * @param [in] bufferFormat The format of the buffers that are going to be created for the FBO, (COLOR and DEPTH buffer as default)
81 * @return A handle to a new instance of a FrameBufferImage.
82 * @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.
84 static FrameBufferImage New(unsigned int width = 0, unsigned int height = 0, Pixel::Format pixelFormat = Pixel::RGBA8888,
85 RenderBuffer::Format bufferFormat = RenderBuffer::COLOR);
88 * @deprecated DALi 1.1.3 use New() instead.
90 * @brief Create a new FrameBufferImage.
92 * The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.
94 * @param [in] width The width in pixels. Setting to zero will use the width of the stage.
95 * @param [in] height The height in pixels. Setting to zero will use the height of the stage.
96 * @param [in] pixelFormat The pixel format.
97 * @param [in] releasePolicy The ReleasePolicy to apply to the FrameBufferImage.
98 * @param [in] bufferFormat The format of the buffers that are going to be created for the FBO, (COLOR and DEPTH buffer as default)
100 * @return A handle to a new instance of a FrameBufferImage.
101 * @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.
103 static FrameBufferImage New(unsigned int width, unsigned int height, Pixel::Format pixelFormat, ReleasePolicy releasePolicy,
104 RenderBuffer::Format bufferFormat = RenderBuffer::COLOR);
107 * @brief Create a new FrameBufferImage.
109 * The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.
111 * @param [in] image The native image.
113 * @return A handle to a new instance of a FrameBufferImage.
114 * @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.
116 static FrameBufferImage New(NativeImageInterface& image);
119 * @deprecated DALi 1.1.3 use New( NativeImageInterface& ) instead.
121 * @brief Create a new FrameBufferImage.
123 * The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.
125 * @param [in] image The native image.
126 * @param [in] releasePolicy The ReleasePolicy to apply to the FrameBufferImage.
128 * @return A handle to a new instance of a FrameBufferImage.
129 * @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.
131 static FrameBufferImage New(NativeImageInterface& image, ReleasePolicy releasePolicy);
134 * @brief Downcast an Object handle to FrameBufferImage handle.
136 * If handle points to a FrameBufferImage object the
137 * downcast produces valid handle. If not the returned handle is left uninitialized.
139 * @param[in] handle to An object
140 * @return handle to a FrameBufferImage object or an uninitialized handle
142 static FrameBufferImage DownCast( BaseHandle handle );
147 * This is non-virtual since derived Handle types must not contain data or virtual methods.
153 * @brief This copy constructor is required for (smart) pointer semantics.
156 * @param [in] handle A reference to the copied handle
158 FrameBufferImage(const FrameBufferImage& handle);
161 * @brief This assignment operator is required for (smart) pointer semantics.
164 * @param [in] rhs A reference to the copied handle
165 * @return A reference to this
167 FrameBufferImage& operator=(const FrameBufferImage& rhs);
169 public: // Not intended for application developers
171 explicit DALI_INTERNAL FrameBufferImage(Internal::FrameBufferImage*);
172 }; //class FrameBufferImage
179 #endif // __DALI_FRAME_BUFFER_IMAGE_H__