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 / NyARRaster.java

diff --git a/lib/src/jp/nyatla/nyartoolkit/core/raster/NyARRaster.java b/lib/src/jp/nyatla/nyartoolkit/core/raster/NyARRaster.java
index 39d1728..87fe4b7 100644 (file)
--- a/lib/src/jp/nyatla/nyartoolkit/core/raster/NyARRaster.java
+++ b/lib/src/jp/nyatla/nyartoolkit/core/raster/NyARRaster.java
@@ -33,23 +33,37 @@ package jp.nyatla.nyartoolkit.core.raster;
 import jp.nyatla.nyartoolkit.NyARException;\r
 import jp.nyatla.nyartoolkit.core.types.*;\r
 \r
-/**このクラスは、単機能のNyARRasterです。\r
+/**\r
+ * このクラスは、指定形式のバッファを持つインスタンスを生成します。\r
+ * <p>対応しているバッファ形式は以下の通りです。\r
+　* <ul>\r
+　* <li>{@link NyARBufferType#INT1D}\r
+　* <li>{@link NyARBufferType#INT1D_X8R8G8B8_32}\r
+　* <ul>\r
+ * </p>\r
  *\r
  */\r
 public class NyARRaster extends NyARRaster_BasicClass\r
 {\r
+       /** バッファオブジェクトの変数*/\r
        protected Object _buf;\r
-       /**\r
-        * バッファオブジェクトがアタッチされていればtrue\r
-        */\r
+       /** バッファオブジェクトがアタッチされていればtrue*/\r
        protected boolean _is_attached_buffer;\r
        /**\r
-        * 指定したバッファタイプのラスタを作成します。\r
+        * コンストラクタです。\r
+        * 画像のサイズパラメータとバッファ形式を指定して、インスタンスを生成します。\r
         * @param i_width\r
+        * ラスタのサイズ\r
         * @param i_height\r
-        * @param i_buffer_type\r
-        * NyARBufferTypeに定義された定数値を指定してください。\r
+        * ラスタのサイズ\r
+        * @param i_raster_type\r
+        * ラスタのバッファ形式。\r
+        * {@link NyARBufferType}に定義された定数値を指定してください。\r
+        * 指定できる値は、クラスの説明を見てください。\r
         * @param i_is_alloc\r
+        * バッファを外部参照にするかのフラグ値。\r
+        * trueなら内部バッファ、falseなら外部バッファを使用します。\r
+        * falseの場合、初期のバッファはnullになります。インスタンスを生成したのちに、{@link #wrapBuffer}を使って割り当ててください。\r
         * @throws NyARException\r
         */\r
        public NyARRaster(int i_width, int i_height,int i_buffer_type,boolean i_is_alloc) throws NyARException\r
@@ -60,7 +74,19 @@ public class NyARRaster extends NyARRaster_BasicClass
                }\r
                return;\r
        }       \r
-\r
+       /**\r
+        * コンストラクタです。\r
+        * 画像のサイズパラメータとバッファ形式を指定して、インスタンスを生成します。\r
+        * @param i_width\r
+        * ラスタのサイズ\r
+        * @param i_height\r
+        * ラスタのサイズ\r
+        * @param i_raster_type\r
+        * ラスタのバッファ形式。\r
+        * {@link NyARBufferType}に定義された定数値を指定してください。\r
+        * 指定できる値は、クラスの説明を見てください。\r
+        * @throws NyARException\r
+        */\r
        public NyARRaster(int i_width, int i_height,int i_buffer_type) throws NyARException\r
        {\r
                super(i_width,i_height,i_buffer_type);\r
@@ -68,7 +94,17 @@ public class NyARRaster extends NyARRaster_BasicClass
                        throw new NyARException();\r
                }\r
                return;\r
-       }       \r
+       }\r
+       /**\r
+        * このクラスの初期化シーケンスです。コンストラクタから呼び出します。\r
+        * @param i_size\r
+        * ラスタサイズ\r
+        * @param i_buf_type\r
+        * バッファ形式\r
+        * @param i_is_alloc\r
+        * バッファ参照方法値\r
+        * @return\r
+        */\r
        protected boolean initInstance(NyARIntSize i_size,int i_buf_type,boolean i_is_alloc)\r
        {\r
                switch(i_buf_type)\r
@@ -84,6 +120,10 @@ public class NyARRaster extends NyARRaster_BasicClass
                this._is_attached_buffer=i_is_alloc;\r
                return true;\r
        }\r
+       /**\r
+        * この関数は、ラスタのバッファへの参照値を返します。\r
+        * バッファの形式は、コンストラクタに指定した形式と同じです。\r
+        */             \r
        public Object getBuffer()\r
        {\r
                return this._buf;\r
@@ -98,6 +138,10 @@ public class NyARRaster extends NyARRaster_BasicClass
        {\r
                return this._buf!=null;\r
        }\r
+       /**\r
+        * この関数は、ラスタに外部参照バッファをセットします。\r
+        * 外部参照バッファを持つインスタンスでのみ使用できます。内部参照バッファを持つインスタンスでは使用できません。\r
+        */     \r
        public void wrapBuffer(Object i_ref_buf) throws NyARException\r
        {\r
                assert(!this._is_attached_buffer);//バッファがアタッチされていたら機能しない。\r