Refactored more code into Actor::Relayouter

[platform/core/uifw/dali-core.git] / dali / public-api / actors / sampling.h

diff --git a/dali/public-api/actors/sampling.h b/dali/public-api/actors/sampling.h
old mode 100644 (file)
new mode 100755 (executable)
index 72d2c9f..0a6dc5a
--- a/dali/public-api/actors/sampling.h
+++ b/dali/public-api/actors/sampling.h
@@ -1,8 +1,8 @@
-#ifndef __DALI_SAMPLING_H__
-#define __DALI_SAMPLING_H__
+#ifndef DALI_SAMPLING_H
+#define DALI_SAMPLING_H
 
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2019 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -31,31 +31,31 @@ namespace Dali
 namespace FilterMode
 {
 /**
- * @brief Texture filtering mode.
+ * @brief Enumeration for texture filtering mode.
  * @SINCE_1_0.0
  */
 enum Type
 {
   /**
-   * @brief Use GL defaults (minification NEAREST_MIPMAP_LINEAR, magnification LINEAR)
+   * @brief Use GL defaults (minification NEAREST_MIPMAP_LINEAR, magnification LINEAR).
    * @SINCE_1_0.0
    */
   NONE = 0,
 
   /**
-   * @brief Use Dali defaults (minification LINEAR, magnification LINEAR)
-   *  @SINCE_1_0.0
+   * @brief Use Dali defaults (minification LINEAR, magnification LINEAR).
+   * @SINCE_1_0.0
    */
   DEFAULT,
 
   /**
-   * @brief Filter nearest
+   * @brief Filter nearest.
    * @SINCE_1_0.0
    */
   NEAREST,
 
   /**
-   * @brief Filter linear
+   * @brief Filter linear.
    * @SINCE_1_0.0
    */
   LINEAR,
@@ -98,15 +98,25 @@ enum Type
 
 } //namespace FilterMode
 
+/**
+ * @brief WrapMode for textures.
+ *
+ * @details Wrap mode determines how texture is sampled when texture coordinates are outside
+ * of the typical 0 to 1 range.
+ * @SINCE_1_0.0
+ */
 namespace WrapMode
 {
-
+/**
+ * @brief Enumeration for Wrap mode.
+ * @SINCE_1_0.0
+ */
 enum Type
 {
   DEFAULT = 0,    ///< Clamp to edge @SINCE_1_0.0
-  CLAMP_TO_EDGE,
-  REPEAT,
-  MIRRORED_REPEAT
+  CLAMP_TO_EDGE,  ///< Clamp to edge @SINCE_1_0.0
+  REPEAT,         ///< Repeat @SINCE_1_0.0
+  MIRRORED_REPEAT ///< Mirrored repeat @SINCE_1_0.0
 };
 
 } //namespace WrapMode
@@ -116,4 +126,4 @@ enum Type
  */
 } // namespace Dali
 
-#endif // __DALI_SAMPLING_H__
+#endif // DALI_SAMPLING_H