1 #ifndef DALI_RENDER_SURFACE_INTERFACE_H
2 #define DALI_RENDER_SURFACE_INTERFACE_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/integration-api/render-surface.h>
23 #include <dali/integration-api/core-enumerations.h>
24 #include <dali/public-api/math/vector4.h>
31 class DisplayConnection;
32 class ThreadSynchronizationInterface;
38 class AdaptorInternalServices;
39 class GraphicsInterface;
44 * @brief Interface for a render surface onto which Dali draws.
46 * Dali::Adaptor requires a render surface to draw on to. This is
47 * usually a window in the native windowing system, or some other
48 * mapped pixel buffer.
50 * Dali::Application will automatically create a render surface using a window.
52 * The implementation of the factory method below should choose an appropriate
53 * implementation of RenderSurface for the given platform
56 class RenderSurfaceInterface : public Dali::Integration::RenderSurface
62 * Inlined as this is a pure abstract interface
64 RenderSurfaceInterface()
65 : mAdaptor( nullptr ),
67 mDisplayConnection( nullptr ),
68 mDepthBufferRequired( Integration::DepthBufferAvailable::FALSE ),
69 mStencilBufferRequired( Integration::StencilBufferAvailable::FALSE )
73 * @brief Virtual Destructor.
74 * Inlined as this is a pure abstract interface
76 virtual ~RenderSurfaceInterface() {}
79 * @brief Return the size and position of the surface.
80 * @return The position and size
82 virtual Dali::PositionSize GetPositionSize() const = 0;
86 * @param[out] dpiHorizontal set to the horizontal dpi
87 * @param[out] dpiVertical set to the vertical dpi
89 virtual void GetDpi( unsigned int& dpiHorizontal, unsigned int& dpiVertical ) = 0;
92 * @brief InitializeGraphics the platform specific graphics surface interfaces
94 virtual void InitializeGraphics() = 0;
97 * @brief Creates the Surface
99 virtual void CreateSurface() = 0;
102 * @brief Destroys the Surface
104 virtual void DestroySurface() = 0;
107 * @brief Replace the Surface
108 * @return true if context was lost
110 virtual bool ReplaceGraphicsSurface() = 0;
113 * @brief Resizes the underlying surface.
114 * @param[in] The dimensions of the new position
116 virtual void MoveResize( Dali::PositionSize positionSize ) = 0;
119 * @brief Called when Render thread has started
121 virtual void StartRender() = 0;
124 * @brief Invoked by render thread before Core::Render
125 * If the operation fails, then Core::Render should not be called until there is
126 * a surface to render onto.
127 * @param[in] resizingSurface True if the surface is being resized
128 * @return True if the operation is successful, False if the operation failed
130 virtual bool PreRender( bool resizingSurface ) = 0;
133 * @brief Invoked by render thread after Core::Render
134 * @param[in] renderToFbo True if render to FBO.
135 * @param[in] replacingSurface True if the surface is being replaced.
136 * @param[in] resizingSurface True if the surface is being resized.
138 virtual void PostRender( bool renderToFbo, bool replacingSurface, bool resizingSurface ) = 0;
140 * @brief Invoked by render thread when the thread should be stop
142 virtual void StopRender() = 0;
145 * @brief Invoked by Event Thread when the compositor lock should be released and rendering should resume.
147 virtual void ReleaseLock() = 0;
150 * @brief Sets the ThreadSynchronizationInterface
152 * @param threadSynchronization The thread-synchronization implementation.
154 virtual void SetThreadSynchronization( ThreadSynchronizationInterface& threadSynchronization ) = 0;
157 * @brief Gets the surface type
159 virtual Dali::Integration::RenderSurface::Type GetSurfaceType() = 0;
162 * @brief Makes the graphics context current
164 virtual void MakeContextCurrent() = 0;
167 * @brief Get whether the depth buffer is required
168 * @return TRUE if the depth buffer is required
170 virtual Integration::DepthBufferAvailable GetDepthBufferRequired() = 0;
173 * @brief Get whether the stencil buffer is required
174 * @return TRUE if the stencil buffer is required
176 virtual Integration::StencilBufferAvailable GetStencilBufferRequired() = 0;
180 void SetAdaptor( Dali::Internal::Adaptor::AdaptorInternalServices& adaptor )
185 void SetGraphicsInterface( Dali::Internal::Adaptor::GraphicsInterface& graphics )
187 mGraphics = &graphics;
190 void SetDisplayConnection( Dali::DisplayConnection& displayConnection )
192 mDisplayConnection = &displayConnection;
198 * @brief Undefined copy constructor. RenderSurface cannot be copied
200 RenderSurfaceInterface( const RenderSurfaceInterface& rhs );
203 * @brief Undefined assignment operator. RenderSurface cannot be copied
205 RenderSurfaceInterface& operator=( const RenderSurfaceInterface& rhs );
209 Dali::Internal::Adaptor::AdaptorInternalServices* mAdaptor;
210 Dali::Internal::Adaptor::GraphicsInterface* mGraphics;
211 Dali::DisplayConnection* mDisplayConnection;
215 Integration::DepthBufferAvailable mDepthBufferRequired; ///< Whether the depth buffer is required
216 Integration::StencilBufferAvailable mStencilBufferRequired; ///< Whether the stencil buffer is required
218 Vector4 mBackgroundColor; ///< The background color of the surface
223 #endif // DALI_RENDER_SURFACE_INTERFACE_H