1 /* DisplayMode.java -- a description of display mode configurations
2 Copyright (C) 2002, 2003 Free Software Foundation, Inc.
4 This file is part of GNU Classpath.
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)
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.
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
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
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. */
42 * This encapsulates information about the display mode for a graphics
43 * device configuration. They are device dependent, and may not always be
46 * @author Eric Blake <ebb9@email.byu.edu>
49 * @status updated to 1.4
51 public final class DisplayMode
54 * Value of the bit depth if multiple depths are supported.
58 public static final int BIT_DEPTH_MULTI
= -1;
61 * Value of an unknown refresh rate.
63 * @see #getRefreshRate()
65 public static final int REFRESH_RATE_UNKNOWN
= 0;
68 private final int width
;
71 private final int height
;
74 private final int bitDepth
;
76 /** The refresh rate. */
77 private final int refreshRate
;
80 * Create a mode with the given parameters.
82 * @param width the width
83 * @param height the height
84 * @param bitDepth the bitDepth
85 * @param refreshRate the refreshRate
86 * @see #BIT_DEPTH_MULTI
87 * @see #REFRESH_RATE_UNKNOWN
89 public DisplayMode(int width
, int height
, int bitDepth
, int refreshRate
)
93 this.bitDepth
= bitDepth
;
94 this.refreshRate
= refreshRate
;
98 * Returns the height, in pixels.
102 public int getHeight()
108 * Returns the width, in pixels.
112 public int getWidth()
118 * Returns the bit depth, in bits per pixel. This may be BIT_DEPTH_MULTI.
120 * @return the bit depth
121 * @see #BIT_DEPTH_MULTI
123 public int getBitDepth()
129 * Returns the refresh rate, in hertz. This may be REFRESH_RATE_UNKNOWN.
131 * @return the refresh rate
132 * @see #REFRESH_RATE_UNKNOWN
134 public int getRefreshRate()
140 * Test for equality. This returns true for two modes with identical
143 * @param dm The display mode to compare to
145 * @return true if it is equal
147 public boolean equals (DisplayMode dm
)
149 return (width
== dm
.width
150 && height
== dm
.height
151 && bitDepth
== dm
.bitDepth
152 && refreshRate
== dm
.refreshRate
);
156 * Returns a hash code for the display mode.
158 * @return the hash code
160 public int hashCode()
162 return width
+ height
+ bitDepth
+ refreshRate
;
164 } // class DisplayMode