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

[nyartoolkit-and/nyartoolkit-and.git] / lib / src / jp / nyatla / nyartoolkit / core / rasterreader / NyARRgbPixelReader_BYTE1D_X8R8G8B8_32.java

diff --git a/lib/src/jp/nyatla/nyartoolkit/core/rasterreader/NyARRgbPixelReader_BYTE1D_X8R8G8B8_32.java b/lib/src/jp/nyatla/nyartoolkit/core/rasterreader/NyARRgbPixelReader_BYTE1D_X8R8G8B8_32.java
index 90099a1..aeefa77 100644 (file)
--- a/lib/src/jp/nyatla/nyartoolkit/core/rasterreader/NyARRgbPixelReader_BYTE1D_X8R8G8B8_32.java
+++ b/lib/src/jp/nyatla/nyartoolkit/core/rasterreader/NyARRgbPixelReader_BYTE1D_X8R8G8B8_32.java
@@ -33,22 +33,30 @@ package jp.nyatla.nyartoolkit.core.rasterreader;
 import jp.nyatla.nyartoolkit.NyARException;\r
 import jp.nyatla.nyartoolkit.core.types.*;\r
 /**\r
- * byte[]配列に、パディング無しの8bit画素値が、XRGBXRGBの順で並んでいる\r
- * バッファに使用できるピクセルリーダー\r
- *\r
+ * このクラスは、{@link NyARBufferType#BYTE1D_X8R8G8B8_32}形式のラスタバッファに対応する、ピクセルリーダです。\r
  */\r
 final public class NyARRgbPixelReader_BYTE1D_X8R8G8B8_32 implements INyARRgbPixelReader\r
 {\r
+       /** 参照する外部バッファ*/\r
        protected byte[] _ref_buf;\r
 \r
        private NyARIntSize _size;\r
-\r
+       /**\r
+        * コンストラクタです。\r
+        * 参照するラスタのバッファとサイズを指定して、インスタンスを作成します。\r
+        * @param i_buf\r
+        * ラスタのバッファオブジェクトの参照値\r
+        * @param i_size\r
+        * ラスタのサイズオブジェクトの参照値。\r
+        */\r
        public NyARRgbPixelReader_BYTE1D_X8R8G8B8_32(byte[] i_buf, NyARIntSize i_size)\r
        {\r
                this._ref_buf = i_buf;\r
                this._size = i_size;\r
        }\r
-\r
+       /**\r
+        * この関数は、指定した座標の1ピクセル分のRGBデータを、配列に格納して返します。\r
+        */\r
        public void getPixel(int i_x, int i_y, int[] o_rgb)\r
        {\r
                final byte[] ref_buf = this._ref_buf;\r
@@ -58,7 +66,9 @@ final public class NyARRgbPixelReader_BYTE1D_X8R8G8B8_32 implements INyARRgbPixe
                o_rgb[2] = (ref_buf[bp + 3] & 0xff);// B\r
                return;\r
        }\r
-\r
+       /**\r
+        * この関数は、座標群から、ピクセルごとのRGBデータを、配列に格納して返します。\r
+        */\r
        public void getPixelSet(int[] i_x, int[] i_y, int i_num, int[] o_rgb)\r
        {\r
                int bp;\r
@@ -72,18 +82,32 @@ final public class NyARRgbPixelReader_BYTE1D_X8R8G8B8_32 implements INyARRgbPixe
                }\r
                return;\r
        }\r
+       /**\r
+        * この関数は、機能しません。\r
+        */     \r
        public void setPixel(int i_x, int i_y, int[] i_rgb) throws NyARException\r
        {\r
                NyARException.notImplement();           \r
        }\r
+       /**\r
+        * この関数は、機能しません。\r
+        */     \r
        public void setPixel(int i_x, int i_y, int i_r,int i_g,int i_b) throws NyARException\r
        {\r
                NyARException.notImplement();           \r
        }\r
+       /**\r
+        * この関数は、機能しません。\r
+        */     \r
        public void setPixels(int[] i_x, int[] i_y, int i_num, int[] i_intrgb) throws NyARException\r
        {\r
                NyARException.notImplement();           \r
        }\r
+       /**\r
+        * この関数は、参照しているバッファをi_ref_bufferへ切り替えます。\r
+        * 通常は、このインスタンスを所有するクラスが使います。ユーザが使うことはありません。\r
+        * 関数は、入力値のバッファサイズと、型だけを確認します。\r
+        */     \r
        public void switchBuffer(Object i_ref_buffer) throws NyARException\r
        {\r
                assert(((byte[])i_ref_buffer).length>=this._size.w*this._size.h*4);\r