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 / rgb / NyARRgbRaster_Blank.java

diff --git a/lib/src/jp/nyatla/nyartoolkit/core/raster/rgb/NyARRgbRaster_Blank.java b/lib/src/jp/nyatla/nyartoolkit/core/raster/rgb/NyARRgbRaster_Blank.java
index a75c2a9..0d15f2b 100644 (file)
--- a/lib/src/jp/nyatla/nyartoolkit/core/raster/rgb/NyARRgbRaster_Blank.java
+++ b/lib/src/jp/nyatla/nyartoolkit/core/raster/rgb/NyARRgbRaster_Blank.java
@@ -34,9 +34,9 @@ import jp.nyatla.nyartoolkit.NyARException;
 import jp.nyatla.nyartoolkit.core.rasterreader.INyARRgbPixelReader;\r
 import jp.nyatla.nyartoolkit.core.types.*;\r
 \r
-/*\r
- * 真っ黒の矩形を定義する。\r
- * \r
+/**\r
+ * このクラスは、空のラスタを定義します。\r
+ * 空のラスタは、バッファを持たないサイズのみのラスタです。デバックなどに使います。\r
  */\r
 public class NyARRgbRaster_Blank extends NyARRgbRaster_BasicClass\r
 {\r
@@ -78,25 +78,50 @@ public class NyARRgbRaster_Blank extends NyARRgbRaster_BasicClass
        }\r
 \r
        private INyARRgbPixelReader _reader;\r
-       \r
+       /**\r
+        * コンストラクタです。\r
+        * バッファの参照方法を指定して、インスタンスを生成します。\r
+        * @param i_width\r
+        * ラスタサイズ\r
+        * @param i_height\r
+        * ラスタサイズ\r
+        */\r
        public NyARRgbRaster_Blank(int i_width, int i_height)\r
        {\r
                super(i_width,i_height,NyARBufferType.NULL_ALLZERO);\r
                this._reader = new PixelReader();\r
                return;\r
        }\r
+       /**\r
+        * この関数は、画素フォーマットによらない画素アクセスを行うオブジェクトへの参照値を返します。\r
+        * @return\r
+        * オブジェクトの参照値\r
+        * @throws NyARException\r
+        */     \r
        public INyARRgbPixelReader getRgbPixelReader() throws NyARException\r
        {\r
                return this._reader;\r
        }\r
+       /**\r
+        * この関数は、ラスタのバッファへの参照値を返します。\r
+        * 常にNULLです。\r
+        */     \r
        public Object getBuffer()\r
        {\r
                return null;\r
        }\r
+       /**\r
+        * この関数は、インスタンスがバッファを所有するかを返します。\r
+        * 内部参照バッファの場合は、常にfalseです。\r
+        */             \r
        public boolean hasBuffer()\r
        {\r
                return false;\r
        }\r
+       /**\r
+        * この関数は、ラスタに外部参照バッファをセットします。\r
+        * このクラスでは使用できません。\r
+        */     \r
        public void wrapBuffer(Object i_ref_buf) throws NyARException\r
        {\r
                NyARException.notImplement();\r