1 #ifndef DALI_INTERNAL_FRAME_BUFFER_H
2 #define DALI_INTERNAL_FRAME_BUFFER_H
5 * Copyright (c) 2016 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.
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/internal/event/common/event-thread-services.h>
27 #include <dali/internal/event/rendering/texture-impl.h>
39 typedef IntrusivePtr<FrameBuffer> FrameBufferPtr;
41 class FrameBuffer : public BaseObject
46 * @brief Create a new FrameBuffer
48 * @param[in] width The width of the FrameBuffer
49 * @param[in] height The height of the FrameBuffer
50 * @param[in] attachments The attachments comprising the format of the FrameBuffer (bit-mask)
51 * @return A smart-pointer to the newly allocated Texture.
53 static FrameBufferPtr New( unsigned int width, unsigned int height, unsigned int attachments );
56 * @brief Get the FrameBuffer render object
58 * @return the FrameBuffer render object
60 Render::FrameBuffer* GetRenderObject() const;
63 * @copydoc Dali::FrameBuffer::AttachColorTexture()
65 void AttachColorTexture( TexturePtr texture, unsigned int mipmapLevel, unsigned int layer );
68 * @copydoc Dali::FrameBuffer::GetColorTexture()
70 Texture* GetColorTexture();
72 private: // implementation
76 * @param[in] width The width of the FrameBuffer
77 * @param[in] height The height of the FrameBuffer
78 * @param[in] attachments The attachments comprising the format of the FrameBuffer (bit-mask)
80 FrameBuffer( unsigned int width, unsigned int height, unsigned int attachments );
83 * Second stage initialization of the Texture
90 * A reference counted object may only be deleted by calling Unreference()
92 virtual ~FrameBuffer();
94 private: // unimplemented methods
95 FrameBuffer( const FrameBuffer& );
96 FrameBuffer& operator=( const FrameBuffer& );
100 Internal::EventThreadServices& mEventThreadServices; ///< Used to send messages to the render thread via update thread
101 Internal::Render::FrameBuffer* mRenderObject; ///< The Render::Texture associated to this texture
105 unsigned int mHeight;
106 unsigned int mAttachments; ///< Bit-mask of type FrameBuffer::Attachment::Mask
110 } // namespace Internal
112 // Helpers for public-api forwarding methods
113 inline Internal::FrameBuffer& GetImplementation(Dali::FrameBuffer& handle)
115 DALI_ASSERT_ALWAYS(handle && "FrameBuffer handle is empty");
117 BaseObject& object = handle.GetBaseObject();
119 return static_cast<Internal::FrameBuffer&>(object);
122 inline const Internal::FrameBuffer& GetImplementation(const Dali::FrameBuffer& handle)
124 DALI_ASSERT_ALWAYS(handle && "FrameBuffer handle is empty");
126 const BaseObject& object = handle.GetBaseObject();
128 return static_cast<const Internal::FrameBuffer&>(object);
133 #endif // DALI_INTERNAL_FRAME_BUFFER_H