dali/internal/event/common/event-thread-services.h

   1 #ifndef DALI_INTERNAL_EVENT_THREAD_SERVICES_H
   2 #define DALI_INTERNAL_EVENT_THREAD_SERVICES_H
   3
   4 /*
   5  * Copyright (c) 2019 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <cstddef>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/internal/common/buffer-index.h>
  26
  27 namespace Dali
  28 {
  29
  30 class BaseObject;
  31
  32 namespace Integration
  33 {
  34 class RenderController;
  35 }
  36
  37 namespace Internal
  38 {
  39
  40 namespace SceneGraph
  41 {
  42 class UpdateManager;
  43 }
  44
  45 /**
  46  * Abstract interface of services for event-thread objects.
  47  * Used for registering objects, queueing messages during the event-thread for the next update.
  48  * Allows the event-thread to read double-buffered property values.
  49  */
  50 class EventThreadServices
  51 {
  52 public:
  53
  54   /**
  55    * Virtual destructor
  56    */
  57   virtual ~EventThreadServices()
  58   { }
  59
  60   /**
  61    * Get the EventThreadServices
  62    * @return reference to the EventThreadServices
  63    */
  64   static EventThreadServices& Get();
  65
  66   /**
  67    * @brief Registers the object as created with the Object registry.
  68    *
  69    * @param[in] object to register
  70    */
  71   virtual void RegisterObject( BaseObject* object) = 0;
  72
  73   /**
  74    * @brief Unregisters the object from Object registry.
  75    *
  76    * @param[in] object to unregister
  77    */
  78   virtual void UnregisterObject( BaseObject* object) = 0;
  79
  80   /**
  81    * @brief Get a reference to the UpdateManager
  82    *
  83    * @return the update manager
  84    */
  85   virtual SceneGraph::UpdateManager& GetUpdateManager() = 0;
  86
  87   /**
  88    * @brief Get a reference to the RenderController
  89    *
  90    * @return the render controller
  91    */
  92   virtual Integration::RenderController& GetRenderController() = 0;
  93
  94   /**
  95    * Reserve space for another message in the queue; this must then be initialized by the caller.
  96    * The message will be read from the update-thread after the next FlushMessages is called.
  97    * @post Calling this method may invalidate any previously returned slots.
  98    * @param[in] size The message size with respect to the size of type "char".
  99    * @param[in] updateScene A flag, when true denotes that the message will cause the scene-graph node tree to require an update.
 100    * @return A pointer to the first char allocated for the message.
 101    */
 102   virtual uint32_t* ReserveMessageSlot( uint32_t size, bool updateScene = true ) = 0;
 103
 104   /**
 105    * @return the current event-buffer index.
 106    */
 107   virtual BufferIndex GetEventBufferIndex() const  = 0;
 108
 109   /**
 110    * @brief Indicate that the next rendering is really required.
 111    */
 112   virtual void ForceNextUpdate() = 0;
 113
 114   /**
 115    * @brief Check if the next rendering is really required.
 116    *
 117    * @return true if the next rendering is really required.
 118    */
 119   virtual bool IsNextUpdateForced() = 0;
 120
 121   /**
 122    * @return true if core is still running and we can send messages
 123    */
 124   static bool IsCoreRunning();
 125 };
 126
 127 } // namespace Internal
 128
 129 } // namespace Dali
 130
 131 #endif // DALI_INTERNAL_EVENT_THREAD_SERVICES_H