1 #ifndef DALI_FRAMEBUFFER_H
2 #define DALI_FRAMEBUFFER_H
5 * Copyright (c) 2016 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/object/base-handle.h>
23 #include <dali/public-api/rendering/texture.h>
28 namespace Internal DALI_INTERNAL
34 * @brief FrameBuffer is a collection of textures that can be used as the destination for rendering
37 class DALI_IMPORT_API FrameBuffer : public BaseHandle
42 * @brief Format of the FrameBuffer to be created.
47 COLOR, ///< Framebuffer will be created with color buffer @SINCE_1_1.43
48 COLOR_DEPTH, ///< Framebuffer will be created with color and depth buffer @SINCE_1_1.43
49 COLOR_STENCIL, ///< Framebuffer will be created with color and stencil buffer @SINCE_1_1.43
50 COLOR_DEPTH_STENCIL ///< Framebuffer will be created with color, depth and stencil buffer. @note May be not supported in all devices @SINCE_1_1.43
54 * @brief Creates a new FrameBuffer object
57 * @param[in] width The width of the FrameBuffer
58 * @param[in] height The height of the FrameBuffer
59 * @param[in] format The format of the FrameBuffer
60 * @return A handle to a newly allocated FrameBuffer
62 static FrameBuffer New( unsigned int width, unsigned int height, Format format );
65 * @brief Default constructor, creates an empty handle
76 * @brief Copy constructor, creates a new handle to the same object
79 * @param[in] handle Handle to an object
81 FrameBuffer( const FrameBuffer& handle );
84 * @brief Downcast to a FrameBuffer.
87 * If not the returned handle is left uninitialized.
88 * @param[in] handle Handle to an object
89 * @return FrameBuffer handle or an uninitialized handle
91 static FrameBuffer DownCast( BaseHandle handle );
94 * @brief Assignment operator, changes this handle to point at the same object
97 * @param[in] handle Handle to an object
98 * @return Reference to the assigned object
100 FrameBuffer& operator=( const FrameBuffer& handle );
103 * @brief Attach the base LOD of a 2D texture to the framebuffer for color rendering
106 * @param[in] texture The texture that will be used as output when rendering
107 * @note The texture has to have the same size than the FrameBuffer
108 * otherwise it won't be attached
110 void AttachColorTexture( Texture& texture );
113 * @brief Attach a texture to the framebuffer for color rendering
116 * @param[in] texture The texture that will be used as output when rendering
117 * @param[in] mipmapLevel The mipmap of the texture to be attached
118 * @param[in] layer Indicates which layer of a cube map or array texture to attach. Unused for 2D textures
119 * @note The specified texture mipmap has to have the same size than the FrameBuffer
120 * otherwise it won't be attached
122 void AttachColorTexture( Texture& texture, unsigned int mipmapLevel, unsigned int layer );
125 * @brief Get the color texture used as output in the FrameBuffer
128 * @returns A handle to the texture used as color output, or an uninitialized handle
130 Texture GetColorTexture();
135 * @brief The constructor.
136 * @note Not intended for application developers.
138 * @param[in] pointer A pointer to a newly allocated FrameBuffer
140 explicit DALI_INTERNAL FrameBuffer( Internal::FrameBuffer* pointer );
145 #endif // DALI_FRAMEBUFFER_H