[Java-game-lib-cvs] SF.net SVN: java-game-lib: [2732] trunk/LWJGL/src/java/org/lwjgl/opengl/ Display.java

[<eli...@us...>]

Revision: 2732
          http://svn.sourceforge.net/java-game-lib/?rev=2732&view=rev
Author:   elias_naur
Date:     2007-01-22 02:14:13 -0800 (Mon, 22 Jan 2007)

Log Message:
-----------
Tweaked comment for Display.getAvailableDisplayModes to make it clear that invalid modes can be returned and that create() won't always detect such modes

Modified Paths:
--------------
    trunk/LWJGL/src/java/org/lwjgl/opengl/Display.java

Modified: trunk/LWJGL/src/java/org/lwjgl/opengl/Display.java
===================================================================
--- trunk/LWJGL/src/java/org/lwjgl/opengl/Display.java	2007-01-22 09:24:06 UTC (rev 2731)
+++ trunk/LWJGL/src/java/org/lwjgl/opengl/Display.java	2007-01-22 10:14:13 UTC (rev 2732)
@@ -153,8 +153,13 @@
 
 	/**
 	 * Returns the entire list of possible fullscreen display modes as an array, in no
-	 * 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.
+	 * particular order. Although best attempts to filter out invalid modes are done, any
+	 * given mode is not guaranteed to be available nor is it guaranteed to be within the
+	 * current monitor specs (this is especially a problem with the frequency parameter).
+	 * Furthermore, it is not guaranteed that create() will detect an illegal display mode.
+	 *
+	 * 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 DisplayModes from this call can be used when the Display is in fullscreen
 	 * mode.


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.