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
  27 class FrameCallbackInterface;
  28
  29 namespace DevelStage
  30 {
  31
  32 /**
  33  * @brief The DALi rendering behavior.
  34  */
  35 enum class Rendering
  36 {
  37   IF_REQUIRED,  ///< Default. Will only render if required to do so.
  38   CONTINUOUSLY, ///< Will render continuously.
  39 };
  40
  41 using KeyEventGeneratedSignalType = Signal<bool( const KeyEvent& )>; ///< Stage key event generated signal type
  42
  43 /**
  44  * @brief The user would connect to this signal to get a KeyEvent when KeyEvent is generated.
  45  *
  46  * @param[in] stage The stage to emit a signal
  47  * @return The return is true if KeyEvent is consumed, otherwise false.
  48  */
  49 DALI_CORE_API KeyEventGeneratedSignalType& KeyEventGeneratedSignal( Dali::Stage stage );
  50
  51 /**
  52  * @brief Gives the user the ability to set the rendering behavior of DALi.
  53  *
  54  * @param[in] stage The stage
  55  * @param[in] renderingBehavior The rendering behavior required.
  56  *
  57  * @note By default, DALi uses Rendering::IF_REQUIRED.
  58  * @see Rendering
  59  */
  60 DALI_CORE_API void SetRenderingBehavior( Dali::Stage stage, Rendering renderingBehavior );
  61
  62 /**
  63  * @brief Retrieves the rendering behavior of DALi.
  64  *
  65  * @param[in] stage The stage
  66  * @return The rendering behavior of DALi.
  67  */
  68 DALI_CORE_API Rendering GetRenderingBehavior( Dali::Stage stage );
  69
  70 /*
  71  * @brief The FrameCallbackInterface implementation added gets called on every frame from the update-thread.
  72  *
  73  * @param[in] stage The stage to set the FrameCallbackInterface implementation on
  74  * @param[in] frameCallback An implementation of the FrameCallbackInterface
  75  * @param[in] rootActor The root-actor in the scene that the callback applies to
  76  *
  77  * @note The frameCallback cannot be added more than once. This will assert if that is attempted.
  78  * @note Only the rootActor and it's children will be parsed by the UpdateProxy.
  79  * @note If the rootActor is destroyed, then the callback is automatically removed
  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 } // namespace DevelStage
  96
  97 } // namespace Dali
  98
  99 #endif // DALI_STAGE_DEVEL_H