[3.0] Update doxygen comments

[platform/core/uifw/dali-core.git] / dali / public-api / images / native-image.h

diff --git a/dali/public-api/images/native-image.h b/dali/public-api/images/native-image.h
index 5c1148a..3a28aff 100644 (file)
--- a/dali/public-api/images/native-image.h
+++ b/dali/public-api/images/native-image.h
@@ -25,7 +25,7 @@
 namespace Dali
 {
 /**
- * @addtogroup dali-core-images
+ * @addtogroup dali_core_images
  * @{
  */
 
@@ -35,8 +35,10 @@ class NativeImage;
 }
 
 /**
- * @brief NativeImage represents an image resource that can be added to ImageActors.
- * Its data is provided by native resources, such as shared bitmap memory or pixmap from X11 or ECORE-X11, etc.
+ * @brief NativeImage represents a platform specific image resource.
+ *
+ * Its data is provided by native resources, such as shared bitmap memory or pixmap.
+ * @SINCE_1_0.0
  */
 class DALI_IMPORT_API  NativeImage : public Image
 {
@@ -46,6 +48,7 @@ public:
    * @brief Constructor with creates an uninitialized NativeImage object.
    *
    * Use NativeImage::New(...) to create an initialised object.
+   * @SINCE_1_0.0
    */
   NativeImage();
 
@@ -53,31 +56,35 @@ public:
    * @brief Destructor.
    *
    * This is non-virtual since derived Handle types must not contain data or virtual methods.
+   * @SINCE_1_0.0
    */
    ~NativeImage();
 
    /**
     * @brief This copy constructor is required for (smart) pointer semantics.
     *
-    * @param [in] handle A reference to the copied handle
+    * @SINCE_1_0.0
+    * @param[in] handle A reference to the copied handle
     */
    NativeImage( const NativeImage& handle );
 
   /**
    * @brief This assignment operator is required for (smart) pointer semantics.
    *
-   * @param[in] rhs A reference to the copied handle.
-   * @return A reference to this.
+   * @SINCE_1_0.0
+   * @param[in] rhs A reference to the copied handle
+   * @return A reference to this
    */
   NativeImage& operator=( const NativeImage& rhs );
 
   /**
-   * @brief Trigger asynchronous creation of backing GL texture immediately.
+   * @brief Triggers asynchronous creation of backing GL texture immediately.
    *
    * The normal policy is for a GL texture to created lazily when needed.
    * This function forces the allocation of a texture to happen at the earliest
    * opportunity.
    *
+   * @SINCE_1_0.0
    * @note If the application loses its GL context, native images may lose their
    * GL textures. This function can be called again after context regain to force
    * the creation of the GL texture if still needed.
@@ -85,24 +92,40 @@ public:
   void CreateGlTexture();
 
   /**
-   * @brief Create a new NativeImage, which used native resources.
+   * @brief Creates a new NativeImage, which used native resources.
    *
    * The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE
-   * @param [in] nativeImageInterface An reference to the object of the interface implementation.
-   * @return A handle to a newly allocated object.
+   * @SINCE_1_0.0
+   * @param[in] nativeImageInterface An reference to the object of the interface implementation
+   * @return A handle to a newly allocated object
    */
   static NativeImage New( NativeImageInterface& nativeImageInterface );
 
   /**
-   * @brief Downcast an Object handle to NativeImage handle.
+   * @brief Downcasts a handle to NativeImage handle.
    *
    * If handle points to a NativeImage object, the downcast produces valid handle.
-   * If not, the returned handle is left unintialized.
-   * @param[in] handle Handle to an object.
-   * @return handle to a NativeImage or an uninitialized handle.
+   * If not, the returned handle is left uninitialized.
+   * @SINCE_1_0.0
+   * @param[in] handle Handle to an object
+   * @return handle to a NativeImage or an uninitialized handle
    */
   static NativeImage DownCast( BaseHandle handle );
 
+  /**
+   * @brief Gets custom fragment prefix for rendering a native image.
+   *
+   * @return String for custom fragment prefix
+   */
+  const char* GetCustomFragmentPreFix();
+
+  /**
+   * @brief Gets custom sampler type name for rendering a native image.
+   *
+   * @return String for custom sampler type name
+   */
+  const char* GetCustomSamplerTypename();
+
 public: // Not intended for application developers
 
   explicit DALI_INTERNAL NativeImage( Internal::NativeImage* );