dali/internal/event/rendering/frame-buffer-impl.h

   1 #ifndef DALI_INTERNAL_FRAME_BUFFER_H
   2 #define DALI_INTERNAL_FRAME_BUFFER_H
   3
   4 /*
   5  * Copyright (c) 2020 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 // INTERNAL INCLUDES
  22 #include <dali/public-api/common/dali-common.h> // DALI_ASSERT_ALWAYS
  23 #include <dali/public-api/common/intrusive-ptr.h> // Dali::IntrusivePtr
  24 #include <dali/public-api/object/base-object.h>
  25 #include <dali/public-api/rendering/frame-buffer.h>
  26 #include <dali/devel-api/rendering/frame-buffer-devel.h>
  27 #include <dali/internal/event/common/event-thread-services.h>
  28 #include <dali/internal/event/rendering/texture-impl.h>
  29
  30 namespace Dali
  31 {
  32 using Mask = Dali::FrameBuffer::Attachment::Mask;
  33
  34 namespace Internal
  35 {
  36 namespace Render
  37 {
  38 class FrameBuffer;
  39 }
  40
  41 class FrameBuffer;
  42 typedef IntrusivePtr<FrameBuffer> FrameBufferPtr;
  43
  44 class FrameBuffer : public BaseObject
  45 {
  46 public:
  47
  48   using Mask = Dali::FrameBuffer::Attachment::Mask;
  49
  50   /**
  51    * @brief Create a new FrameBuffer
  52    *
  53    * @param[in] width       The width of the FrameBuffer
  54    * @param[in] height      The height of the FrameBuffer
  55    * @param[in] attachments The attachments comprising the format of the FrameBuffer (bit-mask)
  56    * @return A smart-pointer to the newly allocated Texture.
  57    */
  58   static FrameBufferPtr New( uint32_t width, uint32_t height, Mask attachments );
  59
  60   /**
  61    * A reference counted object may only be deleted by calling Unreference()
  62    */
  63   virtual ~FrameBuffer();
  64
  65   /**
  66    * @brief Get the FrameBuffer render object
  67    *
  68    * @return the FrameBuffer render object
  69    */
  70   Render::FrameBuffer* GetRenderObject() const;
  71
  72   /**
  73    * @copydoc Dali::FrameBuffer::AttachColorTexture()
  74    */
  75   void AttachColorTexture( TexturePtr texture, uint32_t mipmapLevel, uint32_t layer );
  76
  77   /**
  78    * @copydoc Dali::FrameBuffer::GetColorTexture()
  79    */
  80   Texture* GetColorTexture(uint8_t index) const;
  81
  82   /**
  83    * @brief Sets the frame buffer size.
  84    * @param[in] width The width size
  85    * @param[in] height The height size
  86    */
  87   void SetSize( uint32_t width, uint32_t height );
  88
  89 private: // implementation
  90
  91   /**
  92    * Constructor
  93    * @param[in] width       The width of the FrameBuffer
  94    * @param[in] height      The height of the FrameBuffer
  95    * @param[in] attachments The attachments comprising the format of the FrameBuffer (bit-mask)
  96    */
  97   FrameBuffer( uint32_t width, uint32_t height, Mask attachments );
  98
  99   /**
 100    * Second stage initialization of the Texture
 101    */
 102   void Initialize();
 103
 104 protected:
 105
 106 private: // unimplemented methods
 107
 108   FrameBuffer() = delete;
 109   FrameBuffer( const FrameBuffer& ) = delete;
 110   FrameBuffer& operator=( const FrameBuffer& ) = delete;
 111
 112 private: // data
 113
 114   Internal::EventThreadServices& mEventThreadServices; ///< Used to send messages to the render thread via update thread
 115   Internal::Render::FrameBuffer* mRenderObject;        ///< The Render::Texture associated to this texture
 116
 117   TexturePtr mColor[ Dali::DevelFrameBuffer::MAX_COLOR_ATTACHMENTS ];
 118   uint32_t mWidth;
 119   uint32_t mHeight;
 120   Mask mAttachments;                           ///< Bit-mask of type FrameBuffer::Attachment::Mask
 121   uint8_t mColorAttachmentCount;
 122 };
 123
 124 } // namespace Internal
 125
 126 // Helpers for public-api forwarding methods
 127 inline Internal::FrameBuffer& GetImplementation(Dali::FrameBuffer& handle)
 128 {
 129   DALI_ASSERT_ALWAYS(handle && "FrameBuffer handle is empty");
 130
 131   BaseObject& object = handle.GetBaseObject();
 132
 133   return static_cast<Internal::FrameBuffer&>(object);
 134 }
 135
 136 inline const Internal::FrameBuffer& GetImplementation(const Dali::FrameBuffer& handle)
 137 {
 138   DALI_ASSERT_ALWAYS(handle && "FrameBuffer handle is empty");
 139
 140   const BaseObject& object = handle.GetBaseObject();
 141
 142   return static_cast<const Internal::FrameBuffer&>(object);
 143 }
 144
 145 } // namespace Dali
 146
 147 #endif // DALI_INTERNAL_FRAME_BUFFER_H