1 #ifndef DALI_RENDER_SURFACE_H
2 #define DALI_RENDER_SURFACE_H
5 * Copyright (c) 2019 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/math/rect.h>
23 #include <dali/public-api/math/vector4.h>
24 #include <dali/public-api/object/any.h>
25 #include <dali/public-api/common/view-mode.h>
26 #include <dali/integration-api/core-enumerations.h>
31 class DisplayConnection;
32 class ThreadSynchronizationInterface;
40 class GraphicsInterface;
42 } // namespace Adaptor
44 } // namespace Internal
47 * @brief The position and size of the render surface.
49 typedef Dali::Rect<int> PositionSize;
52 * @brief The Rect of partial updated area
54 typedef Dali::Rect<int32_t> DamagedRect;
63 * @brief Interface for a render surface onto which Dali draws.
65 * Dali::Adaptor requires a render surface to draw on to. This is
66 * usually a window in the native windowing system, or some other
67 * mapped pixel buffer.
69 * Dali::Application will automatically create a render surface using a window.
71 * The implementation of the factory method below should choose an appropriate
72 * implementation of RenderSurface for the given platform
75 class DALI_CORE_API RenderSurface
81 WINDOW_RENDER_SURFACE,
82 PIXMAP_RENDER_SURFACE,
88 * Inlined as this is a pure abstract interface
93 * @brief Virtual Destructor.
94 * Inlined as this is a pure abstract interface
96 virtual ~RenderSurface() {}
99 * @brief Return the size and position of the surface.
100 * @return The position and size
102 virtual PositionSize GetPositionSize() const = 0;
106 * @param[out] dpiHorizontal set to the horizontal dpi
107 * @param[out] dpiVertical set to the vertical dpi
109 virtual void GetDpi( unsigned int& dpiHorizontal, unsigned int& dpiVertical ) = 0;
112 * @brief Return the orientation of the surface.
113 * @return The orientation
115 virtual int GetOrientation() const = 0;
118 * @brief InitializeGraphics the platform specific graphics surface interfaces
120 virtual void InitializeGraphics() = 0;
123 * @brief Creates the Surface
125 virtual void CreateSurface() = 0;
128 * @brief Destroys the Surface
130 virtual void DestroySurface() = 0;
133 * @brief Replace the Surface
134 * @return true if context was lost
136 virtual bool ReplaceGraphicsSurface() = 0;
139 * @brief Resizes the underlying surface.
140 * @param[in] The dimensions of the new position
142 virtual void MoveResize( Dali::PositionSize positionSize ) = 0;
145 * @brief Called when Render thread has started
147 virtual void StartRender() = 0;
150 * @brief Invoked by render thread before Core::Render
151 * If the operation fails, then Core::Render should not be called until there is
152 * a surface to render onto.
153 * @param[in] resizingSurface True if the surface is being resized
154 * @return True if the operation is successful, False if the operation failed
156 virtual bool PreRender( bool resizingSurface ) = 0;
159 * @brief Invoked by render thread after Core::Render
160 * @param[in] renderToFbo True if render to FBO.
161 * @param[in] replacingSurface True if the surface is being replaced.
162 * @param[in] resizingSurface True if the surface is being resized.
164 virtual void PostRender( bool renderToFbo, bool replacingSurface, bool resizingSurface ) = 0;
167 * @brief Invoked by render thread when the thread should be stop
169 virtual void StopRender() = 0;
172 * @brief Invoked by Event Thread when the compositor lock should be released and rendering should resume.
174 virtual void ReleaseLock() = 0;
177 * @brief Gets the surface type
179 virtual RenderSurface::Type GetSurfaceType() = 0;
182 * @brief Makes the graphics context current
184 virtual void MakeContextCurrent() = 0;
187 * @brief Gets whether the depth buffer is required
188 * @return TRUE if the depth buffer is required
190 virtual Integration::DepthBufferAvailable GetDepthBufferRequired() = 0;
193 * @brief Gets whether the stencil buffer is required
194 * @return TRUE if the stencil buffer is required
196 virtual Integration::StencilBufferAvailable GetStencilBufferRequired() = 0;
199 * @brief Sets currentframe updated/damaged rects
200 * @return The Rect of partial updated area
202 virtual void SetDamagedRect( const DamagedRect& damagedRect, DamagedRect& mergedRect ) = 0;
205 * @brief Gets buffer age
206 * @return current buffer age
208 virtual int32_t GetBufferAge() = 0;
213 * @brief Undefined copy constructor. RenderSurface cannot be copied
215 RenderSurface( const RenderSurface& rhs ) = delete;
218 * @brief Undefined assignment operator. RenderSurface cannot be copied
220 RenderSurface& operator=( const RenderSurface& rhs ) = delete;
223 } // namespace Integration
227 #endif // DALI_RENDER_SURFACE_H