dali/internal/render/renderers/render-surface-frame-buffer.h

   1 #ifndef DALI_INTERNAL_RENDER_SURFACE_FRAME_BUFFER_H
   2 #define DALI_INTERNAL_RENDER_SURFACE_FRAME_BUFFER_H
   3
   4 /*
   5  * Copyright (c) 2019 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 // EXTERNAL INCLUDES
  21 #include <atomic>
  22
  23 // INTERNAL INCLUDES
  24 #include <dali/internal/update/manager/update-manager.h>
  25 #include <dali/internal/render/renderers/render-frame-buffer.h>
  26 #include <dali/integration-api/render-surface.h>
  27
  28 namespace Dali
  29 {
  30
  31 namespace Internal
  32 {
  33
  34 class Context;
  35
  36 namespace Render
  37 {
  38
  39 class SurfaceFrameBuffer : public FrameBuffer
  40 {
  41 public:
  42
  43   /**
  44    * Constructor
  45    * @param[in] surface The render surface
  46    */
  47   SurfaceFrameBuffer( Integration::RenderSurface* surface );
  48
  49   /**
  50    * Destructor
  51    */
  52   virtual ~SurfaceFrameBuffer();
  53
  54   /**
  55    * @copydoc Dali::Internal::Renderer::FrameBuffer::Initialize()
  56    */
  57   void Initialize( Context& context ) override;
  58
  59   /**
  60    * @copydoc Dali::Internal::Renderer::FrameBuffer::Destroy()
  61    */
  62   void Destroy( Context& context ) override;
  63
  64   /**
  65    * @copydoc Dali::Internal::Renderer::FrameBuffer::GlContextDestroyed()
  66    */
  67   void GlContextDestroyed() override;
  68
  69   /**
  70    * @copydoc Dali::Internal::Renderer::FrameBuffer::Bind()
  71    */
  72   void Bind( Context& context ) override;
  73
  74   /**
  75    * @copydoc Dali::Internal::Renderer::FrameBuffer::GetWidth()
  76    */
  77   uint32_t GetWidth() const override;
  78
  79   /**
  80    * @copydoc Dali::Internal::Renderer::FrameBuffer::GetHeight()
  81    */
  82   uint32_t GetHeight() const override;
  83
  84   /**
  85    * @copydoc Dali::Internal::Renderer::FrameBuffer::IsSurfaceBacked()
  86    */
  87   bool IsSurfaceBacked() override { return true; };
  88
  89   /**
  90    * @brief Sets the frame buffer size.
  91    * @param[in] width The width size
  92    * @param[in] height The height size
  93    */
  94   void SetSize( uint32_t width, uint32_t height );
  95
  96   /**
  97    * @brief Sets the background color.
  98    * @param[in] color The new background color
  99    */
 100   void SetBackgroundColor( const Vector4& color );
 101
 102   /**
 103    * @copydoc Dali::Internal::FrameBuffer::MarkSurfaceAsInvalid()
 104    */
 105   void MarkSurfaceAsInvalid() { mIsSurfaceInvalid = true; };
 106
 107   /**
 108    * @brief Gets whether the render surface in this frame buffer is valid or not
 109    * @note The render surface becomes invalid when it is deleted in the event thread
 110    * @return Whether the render surface is valid or not
 111    */
 112   bool IsSurfaceValid() const;
 113
 114 public:
 115
 116   /**
 117    * Called after this frame buffer is rendered in the render manager
 118    */
 119   void PostRender();
 120
 121   /**
 122    * Gets the context holding the GL state of rendering for the surface
 123    * @return the context
 124    */
 125   Context* GetContext();
 126
 127   /**
 128    * @brief Makes the graphics context current
 129    */
 130   void MakeContextCurrent();
 131
 132   /**
 133    * @brief Gets the background color of the surface.
 134    * @return The background color
 135    */
 136   Vector4 GetBackgroundColor();
 137
 138   /**
 139    * @brief Sets currentframe updated/damaged rects
 140    * @return merged update rects
 141    */
 142   Rect<int32_t> SetDamagedRect( Rect<int32_t> damagedRect );
 143
 144   /**
 145    * @brief Gets whether partial update is required for partial update
 146    * @return whether partial update or not
 147    */
 148   bool IsPartialUpdateEnabled() const;
 149
 150   /**
 151    * @brief Sets whether partial update is required for partial update
 152    * @param[in] value whether partial update or not
 153    */
 154   void SetPartialUpdateEnabled( bool value );
 155
 156 private:
 157
 158   Integration::RenderSurface* mSurface;   ///< The render surface
 159   Context*                    mContext;   ///< The context holding the GL state of rendering for the surface backed frame buffer
 160
 161   uint32_t                    mWidth;
 162   uint32_t                    mHeight;
 163   Vector4                     mBackgroundColor;
 164   bool                        mSizeChanged;
 165   bool                        mBackgroundColorChanged;
 166   std::atomic<bool>           mIsSurfaceInvalid; ///< This is set only from the event thread and read only from the render thread
 167   bool                        mPartialUpdateEnabled; ///< This value is whether partial update is required
 168 };
 169
 170 // Messages for FrameBuffer
 171 inline void SetFrameBufferSizeMessage( SceneGraph::UpdateManager& updateManager, SurfaceFrameBuffer* surfaceFrameBuffer, uint32_t width, uint32_t height )
 172 {
 173   typedef MessageValue2< SurfaceFrameBuffer, uint32_t, uint32_t  > LocalType;
 174
 175   // Reserve some memory inside the message queue
 176   uint32_t* slot = updateManager.ReserveMessageSlot( sizeof( LocalType ) );
 177
 178   // Construct message in the message queue memory; note that delete should not be called on the return value
 179   new (slot) LocalType( surfaceFrameBuffer, &SurfaceFrameBuffer::SetSize, width, height );
 180 }
 181
 182 inline void SetFrameBufferBackgroundColorMessage( SceneGraph::UpdateManager& updateManager, SurfaceFrameBuffer* surfaceFrameBuffer, const Vector4& color )
 183 {
 184   typedef MessageValue1< SurfaceFrameBuffer, Vector4 > LocalType;
 185
 186   // Reserve some memory inside the message queue
 187   uint32_t* slot = updateManager.ReserveMessageSlot( sizeof( LocalType ) );
 188
 189   // Construct message in the message queue memory; note that delete should not be called on the return value
 190   new (slot) LocalType( surfaceFrameBuffer, &SurfaceFrameBuffer::SetBackgroundColor, color );
 191 }
 192
 193 inline void SetFrameBufferPartialUpdateMessage( SceneGraph::UpdateManager& updateManager, SurfaceFrameBuffer* surfaceFrameBuffer, bool value )
 194 {
 195   typedef MessageValue1< SurfaceFrameBuffer, bool > LocalType;
 196
 197   // Reserve some memory inside the message queue
 198   uint32_t* slot = updateManager.ReserveMessageSlot( sizeof( LocalType ) );
 199
 200   // Construct message in the message queue memory; note that delete should not be called on the return value
 201   new (slot) LocalType( surfaceFrameBuffer, &SurfaceFrameBuffer::SetPartialUpdateEnabled, value );
 202 }
 203
 204 } // namespace Render
 205
 206 } // namespace Internal
 207
 208 } // namespace Dali
 209
 210
 211 #endif // DALI_INTERNAL_RENDER_SURFACE_FRAME_BUFFER_H