diff options
Diffstat (limited to 'src/newt/classes/com/jogamp')
-rw-r--r-- | src/newt/classes/com/jogamp/newt/Screen.java | 20 |
1 files changed, 12 insertions, 8 deletions
diff --git a/src/newt/classes/com/jogamp/newt/Screen.java b/src/newt/classes/com/jogamp/newt/Screen.java index c6943ff22..d25d3e7ac 100644 --- a/src/newt/classes/com/jogamp/newt/Screen.java +++ b/src/newt/classes/com/jogamp/newt/Screen.java @@ -151,24 +151,28 @@ public abstract class Screen { public abstract void removeScreenModeListener(ScreenModeListener sml); /** - * Return a list of available {@link com.jogamp.newt.ScreenMode}s. - * @return a shallow copy of the internal immutable {@link com.jogamp.newt.ScreenMode}s, - * or null if not implemented for this native type {@link com.jogamp.newt.Display#getType()}. + * Return a list of available {@link com.jogamp.newt.ScreenMode ScreenMode}s. + * <p> + * If {@link com.jogamp.newt.ScreenMode ScreenMode}s are not supported for this + * native type {@link com.jogamp.newt.Display#getType()}, it returns a list of size one with the current screen size.</p> + * + * @return a shallow copy of the internal immutable {@link com.jogamp.newt.ScreenMode ScreenMode}s. */ public abstract List<ScreenMode> getScreenModes(); /** * Return the original {@link com.jogamp.newt.ScreenMode}, as used at NEWT initialization. - * @return null if functionality not implemented, - * otherwise the original ScreenMode which is element of the list {@link #getScreenModes()}. - * + * @return original ScreenMode which is element of the list {@link #getScreenModes()}. */ public abstract ScreenMode getOriginalScreenMode(); /** * Return the current {@link com.jogamp.newt.ScreenMode}. - * @return null if functionality not implemented, - * otherwise the current ScreenMode which is element of the list {@link #getScreenModes()}. + * <p> + * If {@link com.jogamp.newt.ScreenMode ScreenMode}s are not supported for this + * native type {@link com.jogamp.newt.Display#getType()}, it returns one with the current screen size. </p> + * + * @return current ScreenMode which is element of the list {@link #getScreenModes()}. */ public abstract ScreenMode getCurrentScreenMode(); |