Added pre-render callback to Adaptor

[platform/core/uifw/dali-adaptor.git] / dali / integration-api / adaptor.h

diff --git a/dali/integration-api/adaptor.h b/dali/integration-api/adaptor.h
index 6ce71a3..0925028 100755 (executable)
--- a/dali/integration-api/adaptor.h
+++ b/dali/integration-api/adaptor.h
@@ -257,6 +257,23 @@ public:
   void SetRenderRefreshRate( unsigned int numberOfVSyncsPerRender );
 
   /**
+   * @brief The callback is called from the Update/Render thread prior to rendering.
+   *
+   * @param[in] callback The function to call
+   *
+   * @note The function is called from the Update thread, so should do as little processing as possible.
+   * It is not possible to call any DALi event side APIs from within the callback; doing so will cause
+   * instability. Only 1 callback is supported. Setting the callback to NULL will remove the current callback.
+   *
+   * A callback of the following type should be used:
+   * @code
+   *   bool MyFunction();
+   * @endcode
+   * This callback will be called repeatedly as long as it returns true. A return of 0 deletes this callback.
+   */
+  void SetPreRenderCallback( CallbackBase* callback );
+
+  /**
    * @brief Set whether the frame count per render is managed using the hardware VSync or
    * manually timed.
    *