libjava/java/awt/image/PixelInterleavedSampleModel.java

   1 /* PixelInterleavedSampleModel.java
   2    Copyright (C) 2004, 2005  Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38 package java.awt.image;
  39
  40
  41 /**
  42  * A <code>SampleModel</code> that uses exactly one element of the
  43  * raster&#x2019;s {@link DataBuffer} per pixel, holds all bands in a
  44  * single bank, and stores band data in pixel-interleaved manner.
  45  *
  46  * @since 1.2
  47  *
  48  * @author Sascha Brawer (brawer@dandelis.ch)
  49  */
  50 public class PixelInterleavedSampleModel
  51   extends ComponentSampleModel
  52 {
  53   public PixelInterleavedSampleModel(int dataType, int width, int height,
  54                                      int pixelStride, int scanlineStride,
  55                                      int[] bandOffsets)
  56   {
  57     super(dataType, width, height, pixelStride, scanlineStride,
  58           bandOffsets);
  59   }
  60
  61
  62   /**
  63    * Creates a new <code>SampleModel</code> that is like this one, but
  64    * uses the specified width and height.
  65    *
  66    * @param width the number of pixels in the horizontal direction.
  67    *
  68    * @param height the number of pixels in the vertical direction.
  69    */
  70   public SampleModel createCompatibleSampleModel(int width, int height)
  71   {
  72     return new PixelInterleavedSampleModel(dataType, width, height,
  73                                            pixelStride, scanlineStride,
  74                                            bandOffsets);
  75   }
  76
  77
  78   /**
  79    * Creates a new <code>SampleModel</code> that is like this one, but
  80    * uses only a subset of its bands.
  81    *
  82    * @param bands an array whose elements indicate which bands shall
  83    * be part of the subset. For example, <code>[0, 2, 3]</code> would
  84    * create a SampleModel containing bands #0, #2 and #3.
  85    */
  86   public SampleModel createSubsetSampleModel(int[] bands)
  87   {
  88     int[] subOffsets;
  89
  90     subOffsets = new int[bands.length];
  91     for (int i = 0; i < bands.length; i++)
  92       subOffsets[i] = bandOffsets[bands[i]];
  93
  94     return new PixelInterleavedSampleModel(dataType, width, height,
  95                                            pixelStride, scanlineStride,
  96                                            subOffsets);
  97   }
  98 }