diff options
author | Kenneth Russel <[email protected]> | 2005-07-19 06:59:40 +0000 |
---|---|---|
committer | Kenneth Russel <[email protected]> | 2005-07-19 06:59:40 +0000 |
commit | 77521f233ff052096b25d9899bf3618fdc668740 (patch) | |
tree | 20f39baba49fcfbc1cb17a9943e718a3b825f18b /src/net/java/games/jogl/GLPbuffer.java | |
parent | 08d481088925526964be39cbdd28cfc4ae828a86 (diff) |
Documentation updates and minor cleanups
git-svn-id: file:///usr/local/projects/SUN/JOGL/git-svn/svn-server-sync/jogl/branches/JSR-231@333 232f8b59-042b-4e1e-8c03-345bb8c30851
Diffstat (limited to 'src/net/java/games/jogl/GLPbuffer.java')
-rw-r--r-- | src/net/java/games/jogl/GLPbuffer.java | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/src/net/java/games/jogl/GLPbuffer.java b/src/net/java/games/jogl/GLPbuffer.java index 4dd3c1e00..074d8b3c4 100644 --- a/src/net/java/games/jogl/GLPbuffer.java +++ b/src/net/java/games/jogl/GLPbuffer.java @@ -39,12 +39,13 @@ package net.java.games.jogl; -/** Offscreen rendering support via pbuffers. This class adds very - little functionality over the GLDrawable class; the only methods - are those which allow access to the pbuffer's contents as a - texture map and which enable offscreen rendering to floating-point - buffers. These methods are currently highly experimental and may - be removed in a future release. */ +/** Provides offscreen rendering support via pbuffers. The principal + addition of this interface is a {@link #destroy} method to + deallocate the pbuffer and its associated resources. It also + contains experimental methods for accessing the pbuffer's contents + as a texture map and enabling rendering to floating-point frame + buffers. These methods are not guaranteed to be supported on all + platforms and may change or be removed in a future release. */ public interface GLPbuffer extends GLAutoDrawable { /** Indicates the GL_APPLE_float_pixels extension is being used for this pbuffer. */ @@ -71,12 +72,12 @@ public interface GLPbuffer extends GLAutoDrawable { /** Unbinds the pbuffer from its internal texture target. */ public void releaseTexture(); - /** Queries initialization status of this pBuffer. */ - public boolean isInitialized(); - /** Destroys the native resources associated with this pbuffer. It is not valid to call display() or any other routines on this - pbuffer after it has been destroyed. */ + pbuffer after it has been destroyed. Before destroying the + pbuffer, the application must destroy any additional OpenGL + contexts which have been created for the pbuffer via {@link + #createContext}. */ public void destroy(); /** Indicates which vendor's extension is being used to support |