From 3f50232fae03c65d7d84a6ca1e2a7b83cefde6ae Mon Sep 17 00:00:00 2001
From: Sven Gothel <sgothel@jausoft.com>
Date: Fri, 23 Jun 2023 06:17:31 +0200
Subject: NIO NativeBuffer, {Element,Pointer}Buffer: Add limit, clear and flip;
 Arrange wrap/deref arguments equal; Add equal set of absolute get/set methods

Completing API to simplify usage by generated code.

All absolute get/set method check arguments itself and against limit(), allow to drop checks in generated code (size).
---
 src/java/com/jogamp/common/nio/NativeBuffer.java | 28 +++++++++++++++++++++---
 1 file changed, 25 insertions(+), 3 deletions(-)

(limited to 'src/java/com/jogamp/common/nio/NativeBuffer.java')

diff --git a/src/java/com/jogamp/common/nio/NativeBuffer.java b/src/java/com/jogamp/common/nio/NativeBuffer.java
index 5ee6af8..76f792e 100644
--- a/src/java/com/jogamp/common/nio/NativeBuffer.java
+++ b/src/java/com/jogamp/common/nio/NativeBuffer.java
@@ -36,27 +36,51 @@ import java.nio.ByteBuffer;
 
 /**
  * Hardware independent container for various kinds of buffers.
- *
+ * <p>
+ * Implementations follow {@link Buffer} semantics, e.g.
+ * <pre>
+ *       0 <= position <= limit <= capacity
+ * </pre>
+ * </p>
  * @author Sven Gothel
  * @author Michael Bien
  */
 @SuppressWarnings("rawtypes")
 public interface NativeBuffer<B extends NativeBuffer> {
 
+    /** Returns byte size of one element */
     public int elementSize();
 
+    /** Returns this buffer's element limit. */
     public int limit();
 
+    /** Sets this buffer's element limit. */
+    public B limit(int newLim);
+
+    /** Returns this buffer's element capacity. */
     public int capacity();
 
+    /** Returns this buffer's element position. */
     public int position();
 
+    /** Sets this buffer's element position. */
     public B position(int newPos);
 
+    /** Returns this buffer's remaining element, i.e. limit - position. */
     public int remaining();
 
+    /** Returns {@link #remaining()} > 0 */
     public boolean hasRemaining();
 
+    /** Sets the limit to the capacity and the position to zero. */
+    public B clear();
+
+    /** Sets the limit to the current position and the position to zero. */
+    public B flip();
+
+    /** Sets the position to zero. */
+    public B rewind();
+
     /**
      * @return true if this buffer has a primitive backup array, otherwise false
      */
@@ -100,8 +124,6 @@ public interface NativeBuffer<B extends NativeBuffer> {
      **/
     public void storeDirectAddress(final ByteBuffer directDest, final int destOffset);
 
-    public B rewind();
-
     /**
      * Relative bulk get method. Copy the source values <code> src[position .. capacity] [</code>
      * to this buffer and increment the position by <code>capacity-position</code>.
-- 
cgit v1.2.3