michael/lwjgl
michael
/
lwjgl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fixed javadoc error

This commit is contained in:
Ioannis Tsakpinis 2004-02-15 21:45:03 +00:00
parent 061e1a76d1
commit 4c16b9a653
1 changed files with 31 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
src/java/org/lwjgl/Display.java
View File

@ -1,31 +1,31 @@
/* /*
* Copyright (c) 2002 Light Weight Java Game Library Project * Copyright (c) 2002 Light Weight Java Game Library Project
* All rights reserved. * All rights reserved.
* *
* Redistribution and use in source and binary forms, with or without * Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are * modification, are permitted provided that the following conditions are
* met: * met:
* *
* * Redistributions of source code must retain the above copyright * * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer. * notice, this list of conditions and the following disclaimer.
* *
* * Redistributions in binary form must reproduce the above copyright * * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the * notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution. * documentation and/or other materials provided with the distribution.
* *
* * Neither the name of 'Light Weight Java Game Library' nor the names of * * Neither the name of 'Light Weight Java Game Library' nor the names of
* its contributors may be used to endorse or promote products derived * its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission. * from this software without specific prior written permission.
* *
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
@ -44,7 +44,7 @@ import java.util.HashSet;
* Encapsulates everything you need for game display. * Encapsulates everything you need for game display.
* It must be created before any input devices are created. * It must be created before any input devices are created.
* The game display has NO mouse cursor or any other window decorations. * The game display has NO mouse cursor or any other window decorations.
* *
* @author cix_foo <cix_foo@users.sourceforge.net> * @author cix_foo <cix_foo@users.sourceforge.net>
* @version $Revision$ * @version $Revision$
*/ */
@ -65,12 +65,12 @@ public final class Display {
* on, which is handy to know for some GL context calls. * on, which is handy to know for some GL context calls.
*/ */
/** Windows platform */ /** Windows platform */
public static final int PLATFORM_WGL = 0; public static final int PLATFORM_WGL = 0;
/** GLX (Linux/Unix) platform */ /** GLX (Linux/Unix) platform */
public static final int PLATFORM_GLX = 1; public static final int PLATFORM_GLX = 1;
/** MacOSX platform */ /** MacOSX platform */
public static final int PLATFORM_AGL = 2; public static final int PLATFORM_AGL = 2;
@ -86,7 +86,7 @@ public final class Display {
private Display() { private Display() {
super(); super();
} }
/** /**
* Initialize. This determines, natively, the current display mode and stashes * Initialize. This determines, natively, the current display mode and stashes
* it back in the mode static member. * it back in the mode static member.
@ -98,7 +98,7 @@ public final class Display {
* particular order. Any given mode is not guaranteed to be available and * particular order. Any given mode is not guaranteed to be available and
* the only certain way to check is to call create() and make sure it works. * the only certain way to check is to call create() and make sure it works.
* Only non-palette-indexed modes are returned (ie. bpp will be 16, 24, or 32). * Only non-palette-indexed modes are returned (ie. bpp will be 16, 24, or 32).
* *
* @return an array of all display modes the system reckons it can handle. * @return an array of all display modes the system reckons it can handle.
*/ */
public static DisplayMode[] getAvailableDisplayModes() { public static DisplayMode[] getAvailableDisplayModes() {
@ -120,21 +120,21 @@ public final class Display {
return filteredModes; return filteredModes;
} }
/** /**
* Native method for getting displaymodes * Native method for getting displaymodes
*/ */
private static native DisplayMode[] nGetAvailableDisplayModes(); private static native DisplayMode[] nGetAvailableDisplayModes();
/** /**
* Set the current display mode. The underlying OS may not use an exact match for * Set the current display mode. The underlying OS may not use an exact match for
* the specified display mode. After successfully calling setDisplayMode() you will * the specified display mode. After successfully calling setDisplayMode() you will
* still need to query the display's characteristics using getDisplayMode(). * still need to query the display's characteristics using getDisplayMode().
* *
* @param mode The new display mode to set * @param mode The new display mode to set
* @throws Exception if the display mode could not be set * @throws Exception if the display mode could not be set
*/ */
public static native void setDisplayMode(DisplayMode mode) throws Exception; public static native void setDisplayMode(DisplayMode mode) throws Exception;
/** /**
* Reset the display mode to whatever it was when LWJGL was initialized. * Reset the display mode to whatever it was when LWJGL was initialized.
* Fails silently. * Fails silently.
@ -143,7 +143,7 @@ public final class Display {
/** /**
* Retrieves the width of the created display * Retrieves the width of the created display
* *
* @return the current display width. * @return the current display width.
*/ */
public static int getWidth() { public static int getWidth() {
@ -152,7 +152,7 @@ public final class Display {
/** /**
* Retrieves the height of the created display * Retrieves the height of the created display
* *
* @return the current display height. * @return the current display height.
*/ */
public static int getHeight() { public static int getHeight() {
@ -161,7 +161,7 @@ public final class Display {
/** /**
* Retrieves the current display depth of the created display * Retrieves the current display depth of the created display
* *
* @return the current display depth. * @return the current display depth.
*/ */
public static int getDepth() { public static int getDepth() {
@ -170,7 +170,7 @@ public final class Display {
/** /**
* Retrieves the current display frequency of the created display * Retrieves the current display frequency of the created display
* *
* @return the current display frequency. * @return the current display frequency.
*/ */
public static int getFrequency() { public static int getFrequency() {
@ -182,7 +182,7 @@ public final class Display {
* constants defined above. There is no "unknown" platform; a native library port * constants defined above. There is no "unknown" platform; a native library port
* has to provide a unique platform number for this mechanism to work. If the LWJGL * has to provide a unique platform number for this mechanism to work. If the LWJGL
* is ported to, say, QNX, we will have a PLATFORM_QNX at the ready. * is ported to, say, QNX, we will have a PLATFORM_QNX at the ready.
* *
* @return the windowing system * @return the windowing system
*/ */
public static native int getPlatform(); public static native int getPlatform();
@ -194,7 +194,6 @@ public final class Display {
* @param gamma The gamma value * @param gamma The gamma value
* @param brightness The brightness value between -1.0 and 1.0, inclusive * @param brightness The brightness value between -1.0 and 1.0, inclusive
* @param contrast The contrast, larger than 0.0. * @param contrast The contrast, larger than 0.0.
* @return true if the call succeeded, false otherwise
*/ */
public static void setDisplayConfiguration(float gamma, float brightness, float contrast) throws Exception { public static void setDisplayConfiguration(float gamma, float brightness, float contrast) throws Exception {
assert brightness >= -1.0f && brightness <= 1.0f; assert brightness >= -1.0f && brightness <= 1.0f;
@ -235,19 +234,19 @@ public final class Display {
* Native method to set the gamma ramp. * Native method to set the gamma ramp.
*/ */
private static native void setGammaRamp(FloatBuffer gammaRamp) throws Exception ; private static native void setGammaRamp(FloatBuffer gammaRamp) throws Exception ;
/** /**
* Get the driver adapter string. This is a unique string describing the actual card's hardware, eg. "Geforce2", "PS2", * Get the driver adapter string. This is a unique string describing the actual card's hardware, eg. "Geforce2", "PS2",
* "Radeon9700". If the adapter cannot be determined, this function returns null. * "Radeon9700". If the adapter cannot be determined, this function returns null.
* @return a String * @return a String
*/ */
public static native String getAdapter(); public static native String getAdapter();
/** /**
* Get the driver version. This is a vendor/adapter specific version string. If the version cannot be determined, * Get the driver version. This is a vendor/adapter specific version string. If the version cannot be determined,
* this function returns null. * this function returns null.
* @return a String * @return a String
*/ */
public static native String getVersion(); public static native String getVersion();
} }