diff options
author | Sven Gothel <[email protected]> | 2015-03-12 13:18:02 +0100 |
---|---|---|
committer | Sven Gothel <[email protected]> | 2015-03-12 13:18:02 +0100 |
commit | d9fe5c4aee7547bb89571c19c89ad173b63a4598 (patch) | |
tree | edd4115d8bedf50a74ddcda006985cf0a7508551 /src/jogl | |
parent | 99f14475993d127f1b927056b309477753563a02 (diff) |
Fix API Doc: GLBufferObjectTracker / GLBufferStorage
Diffstat (limited to 'src/jogl')
-rw-r--r-- | src/jogl/classes/com/jogamp/opengl/GLBufferStorage.java | 19 | ||||
-rw-r--r-- | src/jogl/classes/jogamp/opengl/GLBufferObjectTracker.java | 15 |
2 files changed, 22 insertions, 12 deletions
diff --git a/src/jogl/classes/com/jogamp/opengl/GLBufferStorage.java b/src/jogl/classes/com/jogamp/opengl/GLBufferStorage.java index 35ecf8799..d027e36d7 100644 --- a/src/jogl/classes/com/jogamp/opengl/GLBufferStorage.java +++ b/src/jogl/classes/com/jogamp/opengl/GLBufferStorage.java @@ -42,7 +42,8 @@ import java.nio.IntBuffer; * Buffer storage is created via: * <ul> * <li>{@link GL#glBufferData(int, long, java.nio.Buffer, int)} - storage creation via target</li> - * <li>{@link GL2#glNamedBufferData(int, long, java.nio.Buffer, int)} - storage creation, direct</li> + * <li>{@link GL2#glNamedBufferDataEXT(int, long, java.nio.Buffer, int)} - storage creation, direct</li> + * <li>{@link GL4#glNamedBufferData(int, long, java.nio.Buffer, int)} - storage creation, direct</li> * <li>{@link GL4#glBufferStorage(int, long, Buffer, int)} - storage creation via target</li> * <li>{@link GL4#glNamedBufferStorage(int, long, Buffer, int)} - storage creation, direct</li> * </ul> @@ -54,7 +55,8 @@ import java.nio.IntBuffer; * <ul> * <li>{@link GL#glDeleteBuffers(int, IntBuffer)} - explicit, direct, via {@link #notifyBuffersDeleted(int, IntBuffer)} or {@link #notifyBuffersDeleted(int, int[], int)}</li> * <li>{@link GL#glBufferData(int, long, java.nio.Buffer, int)} - storage recreation via target</li> - * <li>{@link GL2#glNamedBufferData(int, long, java.nio.Buffer, int)} - storage recreation, direct</li> + * <li>{@link GL2#glNamedBufferDataEXT(int, long, java.nio.Buffer, int)} - storage recreation, direct</li> + * <li>{@link GL4#glNamedBufferData(int, long, java.nio.Buffer, int)} - storage recreation, direct</li> * <li>{@link GL4#glBufferStorage(int, long, Buffer, int)} - storage recreation via target</li> * <li>{@link GL4#glNamedBufferStorage(int, long, Buffer, int)} - storage recreation, direct</li> * </ul> @@ -62,21 +64,26 @@ import java.nio.IntBuffer; * <p> * GL buffer storage is mapped via * <ul> - * * <li>{@link GL#mapBuffer(int, int)}</li> * <li>{@link GL#mapBufferRange(int, long, long, int)}</li> - * <li>{@link GL2#mapNamedBuffer(int, int)}</li> - * <li>{@link GL2#mapNamedBufferRange(int, long, long, int)}</li> + * <li>{@link GL2#mapNamedBufferEXT(int, int)}</li> + * <li>{@link GL2#mapNamedBufferRangeEXT(int, long, long, int)}</li> + * <li>{@link GL4#mapNamedBuffer(int, int)}</li> + * <li>{@link GL4#mapNamedBufferRange(int, long, long, int)}</li> * </ul> * </p> * <p> * GL buffer storage is unmapped via * <ul> + * <li>{@link GL#glDeleteBuffers(int, IntBuffer)} - buffer deletion</li> * <li>{@link GL#glUnmapBuffer(int)} - explicit via target</li> * <li>{@link GL2#glUnmapNamedBufferEXT(int)} - explicit direct</li> + * <li>{@link GL4#glUnmapNamedBuffer(int)} - explicit direct</li> * <li>{@link GL#glBufferData(int, long, java.nio.Buffer, int)} - storage recreation via target</li> * <li>{@link GL2#glNamedBufferDataEXT(int, long, java.nio.Buffer, int)} - storage recreation, direct</li> - * <li>{@link GL#glDeleteBuffers(int, IntBuffer)} - buffer deletion</li> + * <li>{@link GL4#glNamedBufferData(int, long, java.nio.Buffer, int)} - storage recreation, direct</li> + * <li>{@link GL4#glBufferStorage(int, long, Buffer, int)} - storage creation via target</li> + * <li>{@link GL4#glNamedBufferStorage(int, long, Buffer, int)} - storage creation, direct</li> * </ul> * </p> */ diff --git a/src/jogl/classes/jogamp/opengl/GLBufferObjectTracker.java b/src/jogl/classes/jogamp/opengl/GLBufferObjectTracker.java index 89b23139f..717ee2cab 100644 --- a/src/jogl/classes/jogamp/opengl/GLBufferObjectTracker.java +++ b/src/jogl/classes/jogamp/opengl/GLBufferObjectTracker.java @@ -33,7 +33,6 @@ import java.nio.ByteBuffer; import java.nio.IntBuffer; import com.jogamp.opengl.*; - import com.jogamp.common.ExceptionUtils; import com.jogamp.common.nio.Buffers; import com.jogamp.common.util.IntObjectHashMap; @@ -48,7 +47,8 @@ import com.jogamp.common.util.PropertyAccess; * Buffer storage is created via * <ul> * <li>{@link GL#glBufferData(int, long, java.nio.Buffer, int)} - storage recreation with target via {@link #createBufferStorage(GLBufferStateTracker, GL, int, long, Buffer, int, int, CreateStorageDispatch, long)}</li> - * <li>{@link GL2#glNamedBufferData(int, long, java.nio.Buffer, int)} - storage recreation, direct, via {@link #createBufferStorage(GL, int, long, Buffer, int, CreateStorageDispatch, long)}</li> + * <li>{@link GL2#glNamedBufferDataEXT(int, long, java.nio.Buffer, int)} - storage recreation, direct, via {@link #createBufferStorage(GL, int, long, Buffer, int, CreateStorageDispatch, long)}</li> + * <li>{@link GL4#glNamedBufferData(int, long, java.nio.Buffer, int)} - storage recreation, direct, via {@link #createBufferStorage(GL, int, long, Buffer, int, CreateStorageDispatch, long)}</li> * <li>{@link GL4#glBufferStorage(int, long, Buffer, int)} - storage creation with target via {@link #createBufferStorage(GLBufferStateTracker, GL, int, long, Buffer, int, int, CreateStorageDispatch, long)}</li> * <li>{@link GL4#glNamedBufferStorage(int, long, Buffer, int)} - storage recreation, direct, via {@link #createBufferStorage(GL, int, long, Buffer, int, CreateStorageDispatch, long)}</li> * </ul> @@ -60,7 +60,8 @@ import com.jogamp.common.util.PropertyAccess; * <ul> * <li>{@link GL#glDeleteBuffers(int, IntBuffer)} - explicit, direct, via {@link #notifyBuffersDeleted(int, IntBuffer)} or {@link #notifyBuffersDeleted(int, int[], int)}</li> * <li>{@link GL#glBufferData(int, long, java.nio.Buffer, int)} - storage recreation via target</li> - * <li>{@link GL2#glNamedBufferData(int, long, java.nio.Buffer, int)} - storage recreation, direct</li> + * <li>{@link GL2#glNamedBufferDataEXT(int, long, java.nio.Buffer, int)} - storage recreation, direct</li> + * <li>{@link GL4#glNamedBufferData(int, long, java.nio.Buffer, int)} - storage recreation, direct</li> * <li>{@link GL4#glBufferStorage(int, long, Buffer, int)} - storage recreation via target</li> * <li>{@link GL4#glNamedBufferStorage(int, long, Buffer, int)} - storage recreation, direct</li> * </ul> @@ -191,7 +192,9 @@ public class GLBufferObjectTracker { } /** - * Must be called when [re]creating the GL buffer object via {@link GL2#glNamedBufferData(int, long, java.nio.Buffer, int)} + * Must be called when [re]creating the GL buffer object + * via {@link GL2#glNamedBufferDataEXT(int, long, java.nio.Buffer, int) glNamedBufferDataEXT}, + * {@link GL4#glNamedBufferData(int, long, java.nio.Buffer, int) glNamedBufferData}, * and {@link GL4#glNamedBufferStorage(int, long, Buffer, int)}, * i.e. implies destruction of the buffer. * @@ -318,7 +321,7 @@ public class GLBufferObjectTracker { return this.mapBufferImpl(bufferStateTracker, caller, target, true /* useRange */, offset, length, access, dispatch); } /** - * Must be called when mapping GL buffer objects via {@link GL2#mapNamedBuffer(int, int)}. + * Must be called when mapping GL buffer objects via {@link GL2#mapNamedBufferEXT(int, int)}. * @throws GLException if buffer is not tracked * @throws GLException if buffer is already mapped * @throws GLException if buffer has invalid store size, i.e. less-than zero @@ -327,7 +330,7 @@ public class GLBufferObjectTracker { return this.mapBufferImpl(0 /* target */, bufferName, true /* isNamedBuffer */, false /* useRange */, 0 /* offset */, 0 /* length */, access, dispatch); } /** - * Must be called when mapping GL buffer objects via {@link GL2#mapNamedBufferRange(int, long, long, int)}. + * Must be called when mapping GL buffer objects via {@link GL2#mapNamedBufferRangeEXT(int, long, long, int)}. * @throws GLException if buffer is not tracked * @throws GLException if buffer is already mapped * @throws GLException if buffer has invalid store size, i.e. less-than zero |