diff options
Diffstat (limited to 'src/jogl/classes/com/jogamp/opengl')
| -rw-r--r-- | src/jogl/classes/com/jogamp/opengl/util/GLArrayDataEditable.java | 56 |
1 files changed, 54 insertions, 2 deletions
diff --git a/src/jogl/classes/com/jogamp/opengl/util/GLArrayDataEditable.java b/src/jogl/classes/com/jogamp/opengl/util/GLArrayDataEditable.java index b3e402d3b..9430f585f 100644 --- a/src/jogl/classes/com/jogamp/opengl/util/GLArrayDataEditable.java +++ b/src/jogl/classes/com/jogamp/opengl/util/GLArrayDataEditable.java @@ -1,3 +1,30 @@ +/** + * Copyright 2010-2023 JogAmp Community. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without modification, are + * permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this list of + * conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright notice, this list + * of conditions and the following disclaimer in the documentation and/or other materials + * provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND + * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON + * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF + * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * The views and conclusions contained in the software and documentation are those of the + * authors and should not be interpreted as representing official policies, either expressed + * or implied, of JogAmp Community. + */ package com.jogamp.opengl.util; @@ -35,11 +62,20 @@ public interface GLArrayDataEditable extends GLArrayData { public void destroy(GL gl); /** - * Clears this buffer. + * Clears this buffer and resets states accordingly. * <p> - * Implementation must call {@link #seal(GL, boolean) seal(gl, false)} and {@link #clear()}, + * Implementation calls {@link #seal(GL, boolean) seal(gl, false)} and {@link #clear()}, * i.e. turns-off the GL buffer and then clearing it. * </p> + * <p> + * The position is set to zero, the limit is set to the capacity, and the mark is discarded. + * </p> + * <p> + * Invoke this method before using a sequence of get or put operations to fill this buffer. + * </p> + * <p> + * This method does not actually erase the data in the buffer and will most often be used when erasing the underlying memory is suitable. + * </p> * @see #seal(GL, boolean) * @see #clear() */ @@ -116,6 +152,15 @@ public interface GLArrayDataEditable extends GLArrayData { /** * Clears this buffer and resets states accordingly. + * <p> + * The position is set to zero, the limit is set to the capacity, and the mark is discarded. + * </p> + * <p> + * Invoke this method before using a sequence of get or put operations to fill this buffer. + * </p> + * <p> + * This method does not actually erase the data in the buffer and will most often be used when erasing the underlying memory is suitable. + * </p> * @see #clear(GL) */ public void clear(); @@ -134,7 +179,14 @@ public interface GLArrayDataEditable extends GLArrayData { */ public void seal(boolean seal); + /** + * Rewinds this buffer. The position is set to zero and the mark is discarded. + * <p> + * Invoke this method before a sequence of put or get operations. + * </p> + */ public void rewind(); + public void padding(int doneInByteSize); public void put(Buffer v); |