1 #ifndef DALI_RENDER_SURFACE_H
2 #define DALI_RENDER_SURFACE_H
5 * Copyright (c) 2018 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/object/any.h>
24 #include <dali/public-api/common/view-mode.h>
27 #include <dali/public-api/dali-adaptor-common.h>
33 class DisplayConnection;
34 class ThreadSynchronizationInterface;
42 class GraphicsInterface;
44 } // namespace Adaptor
46 } // namespace Internal
53 } // namespace Integration
56 * @brief The position and size of the render surface.
58 typedef Dali::Rect<int> PositionSize;
61 * @brief Interface for a render surface onto which Dali draws.
63 * Dali::Adaptor requires a render surface to draw on to. This is
64 * usually a window in the native windowing system, or some other
65 * mapped pixel buffer.
67 * Dali::Application will automatically create a render surface using a window.
69 * The implementation of the factory method below should choose an appropriate
70 * implementation of RenderSurface for the given platform
79 WINDOW_RENDER_SURFACE,
80 PIXMAP_RENDER_SURFACE,
86 * Inlined as this is a pure abstract interface
91 * @brief Virtual Destructor.
92 * Inlined as this is a pure abstract interface
94 virtual ~RenderSurface() {}
97 * @brief Return the size and position of the surface.
98 * @return The position and size
100 virtual PositionSize GetPositionSize() const = 0;
104 * @param[out] dpiHorizontal set to the horizontal dpi
105 * @param[out] dpiVertical set to the vertical dpi
107 virtual void GetDpi( unsigned int& dpiHorizontal, unsigned int& dpiVertical ) = 0;
110 * @brief InitializeGraphics the platform specific graphics surface interfaces
111 * @param[in] graphics The abstracted graphics interface
112 * @param[in] displayConnection The display connection interface
114 virtual void InitializeGraphics( Dali::Internal::Adaptor::GraphicsInterface& graphics, Dali::DisplayConnection& displayConnection ) = 0;
117 * @brief Creates the Surface
119 virtual void CreateSurface() = 0;
122 * @brief Destroys the Surface
124 virtual void DestroySurface() = 0;
127 * @brief Replace the Surface
128 * @return true if context was lost
130 virtual bool ReplaceGraphicsSurface() = 0;
133 * @brief Resizes the underlying surface.
134 * @param[in] The dimensions of the new position
136 virtual void MoveResize( Dali::PositionSize positionSize ) = 0;
139 * @brief Called when Render thread has started
141 virtual void StartRender() = 0;
144 * @brief Invoked by render thread before Core::Render
145 * If the operation fails, then Core::Render should not be called until there is
146 * a surface to render onto.
147 * @param[in] resizingSurface True if the surface is being resized
148 * @return True if the operation is successful, False if the operation failed
150 virtual bool PreRender( bool resizingSurface ) = 0;
153 * @brief Invoked by render thread after Core::Render
154 * @param[in] renderToFbo True if render to FBO.
155 * @param[in] replacingSurface True if the surface is being replaced.
156 * @param[in] resizingSurface True if the surface is being resized.
158 virtual void PostRender( bool renderToFbo, bool replacingSurface, bool resizingSurface ) = 0;
160 * @brief Invoked by render thread when the thread should be stop
162 virtual void StopRender() = 0;
165 * @brief Invoked by Event Thread when the compositor lock should be released and rendering should resume.
167 virtual void ReleaseLock() = 0;
170 * @brief Sets the ThreadSynchronizationInterface
172 * @param threadSynchronization The thread-synchronization implementation.
174 virtual void SetThreadSynchronization( ThreadSynchronizationInterface& threadSynchronization ) = 0;
177 * @brief Gets the surface type
179 virtual RenderSurface::Type GetSurfaceType() = 0;
184 * @brief Undefined copy constructor. RenderSurface cannot be copied
186 RenderSurface( const RenderSurface& rhs );
189 * @brief Undefined assignment operator. RenderSurface cannot be copied
191 RenderSurface& operator=( const RenderSurface& rhs );
196 #endif // DALI_RENDER_SURFACE_H