aboutsummaryrefslogtreecommitdiffstats
path: root/src/jogl/classes/com/jogamp/opengl/util/GLPixelBuffer.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/jogl/classes/com/jogamp/opengl/util/GLPixelBuffer.java')
-rw-r--r--src/jogl/classes/com/jogamp/opengl/util/GLPixelBuffer.java14
1 files changed, 12 insertions, 2 deletions
diff --git a/src/jogl/classes/com/jogamp/opengl/util/GLPixelBuffer.java b/src/jogl/classes/com/jogamp/opengl/util/GLPixelBuffer.java
index a921a2818..223c23ebb 100644
--- a/src/jogl/classes/com/jogamp/opengl/util/GLPixelBuffer.java
+++ b/src/jogl/classes/com/jogamp/opengl/util/GLPixelBuffer.java
@@ -324,9 +324,19 @@ public class GLPixelBuffer {
/** The {@link GLPixelAttributes}. */
public final GLPixelAttributes pixelAttributes;
- /** Width in pixels. */
+ /**
+ * Width in pixels, representing {@link #buffer}'s {@link #byteSize}.
+ * <p>
+ * May not represent actual image width as user may re-use buffer for different dimensions, see {@link #requiresNewBuffer(GL, int, int, int)}.
+ * </p>
+ */
public final int width;
- /** Height in pixels. */
+ /**
+ * Height in pixels, representing {@link #buffer}'s {@link #byteSize}.
+ * <p>
+ * May not represent actual image height as user may re-use buffer for different dimensions, see {@link #requiresNewBuffer(GL, int, int, int)}.
+ * </p>
+ */
public final int height;
/** Depth in pixels. */
public final int depth;