001/* DisplayMode.java -- a description of display mode configurations
002   Copyright (C) 2002, 2003, 2005  Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package java.awt;
040
041/**
042 * This encapsulates information about the display mode for a graphics
043 * device configuration. They are device dependent, and may not always be
044 * available.
045 *
046 * @author Eric Blake (ebb9@email.byu.edu)
047 * @see GraphicsDevice
048 * @since 1.4
049 * @status updated to 1.4
050 */
051public final class DisplayMode
052{
053  /**
054   * Value of the bit depth if multiple depths are supported.
055   *
056   * @see #getBitDepth()
057   */
058  public static final int BIT_DEPTH_MULTI = -1;
059
060  /**
061   * Value of an unknown refresh rate.
062   *
063   * @see #getRefreshRate()
064   */
065  public static final int REFRESH_RATE_UNKNOWN = 0;
066
067  /** The width. */
068  private final int width;
069
070  /** The height. */
071  private final int height;
072
073  /** The bit depth. */
074  private final int bitDepth;
075
076  /** The refresh rate. */
077  private final int refreshRate;
078
079  /**
080   * Create a mode with the given parameters.
081   *
082   * @param width the width
083   * @param height the height
084   * @param bitDepth the bitDepth
085   * @param refreshRate the refreshRate
086   * @see #BIT_DEPTH_MULTI
087   * @see #REFRESH_RATE_UNKNOWN
088   */
089  public DisplayMode(int width, int height, int bitDepth, int refreshRate)
090  {
091    this.width = width;
092    this.height = height;
093    this.bitDepth = bitDepth;
094    this.refreshRate = refreshRate;
095  }
096
097  /**
098   * Returns the height, in pixels.
099   *
100   * @return the height
101   */
102  public int getHeight()
103  {
104    return height;
105  }
106
107  /**
108   * Returns the width, in pixels.
109   *
110   * @return the width
111   */
112  public int getWidth()
113  {
114    return width;
115  }
116
117  /**
118   * Returns the bit depth, in bits per pixel. This may be BIT_DEPTH_MULTI.
119   *
120   * @return the bit depth
121   * @see #BIT_DEPTH_MULTI
122   */
123  public int getBitDepth()
124  {
125    return bitDepth;
126  }
127
128  /**
129   * Returns the refresh rate, in hertz. This may be REFRESH_RATE_UNKNOWN.
130   *
131   * @return the refresh rate
132   * @see #REFRESH_RATE_UNKNOWN
133   */
134  public int getRefreshRate()
135  {
136    return refreshRate;
137  }
138
139  /**
140   * Test for equality. This returns true for two modes with identical
141   * parameters.
142   *
143   * @param dm The display mode to compare to
144   *
145   * @return true if it is equal
146   */
147  public boolean equals (DisplayMode dm)
148  {
149    return (width == dm.width
150            && height == dm.height
151            && bitDepth == dm.bitDepth
152            && refreshRate == dm.refreshRate);
153  }
154
155  /**
156   * Returns a hash code for the display mode.
157   *
158   * @return the hash code
159   */
160  public int hashCode()
161  {
162    return width + height + bitDepth + refreshRate;
163  }
164} // class DisplayMode