trunk/src/jp/nyatla/nyartoolkit/core/rasterreader/INyARBufferReader.java

   1 /* \r
   2  * PROJECT: NyARToolkit\r
   3  * --------------------------------------------------------------------------------\r
   4  * This work is based on the original ARToolKit developed by\r
   5  *   Hirokazu Kato\r
   6  *   Mark Billinghurst\r
   7  *   HITLab, University of Washington, Seattle\r
   8  * http://www.hitl.washington.edu/artoolkit/\r
   9  *\r
  10  * The NyARToolkit is Java edition ARToolKit class library.\r
  11  * Copyright (C)2008-2009 Ryo Iizuka\r
  12  *\r
  13  * This program is free software: you can redistribute it and/or modify\r
  14  * it under the terms of the GNU General Public License as published by\r
  15  * the Free Software Foundation, either version 3 of the License, or\r
  16  * (at your option) any later version.\r
  17  * \r
  18  * This program is distributed in the hope that it will be useful,\r
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  21  * GNU General Public License for more details.\r
  22  *\r
  23  * You should have received a copy of the GNU General Public License\r
  24  * along with this program.  If not, see <http://www.gnu.org/licenses/>.\r
  25  * \r
  26  * For further information please contact.\r
  27  *      http://nyatla.jp/nyatoolkit/\r
  28  *      <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>\r
  29  * \r
  30  */\r
  31 package jp.nyatla.nyartoolkit.core.rasterreader;\r
  32 /**\r
  33  * このインタフェイスは、画素データを格納するバッファオブジェクト\r
  34  * へのアクセス方法と、その形式を定義します。\r
  35  *\r
  36  */\r
  37 public interface INyARBufferReader\r
  38 {\r
  39         public static final int BYTE1D =0x00010000;\r
  40         public static final int INT2D  =0x00020000;\r
  41         public static final int SHORT1D=0x00030000;\r
  42         public static final int INT1D  =0x00040000;\r
  43     //  ID規約\r
  44         //  24-31(8)予約\r
  45         //  16-27(8)型ID\r
  46         //      00:無効/01:byte[]/02:int[][]/03:short[]\r
  47         //  08-15(8)ビットフォーマットID\r
  48         //      00:24bit/01:32bit/02:16bit\r
  49         //  00-07(8)型番号\r
  50         //\r
  51         /**\r
  52          * RGB24フォーマットで、全ての画素が0\r
  53          */\r
  54         public static final int BUFFERFORMAT_NULL_ALLZERO = 0x00000001;\r
  55 \r
  56         /**\r
  57          * byte[]で、R8G8B8の24ビットで画素が格納されている。\r
  58          */\r
  59         public static final int BUFFERFORMAT_BYTE1D_R8G8B8_24   = BYTE1D|0x0001;\r
  60         /**\r
  61          * byte[]で、B8G8R8の24ビットで画素が格納されている。\r
  62          */\r
  63         public static final int BUFFERFORMAT_BYTE1D_B8G8R8_24   = BYTE1D|0x0002;\r
  64         /**\r
  65          * byte[]で、R8G8B8X8の32ビットで画素が格納されている。\r
  66          */\r
  67         public static final int BUFFERFORMAT_BYTE1D_B8G8R8X8_32 = BYTE1D|0x0101;\r
  68         /**\r
  69          * byte[]で、X8R8G8B8の32ビットで画素が格納されている。\r
  70          */\r
  71         public static final int BUFFERFORMAT_BYTE1D_X8R8G8B8_32 = BYTE1D|0x0102;\r
  72 \r
  73         /**\r
  74          * byte[]で、RGB565の16ビット(little/big endian)で画素が格納されている。\r
  75          */\r
  76         public static final int BUFFERFORMAT_BYTE1D_R5G6B5_16LE = BYTE1D|0x0201;\r
  77     public static final int BUFFERFORMAT_BYTE1D_R5G6B5_16BE = BYTE1D|0x0202;\r
  78         /**\r
  79          * short[]で、RGB565の16ビット(little/big endian)で画素が格納されている。\r
  80          */     \r
  81     public static final int BUFFERFORMAT_WORD1D_R5G6B5_16LE = SHORT1D|0x0201;\r
  82     public static final int BUFFERFORMAT_WORD1D_R5G6B5_16BE = SHORT1D|0x0202;\r
  83 \r
  84         \r
  85         /**\r
  86          * int[][]で特に値範囲を定めない\r
  87          */\r
  88         public static final int BUFFERFORMAT_INT2D        = INT2D|0x0000;\r
  89         /**\r
  90          * int[][]で0-255のグレイスケール画像\r
  91          */\r
  92         public static final int BUFFERFORMAT_INT2D_GRAY_8 = INT2D|0x0001;\r
  93         /**\r
  94          * int[][]で0/1の2値画像\r
  95          * これは、階調値1bitのBUFFERFORMAT_INT2D_GRAY_1と同じです。\r
  96          */\r
  97         public static final int BUFFERFORMAT_INT2D_BIN_8  = INT2D|0x0002;\r
  98 \r
  99         /**\r
 100          * int[]で特に値範囲を定めない\r
 101          */\r
 102         public static final int BUFFERFORMAT_INT1D        = INT1D|0x0000;\r
 103         /**\r
 104          * int[]で0-255のグレイスケール画像\r
 105          */\r
 106         public static final int BUFFERFORMAT_INT1D_GRAY_8 = INT1D|0x0001;\r
 107         /**\r
 108          * int[]で0/1の2値画像\r
 109          * これは、階調1bitのBUFFERFORMAT_INT1D_GRAY_1と同じです。\r
 110          */\r
 111         public static final int BUFFERFORMAT_INT1D_BIN_8  = INT1D|0x0002;\r
 112 \r
 113         \r
 114         /**\r
 115          * int[]で、XRGB32の32ビットで画素が格納されている。\r
 116          */     \r
 117     public static final int BUFFERFORMAT_INT1D_X8R8G8B8_32 = INT1D|0x0102;\r
 118         \r
 119 \r
 120         /**\r
 121          * バッファオブジェクトを返します。\r
 122          * @return\r
 123          */\r
 124         public Object getBuffer();\r
 125         /**\r
 126          * バッファオブジェクトの形式を返します。\r
 127          * @return\r
 128          */\r
 129         public int getBufferType();\r
 130         /**\r
 131          * バッファオブジェクトの形式が、i_type_valueにが一致するか返します。\r
 132          * @param i_type_value\r
 133          * @return\r
 134          */\r
 135         public boolean isEqualBufferType(int i_type_value);\r
 136 }\r