[Tizen] Add OffscreenApplication
[platform/core/uifw/dali-adaptor.git] / dali / devel-api / adaptor-framework / offscreen-window.h
index 042279e..bb279cb 100644 (file)
  *
  */
 
-/**
- * @addtogroup dali_adaptor_framework
- * @{
- */
-
+// EXTERNAL INCLUDES
 #include <memory>
 #include <dali/public-api/actors/actor.h>
 #include <dali/public-api/math/uint-16-pair.h>
 namespace Dali
 {
 
+/**
+ * @addtogroup dali_adaptor_framework
+ * @{
+ */
+
 class Layer;
 
 namespace Internal
@@ -47,7 +48,7 @@ class DALI_IMPORT_API OffscreenWindow : public Dali::BaseHandle
 public:
 
   typedef Uint16Pair WindowSize;
-  typedef Signal<void (OffscreenWindow, Dali::Any)> PostRenderSignalType;
+  typedef Signal<void (OffscreenWindow, Any)> PostRenderSignalType;
 
 public:
 
@@ -55,22 +56,20 @@ public:
    * @brief Creates an initialized handle to a new OffscreenWindow
    * @note You should hold the returned handle. If you missed the handle, the OffscreenWindow will be released
    *
-   * @param[in] offscreenApplication The OffscreenApplication handle
    * @param[in] width The initial width of the OffscreenWindow
    * @param[in] height The initial height of the OffscreenWindow
    * @param[in] isTranslucent Whether the OffscreenWindow is translucent or not
    */
-  static OffscreenWindow New( OffscreenApplication offscreenApplication, uint16_t width, uint16_t height, bool isTranslucent );
+  static OffscreenWindow New( uint16_t width, uint16_t height, bool isTranslucent );
 
   /**
    * @brief Creates an initialized handle to a new OffscreenWindow
    * @note You should hold the returned handle. If you missed the handle, the OffscreenWindow will be released
    *
-   * @param[in] offscreenApplication The OffscreenApplication handle
    * @param[in] surface The native surface handle of your platform
    * @param[in] isTranslucent Whether the OffscreenWindow is translucent or not
    */
-  static OffscreenWindow New( OffscreenApplication offscreenApplication, Dali::Any surface, bool isTranslucent );
+  static OffscreenWindow New( Any surface, bool isTranslucent );
 
   /**
    * @brief Constructs an empty handle
@@ -163,7 +162,20 @@ public:
    */
   WindowSize GetSize() const;
 
+  /**
+   * @brief Gets the native handle.
+   * @note When users call this function, it wraps the actual type used by the underlying system.
+   * @return The native handle or an empty handle
+   */
+  Any GetNativeHandle() const;
+
 public:  // Signals
+
+  /**
+   * @brief This signal is emitted when the OffscreenWindow is rendered.
+   *
+   * @return The signal
+   */
   PostRenderSignalType& PostRenderSignal();
 
 public: // Not intended for application developers