1 #ifndef DALI_FRAMEBUFFER_H
2 #define DALI_FRAMEBUFFER_H
5 * Copyright (c) 2018 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 <cstdint> // uint32_t
25 #include <dali/public-api/object/base-handle.h>
26 #include <dali/public-api/rendering/texture.h>
31 * @addtogroup dali_core_rendering_effects
35 namespace Internal DALI_INTERNAL
41 * @brief FrameBuffer is a collection of textures that can be used as the destination for rendering.
44 class DALI_CORE_API FrameBuffer : public BaseHandle
49 * @brief The initial attachments to create the FrameBuffer with.
50 * @note The color attachment can also be created on calling AttachColorTexture().
51 * @note With "NONE", no attachments are created initially. However color attachments can still be added as described above.
58 * @brief Enumeration for the attachments and/or textures to be created by default
63 NONE = 0, ///< No attachments are created initially. @SINCE_1_1.45
64 DEPTH = 1 << 0, ///< Depth buffer is created. @SINCE_1_1.45
65 STENCIL = 1 << 1, ///< Stencil buffer is created. @SINCE_1_1.45
66 DEPTH_STENCIL = DEPTH | STENCIL, ///< Depth and stencil buffer are created. @SINCE_1_1.45
67 COLOR = 1 << 2, ///< Color texture is created. @SINCE_1_4.0
68 COLOR_DEPTH = COLOR | DEPTH, ///< Color texture and depth buffer are created. @SINCE_1_4.0
69 COLOR_STENCIL = COLOR | STENCIL, ///< Color texture and stencil buffer are created. @SINCE_1_4.0
70 COLOR_DEPTH_STENCIL = COLOR_DEPTH | STENCIL ///< Color, depth and stencil buffer are created. @SINCE_1_4.0
75 * @brief Creates a new FrameBuffer, which attaches only COLOR texture.
79 * @note Call GetColorTexture() to get the COLOR texture
81 * @param[in] width The width of the FrameBuffer and the color texture
82 * @param[in] height The height of the FrameBuffer and the color texture
83 * @return A handle to a newly allocated FrameBuffer
85 static FrameBuffer New( uint32_t width, uint32_t height );
88 * @brief Creates a new FrameBuffer with specific attachments.
92 * @param[in] width The width of the FrameBuffer and the attachments
93 * @param[in] height The height of the FrameBuffer and the attachments
94 * @param[in] attachments Enumeration of the attachments to create
95 * @return A handle to a newly allocated FrameBuffer
97 static FrameBuffer New( uint32_t width, uint32_t height, Attachment::Mask attachments );
100 * @DEPRECATED_1_4.0 use New( uint32_t width, uint32_t height ) or New( uint32_t width, uint32_t height, Attachment::Mask attachments ) instead
101 * @brief Creates a new FrameBuffer object.
105 * @param[in] width The width of the FrameBuffer
106 * @param[in] height The height of the FrameBuffer
107 * @param[in] attachments The attachments comprising the format of the FrameBuffer (the type is int to allow multiple bitmasks to be ORd)
108 * @return A handle to a newly allocated FrameBuffer
110 static FrameBuffer New( uint32_t width, uint32_t height, uint32_t attachments );
113 * @brief Default constructor, creates an empty handle.
124 * @brief Copy constructor, creates a new handle to the same object.
127 * @param[in] handle Handle to an object
129 FrameBuffer( const FrameBuffer& handle );
132 * @brief Downcasts to a FrameBuffer.
133 * If not, the returned handle is left uninitialized.
135 * @param[in] handle Handle to an object
136 * @return FrameBuffer handle or an uninitialized handle
138 static FrameBuffer DownCast( BaseHandle handle );
141 * @brief Assignment operator, changes this handle to point at the same object.
144 * @param[in] handle Handle to an object
145 * @return Reference to the assigned object
147 FrameBuffer& operator=( const FrameBuffer& handle );
150 * @brief Attach the base LOD of a 2D texture to the framebuffer for color rendering.
151 * @note This causes a color attachment to be added.
154 * @param[in] texture The texture that will be used as output when rendering
155 * @note The texture has to have the same size than the FrameBuffer
156 * otherwise it won't be attached.
158 void AttachColorTexture( Texture& texture );
161 * @brief Attach a texture to the framebuffer for color rendering.
162 * @note This causes a color attachment to be added.
165 * @param[in] texture The texture that will be used as output when rendering
166 * @param[in] mipmapLevel The mipmap of the texture to be attached
167 * @param[in] layer Indicates which layer of a cube map or array texture to attach. Unused for 2D textures
168 * @note The specified texture mipmap has to have the same size than the FrameBuffer
169 * otherwise it won't be attached.
171 void AttachColorTexture( Texture& texture, uint32_t mipmapLevel, uint32_t layer );
174 * @brief Gets the color texture used as output in the FrameBuffer.
177 * @returns A handle to the texture used as color output, or an uninitialized handle
179 Texture GetColorTexture();
184 * @brief The constructor.
185 * @note Not intended for application developers.
187 * @param[in] pointer A pointer to a newly allocated FrameBuffer
189 explicit DALI_INTERNAL FrameBuffer( Internal::FrameBuffer* pointer );
197 #endif // DALI_FRAMEBUFFER_H