1 #ifndef DALI_INTERNAL_SCENE_GRAPH_SCENE_H
2 #define DALI_INTERNAL_SCENE_GRAPH_SCENE_H
5 * Copyright (c) 2020 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.
21 #include <dali/integration-api/scene.h>
22 #include <dali/internal/common/message.h>
23 #include <dali/internal/event/common/event-thread-services.h>
24 #include <dali/internal/render/common/render-instruction-container.h>
25 #include <dali/public-api/common/vector-wrapper.h>
37 class RenderInstructionContainer;
45 * @param[in] surface The render surface
55 * Creates a scene object in the GPU.
56 * @param[in] context The GL context
58 void Initialize( Context& context );
61 * Gets the context holding the GL state of rendering for the scene
64 Context* GetContext();
67 * Gets the render instructions for the scene
68 * @return the render instructions
70 RenderInstructionContainer& GetRenderInstructions();
73 * @brief Adds a callback that is called when the frame rendering is done by the graphics driver.
75 * @param[in] callback The function to call
76 * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
78 * @note A callback of the following type may be used:
80 * void MyFunction( int frameId );
82 * This callback will be deleted once it is called.
84 * @note Ownership of the callback is passed onto this class.
86 void AddFrameRenderedCallback( CallbackBase* callback, int32_t frameId );
89 * @brief Adds a callback that is called when the frame is displayed on the display.
91 * @param[in] callback The function to call
92 * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
94 * @note A callback of the following type may be used:
96 * void MyFunction( int frameId );
98 * This callback will be deleted once it is called.
100 * @note Ownership of the callback is passed onto this class.
102 void AddFramePresentedCallback( CallbackBase* callback, int32_t frameId );
105 * @brief Gets the callback list that is called when the frame rendering is done by the graphics driver.
107 * @param[out] callbacks The callback list
109 void GetFrameRenderedCallback( Dali::Integration::Scene::FrameCallbackContainer& callbacks );
112 * @brief Gets the callback list that is called when the frame is displayed on the display.
114 * @param[out] callbacks The callback list
116 void GetFramePresentedCallback( Dali::Integration::Scene::FrameCallbackContainer& callbacks );
119 * @brief Sets whether rendering should be skipped or not.
120 * @param[in] skip true if rendering should be skipped.
122 void SetSkipRendering( bool skip );
125 * @brief Query whether rendering should be skipped or not.
126 * @return true if rendering should be skipped, false otherwise.
128 bool IsRenderingSkipped() const;
131 * Set the surface rectangle when surface is resized.
133 * @param[in] scene The resized scene.
134 * @param[in] rect The retangle representing the surface.
136 void SetSurfaceRect( const Rect<int32_t>& rect );
139 * Get the surface rectangle.
141 * @return the current surface rectangle
143 const Rect<int32_t>& GetSurfaceRect() const;
146 * Set the surface orientation when surface is rotated.
148 * @param[in] scene The rotated scene.
149 * @param[in] orientation The orientation value representing the surface.
151 void SetSurfaceOrientation( int32_t orientation );
154 * Get the surface orientation.
156 * @return the current surface orientation
158 int32_t GetSurfaceOrientation() const;
161 * Query wheter the surface rect is changed or not.
162 * @return true if the surface rect is changed.
164 bool IsSurfaceRectChanged();
168 Context* mContext; ///< The context holding the GL state of rendering for the scene, not owned
170 // Render instructions describe what should be rendered during RenderManager::RenderScene()
171 // Update manager updates instructions for the next frame while we render the current one
173 RenderInstructionContainer mInstructions; ///< Render instructions for the scene
175 Dali::Integration::Scene::FrameCallbackContainer mFrameRenderedCallbacks; ///< Frame rendered callbacks
176 Dali::Integration::Scene::FrameCallbackContainer mFramePresentedCallbacks; ///< Frame presented callbacks
178 bool mSkipRendering; ///< A flag to skip rendering
180 Rect<int32_t> mSurfaceRect; ///< The rectangle of surface which is related ot this scene.
181 int32_t mSurfaceOrientation; ///< The orientation of surface which is related of this scene
182 bool mSurfaceRectChanged; ///< The flag of surface's rectangle is changed when is resized, moved or rotated.
186 inline void AddFrameRenderedCallbackMessage( EventThreadServices& eventThreadServices, const Scene& scene, const CallbackBase* callback, int32_t frameId )
188 using LocalType = MessageValue2<Scene, CallbackBase*, int32_t>;
190 // Reserve some memory inside the message queue
191 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
193 // Construct message in the message queue memory; note that delete should not be called on the return value
194 new (slot) LocalType( &scene, &Scene::AddFrameRenderedCallback, const_cast< CallbackBase* >( callback ), frameId );
197 inline void AddFramePresentedCallbackMessage( EventThreadServices& eventThreadServices, const Scene& scene, const CallbackBase* callback, int32_t frameId )
199 using LocalType = MessageValue2<Scene, CallbackBase*, int32_t>;
201 // Reserve some memory inside the message queue
202 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
204 // Construct message in the message queue memory; note that delete should not be called on the return value
205 new (slot) LocalType( &scene, &Scene::AddFramePresentedCallback, const_cast< CallbackBase* >( callback ), frameId );
208 inline void SetSurfaceRectMessage( EventThreadServices& eventThreadServices, const Scene& scene, const Rect<int32_t>& rect )
210 using LocalType = MessageValue1<Scene, Rect<int32_t> >;
212 // Reserve some memory inside the message queue
213 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
215 // Construct message in the message queue memory; note that delete should not be called on the return value
216 new (slot) LocalType( &scene, &Scene::SetSurfaceRect, rect );
219 inline void SetSurfaceOrientationMessage( EventThreadServices& eventThreadServices, const Scene& scene, int32_t orientation )
221 using LocalType = MessageValue1<Scene, int32_t>;
223 // Reserve some memory inside the message queue
224 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
226 // Construct message in the message queue memory; note that delete should not be called on the return value
227 new (slot) LocalType( &scene, &Scene::SetSurfaceOrientation, orientation );
230 } // namespace SceneGraph
232 } // namespace Internal
237 #endif // DALI_INTERNAL_SCENE_GRAPH_SCENE_H