1 #ifndef DALI_INTERNAL_RENDER_FRAME_BUFFER_H
2 #define DALI_INTERNAL_RENDER_FRAME_BUFFER_H
5 * Copyright (c) 2020 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.
21 #include <dali/public-api/rendering/frame-buffer.h>
22 #include <dali/devel-api/rendering/frame-buffer-devel.h>
23 #include <dali/internal/render/gl-resources/context.h>
24 #include <dali/internal/render/renderers/render-sampler.h>
25 #include <dali/integration-api/gl-defines.h>
29 using Mask = Dali::FrameBuffer::Attachment::Mask;
44 FrameBuffer( uint32_t width, uint32_t height, Mask attachments );
49 virtual ~FrameBuffer();
52 * Creates a FrameBuffer object in the GPU.
53 * @param[in] context The GL context
55 virtual void Initialize( Context& context );
58 * Deletes the framebuffer object from the GPU
59 * @param[in] context The GL context
61 virtual void Destroy( Context& context );
64 * Called by RenderManager to inform the framebuffer that the context has been destroyed
66 virtual void GlContextDestroyed();
69 * @brief Bind the framebuffer
70 * @param[in] context The GL context
72 virtual void Bind( Context& context );
75 * @brief Get the width of the FrameBuffer
76 * @return The width of the framebuffer
78 virtual uint32_t GetWidth() const;
81 * @brief Get the height of the FrameBuffer
82 * @return The height of the framebuffer
84 virtual uint32_t GetHeight() const;
87 * @brief Attaches a texture for the color rendering. This API is valid only for frame buffer with COLOR attachments.
88 * @param[in] context The GL context
89 * @param[in] texture The texture that will be used as output when rendering
90 * @param[in] mipmapLevel The mipmap of the texture to be attached
91 * @param[in] layer Indicates which layer of a cube map or array texture to attach. Unused for 2D textures
92 * @note A maximum of Dali::FrameBuffer::MAX_COLOR_ATTACHMENTS are supported.
94 void AttachColorTexture( Context& context, Render::Texture* texture, uint32_t mipmapLevel, uint32_t layer );
97 * @brief Attaches a texture for the depth rendering. This API is valid only for frame buffer with DEPTH attachments.
98 * @param[in] context The GL context
99 * @param[in] texture The texture that will be used as output when rendering
100 * @param[in] mipmapLevel The mipmap of the texture to be attached
102 void AttachDepthTexture( Context& context, Render::Texture* texture, uint32_t mipmapLevel );
105 * @brief Attaches a texture for the depth/stencil rendering. This API is valid only for frame buffer with DEPTH_STENCIL attachments.
106 * @param[in] context The GL context
107 * @param[in] texture The texture that will be used as output when rendering
108 * @param[in] mipmapLevel The mipmap of the texture to be attached
110 void AttachDepthStencilTexture( Context& context, Render::Texture* texture, uint32_t mipmapLevel );
113 * @brief Get the number of textures bound to this frame buffer as color attachments.
114 * @return The number of color attachments.
116 uint8_t GetColorAttachmentCount() const { return mColorAttachmentCount; }
119 * @brief Get the id (OpenGL handle) of the texture bound to this frame buffer as color attachment @a index.
120 * @return The texture id.
122 GLuint GetTextureId(uint8_t index) { return mTextureId[index]; };
127 * @brief Undefined copy constructor. FrameBuffer cannot be copied
129 FrameBuffer( const FrameBuffer& rhs ) = delete;
132 * @brief Undefined assignment operator. FrameBuffer cannot be copied
134 FrameBuffer& operator=( const FrameBuffer& rhs ) = delete;
139 GLuint mTextureId[ Dali::DevelFrameBuffer::MAX_COLOR_ATTACHMENTS ];
141 GLuint mStencilBuffer;
144 uint8_t mColorAttachmentCount;
147 } // namespace Render
149 } // namespace Internal
154 #endif // DALI_INTERNAL_RENDER_FRAME_BUFFER_H