dali/devel-api/common/stage-devel.h

   1 #ifndef DALI_STAGE_DEVEL_H
   2 #define DALI_STAGE_DEVEL_H
   3
   4 /*
   5  * Copyright (c) 2024 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 // INTERNAL INCLUDES
  22 #include <dali/devel-api/common/stage.h>
  23 #include <dali/devel-api/update/update-proxy.h>
  24
  25 namespace Dali
  26 {
  27 class FrameCallbackInterface;
  28
  29 namespace DevelStage
  30 {
  31 /**
  32  * @brief The DALi rendering behavior.
  33  */
  34 enum class Rendering
  35 {
  36   IF_REQUIRED,  ///< Default. Will only render if required to do so.
  37   CONTINUOUSLY, ///< Will render continuously.
  38 };
  39
  40 using KeyEventGeneratedSignalType = Signal<bool(const KeyEvent&)>; ///< Stage key event generated signal type
  41
  42 /**
  43  * @brief The user would connect to this signal to get a KeyEvent when KeyEvent is generated.
  44  *
  45  * @param[in] stage The stage to emit a signal
  46  * @return The return is true if KeyEvent is consumed, otherwise false.
  47  */
  48 DALI_CORE_API KeyEventGeneratedSignalType& KeyEventGeneratedSignal(Dali::Stage stage);
  49
  50 /**
  51  * @brief Gives the user the ability to set the rendering behavior of DALi.
  52  *
  53  * @param[in] stage The stage
  54  * @param[in] renderingBehavior The rendering behavior required.
  55  *
  56  * @note By default, DALi uses Rendering::IF_REQUIRED.
  57  * @see Rendering
  58  */
  59 DALI_CORE_API void SetRenderingBehavior(Dali::Stage stage, Rendering renderingBehavior);
  60
  61 /**
  62  * @brief Retrieves the rendering behavior of DALi.
  63  *
  64  * @param[in] stage The stage
  65  * @return The rendering behavior of DALi.
  66  */
  67 DALI_CORE_API Rendering GetRenderingBehavior(Dali::Stage stage);
  68
  69 /*
  70  * @brief The FrameCallbackInterface implementation added gets called on every frame from the update-thread.
  71  *
  72  * @param[in] stage The stage to set the FrameCallbackInterface implementation on
  73  * @param[in] frameCallback An implementation of the FrameCallbackInterface
  74  * @param[in] rootActor The root-actor in the scene that the callback applies to. Or empty handle if we don't care whether the node is scene on or not.
  75  *
  76  * @note The frameCallback cannot be added more than once. This will assert if that is attempted.
  77  * @note Only the rootActor and it's children will be parsed by the UpdateProxy.
  78  * @note If the rootActor is destroyed, then the callback is automatically removed.
  79  * @note If the rootActor is empty handle, given frameCallback will not be removed automatically.
  80  * @see FrameCallbackInterface
  81  */
  82 DALI_CORE_API void AddFrameCallback(Dali::Stage stage, FrameCallbackInterface& frameCallback, Actor rootActor);
  83
  84 /**
  85  * @brief Removes the specified FrameCallbackInterface implementation from being called on every frame.
  86  *
  87  * @param[in] stage The stage to clear the FrameCallbackInterface on
  88  * @param[in] frameCallback The FrameCallbackInterface implementation to remove
  89  *
  90  * @note This function will block if the FrameCallbackInterface::Update method is being processed in the update-thread.
  91  * @note If the callback implementation has already been removed, then this is a no-op.
  92  */
  93 DALI_CORE_API void RemoveFrameCallback(Dali::Stage stage, FrameCallbackInterface& frameCallback);
  94
  95 /**
  96  * @brief Notify the frame callback that there is a new sync point.
  97  *
  98  * The sync point can be matched during a subsequent frameCallback::Update().
  99  *
 100  * @param[in] stage The stage to clear the FrameCallbackInterface on
 101  * @param[in] frameCallback The FrameCallbackInterface implementation to notify
 102  *
 103  * @return NotifySyncPoint - a unique sync value that will also be sent to the
 104  * UpdateProxy prior to FrameCallback::Update() being called from the update thread.
 105  */
 106 DALI_CORE_API UpdateProxy::NotifySyncPoint NotifyFrameCallback(Dali::Stage stage, FrameCallbackInterface& frameCallback);
 107
 108 } // namespace DevelStage
 109
 110 } // namespace Dali
 111
 112 #endif // DALI_STAGE_DEVEL_H