diff options
| author | Kenneth Russel <[email protected]> | 2005-11-12 01:41:59 +0000 |
|---|---|---|
| committer | Kenneth Russel <[email protected]> | 2005-11-12 01:41:59 +0000 |
| commit | 28a54ba2050ee936f6370aa89fccdde23418fcbb (patch) | |
| tree | a41644e1ca4498a6e9f8ac9299d371b776845f03 /src/classes/javax/media/opengl/GLDrawableFactory.java | |
| parent | 4245ea5d8e1d27c8dd698c93b901dba64aa7906e (diff) | |
Minor javadoc changes to GLDrawableFactory.
chooseGraphicsConfiguration() suggested by Justin Couch
git-svn-id: file:///usr/local/projects/SUN/JOGL/git-svn/svn-server-sync/jogl/trunk@441 232f8b59-042b-4e1e-8c03-345bb8c30851
Diffstat (limited to 'src/classes/javax/media/opengl/GLDrawableFactory.java')
| -rw-r--r-- | src/classes/javax/media/opengl/GLDrawableFactory.java | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/src/classes/javax/media/opengl/GLDrawableFactory.java b/src/classes/javax/media/opengl/GLDrawableFactory.java index 42cf8a724..39724c976 100644 --- a/src/classes/javax/media/opengl/GLDrawableFactory.java +++ b/src/classes/javax/media/opengl/GLDrawableFactory.java @@ -130,17 +130,24 @@ public abstract class GLDrawableFactory { * other window toolkit-specific object with a GLDrawable. Some * platforms (specifically X11) require the graphics configuration * to be specified when the window toolkit object is created. This - * method returns null on platforms on which the OpenGL pixel format - * selection process is performed later. </P> + * method may return null on platforms on which the OpenGL pixel + * format selection process is performed later. </P> * * <P> The concrete data type of the passed graphics device and * returned graphics configuration must be specified in the * documentation binding this particular API to the underlying * window toolkit. The Reference Implementation accepts {@link * AWTGraphicsDevice AWTGraphicsDevice} objects and returns {@link - * AWTGraphicsConfiguration AWTGraphicsConfiguration} objects. + * AWTGraphicsConfiguration AWTGraphicsConfiguration} objects. </P> * - * @see java.awt.Canvas#Canvas(java.awt.GraphicsConfiguration) */ + * @see java.awt.Canvas#Canvas(java.awt.GraphicsConfiguration) + * + * @throws IllegalArgumentException if the data type of the passed + * AbstractGraphicsDevice is not supported by this + * GLDrawableFactory. + * @throws GLException if any window system-specific errors caused + * the selection of the graphics configuration to fail. + */ public abstract AbstractGraphicsConfiguration chooseGraphicsConfiguration(GLCapabilities capabilities, GLCapabilitiesChooser chooser, |