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 namespace Internal DALI_INTERNAL
37 * @brief FrameBuffer is a collection of textures that can be used as the destination for rendering.
40 class DALI_CORE_API FrameBuffer : public BaseHandle
45 * @brief The initial attachments to create the FrameBuffer with.
46 * @note The color attachment is created on calling AttachColorTexture(). If a color attachment is not required, omit this call.
47 * @note With "NONE", no attachments are created initially. However color attachments can still be added as described above.
54 * @brief Enumeration for the bit-mask value.
59 NONE = 0, ///< No attachments are created initially @SINCE_1_1.45
61 DEPTH = 1 << 0, ///< Depth buffer bit-mask value @SINCE_1_1.45
62 STENCIL = 1 << 1, ///< Stencil buffer bit-mask value @SINCE_1_1.45
64 // Preset bit-mask combinations:
65 DEPTH_STENCIL = DEPTH | STENCIL ///< The Framebuffer will be created with depth and stencil buffer @SINCE_1_1.45
70 * @brief Creates a new FrameBuffer object.
73 * @param[in] width The width of the FrameBuffer
74 * @param[in] height The height of the FrameBuffer
75 * @param[in] attachments The attachments comprising the format of the FrameBuffer (the type is int to allow multiple bitmasks to be ORd)
76 * @return A handle to a newly allocated FrameBuffer
78 static FrameBuffer New( uint32_t width, uint32_t height, uint32_t attachments );
81 * @brief Default constructor, creates an empty handle.
92 * @brief Copy constructor, creates a new handle to the same object.
95 * @param[in] handle Handle to an object
97 FrameBuffer( const FrameBuffer& handle );
100 * @brief Downcasts to a FrameBuffer.
101 * If not, the returned handle is left uninitialized.
103 * @param[in] handle Handle to an object
104 * @return FrameBuffer handle or an uninitialized handle
106 static FrameBuffer DownCast( BaseHandle handle );
109 * @brief Assignment operator, changes this handle to point at the same object.
112 * @param[in] handle Handle to an object
113 * @return Reference to the assigned object
115 FrameBuffer& operator=( const FrameBuffer& handle );
118 * @brief Attach the base LOD of a 2D texture to the framebuffer for color rendering.
119 * @note This causes a color attachment to be added.
122 * @param[in] texture The texture that will be used as output when rendering
123 * @note The texture has to have the same size than the FrameBuffer
124 * otherwise it won't be attached.
126 void AttachColorTexture( Texture& texture );
129 * @brief Attach a texture to the framebuffer for color rendering.
130 * @note This causes a color attachment to be added.
133 * @param[in] texture The texture that will be used as output when rendering
134 * @param[in] mipmapLevel The mipmap of the texture to be attached
135 * @param[in] layer Indicates which layer of a cube map or array texture to attach. Unused for 2D textures
136 * @note The specified texture mipmap has to have the same size than the FrameBuffer
137 * otherwise it won't be attached.
139 void AttachColorTexture( Texture& texture, uint32_t mipmapLevel, uint32_t layer );
142 * @brief Gets the color texture used as output in the FrameBuffer.
145 * @returns A handle to the texture used as color output, or an uninitialized handle
147 Texture GetColorTexture();
152 * @brief The constructor.
153 * @note Not intended for application developers.
155 * @param[in] pointer A pointer to a newly allocated FrameBuffer
157 explicit DALI_INTERNAL FrameBuffer( Internal::FrameBuffer* pointer );
162 #endif // DALI_FRAMEBUFFER_H