dali/internal/graphics/gles-impl/gles-graphics-framebuffer.h

   1 #ifndef DALI_GRAPHICS_GLES_FRAMEBUFFER_H
   2 #define DALI_GRAPHICS_GLES_FRAMEBUFFER_H
   3
   4 /*
   5  * Copyright (c) 2022 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/graphics-api/graphics-framebuffer-create-info.h>
  23 #include <dali/graphics-api/graphics-framebuffer.h>
  24
  25 // INTERNAL INCLUDES
  26 #include "gles-graphics-resource.h"
  27
  28 namespace Dali::Graphics::GLES
  29 {
  30 using FramebufferResource = Resource<Graphics::Framebuffer, Graphics::FramebufferCreateInfo>;
  31
  32 class Framebuffer : public FramebufferResource
  33 {
  34 public:
  35   /**
  36    * @brief Constructor
  37    * @param[in] createInfo Valid createInfo structure
  38    * @param[in] controller Reference to the controller
  39    */
  40   Framebuffer(const Graphics::FramebufferCreateInfo& createInfo, Graphics::EglGraphicsController& controller);
  41
  42   /**
  43    * @brief Destructor
  44    */
  45   ~Framebuffer() override;
  46
  47   /**
  48    * @brief Called when GL resources are destroyed
  49    */
  50   void DestroyResource() override;
  51
  52   /**
  53    * @brief Called when initializing the resource
  54    *
  55    * @return True on success
  56    */
  57   bool InitializeResource() override;
  58
  59   /**
  60    * @brief Called when UniquePtr<> on client-side dies
  61    */
  62   void DiscardResource() override;
  63
  64   /**
  65    * Used to bind the framebuffer, e.g. when offscreen changes
  66    */
  67   void Bind() const;
  68
  69   [[nodiscard]] uint32_t GetGlFramebufferId() const;
  70
  71   [[nodiscard]] uint32_t GetGlDepthBufferId() const;
  72
  73   [[nodiscard]] uint32_t GetGlStencilBufferId() const;
  74
  75   void CaptureRenderingResult(CallbackBase* capturedCallback, uint8_t* capturedBuffer);
  76
  77   void DrawRenderedBuffer();
  78
  79   bool CaptureRequested() const
  80   {
  81     return mCaptureRenderedResult;
  82   }
  83
  84 private:
  85   /**
  86    * Attach a texture to the specified attachment point
  87    * @param[in] texture The texture to bind
  88    * @param[in] attachmentId The attachment point to bind it to
  89    * @param[in] layerId The texture layer (e.g. for cubemap)
  90    * @param[in] levelId The texture mipmap level
  91    */
  92   void AttachTexture(const Graphics::Texture* texture, uint32_t attachmentId, uint32_t layerId, uint32_t levelId);
  93
  94 private:
  95   uint32_t mFramebufferId{0u};
  96   uint32_t mDepthBufferId{0u};
  97   uint32_t mStencilBufferId{0u};
  98   uint32_t mMultisamples{1u};
  99   bool     mInitialized{false};
 100
 101   uint8_t*            mCapturedBuffer{nullptr};   ///< not owned
 102   Dali::CallbackBase* mCapturedCallback{nullptr}; ///< not owned
 103   bool                mCaptureRenderedResult{false};
 104 };
 105
 106 } // namespace Dali::Graphics::GLES
 107
 108 #endif