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
43 * The default format for framebuffer creation is COLOR, so If a depth buffer for 3D rendering is required use
47 enum Format ///< Framebuffer format, default color depth is RGBA 32 bit with alpha @SINCE_1_0.0
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
57 * @brief FrameBufferImage represents an Open GL ES Frame Buffer Object and contains the result
58 * of an 'off screen' render pass of a RenderTask.
60 * The FrameBufferImage can then be used for rendering to the screen.
63 class DALI_IMPORT_API FrameBufferImage : public Image
67 * @brief Constructor which creates an uninitialized FrameBufferImage object.
69 * Use @ref FrameBufferImage::New to create an initialised object.
75 * @brief Create a new FrameBufferImage.
77 * The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.
80 * @param [in] width The width in pixels. Setting to zero will use the width of the stage.
81 * @param [in] height The height in pixels. Setting to zero will use the height of the stage.
82 * @param [in] pixelFormat The pixel format (rgba 32 bit by default)
83 * @param [in] bufferFormat The format of the buffers that are going to be created for the FBO, (COLOR and DEPTH buffer as default)
84 * @return A handle to a new instance of a FrameBufferImage.
85 * @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 static FrameBufferImage New(unsigned int width = 0, unsigned int height = 0, Pixel::Format pixelFormat = Pixel::RGBA8888,
88 RenderBuffer::Format bufferFormat = RenderBuffer::COLOR);
91 * @DEPRECATED_1_1.3. Use New() instead.
93 * @brief Create a new FrameBufferImage.
95 * The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.
97 * @remarks Image::ReleasePolicy is an experimental feature and might not be supported in the next release.
98 * We do recommend not to use this method.
99 * Please refer the Remarks of ReleasePolicy for more information.
100 * @param [in] width The width in pixels. Setting to zero will use the width of the stage.
101 * @param [in] height The height in pixels. Setting to zero will use the height of the stage.
102 * @param [in] pixelFormat The pixel format.
103 * @param [in] releasePolicy The releasePolicy to apply to the FrameBufferImage.
104 * @param [in] bufferFormat The format of the buffers that are going to be created for the FBO, (COLOR and DEPTH buffer as default)
106 * @return A handle to a new instance of a FrameBufferImage.
107 * @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 static FrameBufferImage New(unsigned int width, unsigned int height, Pixel::Format pixelFormat, ReleasePolicy releasePolicy,
110 RenderBuffer::Format bufferFormat = RenderBuffer::COLOR);
113 * @brief Create a new FrameBufferImage.
115 * The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.
117 * @param [in] image The native image.
119 * @return A handle to a new instance of a FrameBufferImage.
120 * @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 static FrameBufferImage New(NativeImageInterface& image);
125 * @DEPRECATED_1_1.3. Use New( NativeImageInterface& ) instead.
127 * @brief Create a new FrameBufferImage.
129 * The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.
131 * @remarks Image::ReleasePolicy is an experimental feature and might not be supported in the next release.
132 * We do recommend not to use this method.
133 * Please refer the remarks of ReleasePolicy for more information.
134 * @param [in] image The native image.
135 * @param [in] releasePolicy The releasePolicy to apply to the FrameBufferImage.
137 * @return A handle to a new instance of a FrameBufferImage.
138 * @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 static FrameBufferImage New(NativeImageInterface& image, ReleasePolicy releasePolicy);
143 * @brief Downcast a handle to FrameBufferImage handle.
145 * If handle points to a FrameBufferImage object the
146 * downcast produces valid handle. If not the returned handle is left uninitialized.
148 * @param[in] handle Handle to an object
149 * @return Handle to a FrameBufferImage object or an uninitialized handle
151 static FrameBufferImage DownCast( BaseHandle handle );
156 * This is non-virtual since derived Handle types must not contain data or virtual methods.
162 * @brief This copy constructor is required for (smart) pointer semantics.
165 * @param [in] handle A reference to the copied handle
167 FrameBufferImage(const FrameBufferImage& handle);
170 * @brief This assignment operator is required for (smart) pointer semantics.
173 * @param [in] rhs A reference to the copied handle
174 * @return A reference to this
176 FrameBufferImage& operator=(const FrameBufferImage& rhs);
178 public: // Not intended for application developers
180 explicit DALI_INTERNAL FrameBufferImage(Internal::FrameBufferImage*);
181 }; //class FrameBufferImage
188 #endif // __DALI_FRAME_BUFFER_IMAGE_H__