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

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