From: Seungho, Baek Date: Mon, 25 May 2020 06:32:47 +0000 (+0900) Subject: Fix documentation of FrameBuffer X-Git-Tag: dali_1.9.14~4 X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-core.git;a=commitdiff_plain;h=c4b821482ff770320bf94f631757bd0bc06daf0b Fix documentation of FrameBuffer Change-Id: I2769eb346761de6b33c3dc893d41b166f1841a62 Signed-off-by: Seungho, Baek --- diff --git a/dali/devel-api/rendering/frame-buffer-devel.h b/dali/devel-api/rendering/frame-buffer-devel.h index 8ffe17c..3d5f5df 100644 --- a/dali/devel-api/rendering/frame-buffer-devel.h +++ b/dali/devel-api/rendering/frame-buffer-devel.h @@ -33,55 +33,55 @@ namespace DevelFrameBuffer constexpr uint8_t MAX_COLOR_ATTACHMENTS = 8; /** - * @brief Attach the base LOD of a depth texture to the framebuffer. + * @brief Attaches the base LOD of a depth texture to the frame buffer. * @note This causes a depth attachment to be added. * - * @param[in] frameBuffer A handle to the framebuffer + * @param[in] frameBuffer A handle to the FrameBuffer * @param[in] texture The texture that will be used as output when rendering - * @note The texture has to have same size as that of FrameBuffer - * otherwise it won't be attached. + * @note The size of the texture has to be same as that of the frame buffer. + * Otherwise, it won't be attached. */ void AttachDepthTexture( FrameBuffer frameBuffer, Texture& texture ); /** - * @brief Attach a depth texture to the framebuffer. + * @brief Attaches a depth texture to the frame buffer. * @note This causes a depth attachment to be added. * - * @param[in] frameBuffer A handle to the framebuffer + * @param[in] frameBuffer A handle to the FrameBuffer * @param[in] texture The texture that will be used as output when rendering * @param[in] mipmapLevel The mipmap of the texture to be attached - * @note The mipmapped texture has to have same size as that of FrameBuffer - * otherwise it won't be attached. + * @note The size of the mipmapped texture has to be same as that of the frame buffer. + * Otherwise, it won't be attached. */ void AttachDepthTexture( FrameBuffer frameBuffer, Texture& texture, uint32_t mipmapLevel ); /** - * @brief Attach the base LOD of a stencil texture to the framebuffer. + * @brief Attaches the base LOD of a stencil texture to the frame buffer. * @note This causes a stencil attachment to be added. * - * @param[in] frameBuffer A handle to the framebuffer + * @param[in] frameBuffer A handle to the FrameBuffer * @param[in] texture The texture that will be used as output when rendering - * @note The texture has to have same size as that of FrameBuffer - * otherwise it won't be attached. + * @note The size of the texture has to be same as that of the frame buffer. + * Otherwise, it won't be attached. */ void AttachDepthStencilTexture( FrameBuffer frameBuffer, Texture& texture ); /** - * @brief Attach a depth/stencil texture to the framebuffer. + * @brief Attaches a depth/stencil texture to the frame buffer. * @note This causes a depth/stencil attachment to be added. * - * @param[in] frameBuffer A handle to the framebuffer + * @param[in] frameBuffer A handle to the FrameBuffer * @param[in] texture The texture that will be used as output when rendering * @param[in] mipmapLevel The mipmap of the texture to be attached - * @note The mipmapped texture has to have same size as that of FrameBuffer - * otherwise it won't be attached. + * @note The size of the mipmapped texture has to be same as that of the frame buffer. + * Otherwise, it won't be attached. */ void AttachDepthStencilTexture( FrameBuffer frameBuffer, Texture& texture, uint32_t mipmapLevel ); /** - * @brief Gets the color texture at the given @a index used as output in the FrameBuffer. + * @brief Gets the color texture at the given @a index used as output in the frame buffer. * - * @param[in] frameBuffer A handle to the framebuffer + * @param[in] frameBuffer A handle to the FrameBuffer * @param[in] index The index required * * @return A handle to the texture used as color output, or an uninitialized handle @@ -92,20 +92,20 @@ void AttachDepthStencilTexture( FrameBuffer frameBuffer, Texture& texture, uint3 Texture GetColorTexture( const FrameBuffer frameBuffer, uint8_t index ); /** - * @brief Gets the depth texture used as output in the FrameBuffer. + * @brief Gets the depth texture used as output in the frame buffer. * - * @param[in] frameBuffer A handle to the framebuffer + * @param[in] frameBuffer The FrameBuffer handle * - * @return A handle to the texture used as depth output, or an uninitialized handle + * @return A handle of the texture used as depth output, or an uninitialized handle */ Texture GetDepthTexture( FrameBuffer frameBuffer ); /** - * @brief Gets the depth/stencil texture used as output in the FrameBuffer. + * @brief Gets the depth/stencil texture used as output in the frame buffer. * - * @param[in] frameBuffer A handle to the framebuffer + * @param[in] frameBuffer The FrameBuffer handle * - * @return A handle to the texture used as stencil output, or an uninitialized handle + * @return A handle of the texture used as depth/stencil output, or an uninitialized handle */ Texture GetDepthStencilTexture( FrameBuffer frameBuffer ); diff --git a/dali/internal/render/common/render-manager.h b/dali/internal/render/common/render-manager.h index b91984d..396495e 100644 --- a/dali/internal/render/common/render-manager.h +++ b/dali/internal/render/common/render-manager.h @@ -284,7 +284,7 @@ public: void RemoveFrameBuffer( Render::FrameBuffer* frameBuffer ); /** - * Attach a texture as color output to an existing FrameBuffer + * Attaches a texture as color output to the existing frame buffer * @param[in] frameBuffer The FrameBuffer * @param[in] texture The texture that will be used as output when rendering * @param[in] mipmapLevel The mipmap of the texture to be attached @@ -293,7 +293,7 @@ public: void AttachColorTextureToFrameBuffer( Render::FrameBuffer* frameBuffer, Render::Texture* texture, uint32_t mipmapLevel, uint32_t layer ); /** - * Attach a texture as depth output to an existing FrameBuffer + * Attaches a texture as depth output to the existing frame buffer * @param[in] frameBuffer The FrameBuffer * @param[in] texture The texture that will be used as output when rendering * @param[in] mipmapLevel The mipmap of the texture to be attached @@ -301,7 +301,7 @@ public: void AttachDepthTextureToFrameBuffer( Render::FrameBuffer* frameBuffer, Render::Texture* texture, uint32_t mipmapLevel ); /** - * Attach a texture as depth/stencil output to an existing FrameBuffer + * Attaches a texture as depth/stencil output to the existing frame buffer * @param[in] frameBuffer The FrameBuffer * @param[in] texture The texture that will be used as output when rendering * @param[in] mipmapLevel The mipmap of the texture to be attached diff --git a/dali/internal/render/renderers/render-frame-buffer.h b/dali/internal/render/renderers/render-frame-buffer.h index d88bb8a..5dbbc32 100644 --- a/dali/internal/render/renderers/render-frame-buffer.h +++ b/dali/internal/render/renderers/render-frame-buffer.h @@ -84,7 +84,7 @@ public: virtual uint32_t GetHeight() const; /** - * @brief Attach a texture for color rendering. Valid only for Framebuffers with COLOR attachments. + * @brief Attaches a texture for the color rendering. This API is valid only for frame buffer with COLOR attachments. * @param[in] context The GL context * @param[in] texture The texture that will be used as output when rendering * @param[in] mipmapLevel The mipmap of the texture to be attached @@ -94,7 +94,7 @@ public: void AttachColorTexture( Context& context, Render::Texture* texture, uint32_t mipmapLevel, uint32_t layer ); /** - * @brief Attach a texture for depth rendering. Valid only for Framebuffers with DEPTH attachments. + * @brief Attaches a texture for the depth rendering. This API is valid only for frame buffer with DEPTH attachments. * @param[in] context The GL context * @param[in] texture The texture that will be used as output when rendering * @param[in] mipmapLevel The mipmap of the texture to be attached @@ -102,7 +102,7 @@ public: void AttachDepthTexture( Context& context, Render::Texture* texture, uint32_t mipmapLevel ); /** - * @brief Attach a texture for depth/stencil rendering. Valid only for Framebuffers with DEPTH_STENCIL attachments. + * @brief Attaches a texture for the depth/stencil rendering. This API is valid only for frame buffer with DEPTH_STENCIL attachments. * @param[in] context The GL context * @param[in] texture The texture that will be used as output when rendering * @param[in] mipmapLevel The mipmap of the texture to be attached