git-svn-id: http://svn.sourceforge.jp/svnroot/nyartoolkit/NyARToolkit/trunk@802 7cac0...

[nyartoolkit-and/nyartoolkit-and.git] / lib / src / jp / nyatla / nyartoolkit / core / raster / NyARHsvRaster.java

diff --git a/lib/src/jp/nyatla/nyartoolkit/core/raster/NyARHsvRaster.java b/lib/src/jp/nyatla/nyartoolkit/core/raster/NyARHsvRaster.java
index 90e06f6..57e5811 100644 (file)
--- a/lib/src/jp/nyatla/nyartoolkit/core/raster/NyARHsvRaster.java
+++ b/lib/src/jp/nyatla/nyartoolkit/core/raster/NyARHsvRaster.java
@@ -33,25 +33,47 @@ package jp.nyatla.nyartoolkit.core.raster;
 import jp.nyatla.nyartoolkit.NyARException;\r
 import jp.nyatla.nyartoolkit.core.types.*;\r
 \r
+/**\r
+ * このクラスは、HSV画像を格納するラスタクラスです。\r
+ * 内部バッファのみに対応します。\r
+ */\r
 public final class NyARHsvRaster extends NyARRaster_BasicClass\r
 {\r
 \r
        private int[] _ref_buf;\r
-       \r
+       /**\r
+        * コンストラクタです。ラスタのサイズを指定して、インスタンスを生成します。\r
+        * @param i_width\r
+        * ラスタのサイズです。\r
+        * @param i_height\r
+        * ラスタのサイズです。\r
+        */\r
        public NyARHsvRaster(int i_width, int i_height)\r
        {\r
                //このクラスは外部参照バッファ/形式多重化が使えない簡易実装です。\r
                super(i_width,i_height,NyARBufferType.INT1D_X7H9S8V8_32);\r
                this._ref_buf = new int[i_height*i_width];\r
        }\r
+       /**\r
+        * この関数は、ラスタのバッファへの参照値を返します。\r
+        * バッファの形式{@link NyARBufferType.INT1D_X7H9S8V8_32}です。\r
+        */\r
        public Object getBuffer()\r
        {\r
                return this._ref_buf;\r
        }\r
+       /**\r
+        * この関数は、インスタンスがバッファを所有するかを返します。\r
+        * このクラスでは内部参照バッファのみをサポートするため、常にtrueです。\r
+        */     \r
        public boolean hasBuffer()\r
        {\r
                return true;\r
        }\r
+       /**\r
+        * この関数は、ラスタに外部参照バッファをセットします。\r
+        * 外部参照バッファを持つインスタンスでのみ使用できます。内部参照バッファを持つインスタンスでは使用できません。\r
+        */     \r
        public void wrapBuffer(Object i_ref_buf) throws NyARException\r
        {\r
                NyARException.notImplement();\r