From 861125339541de2670950aa66a496643ca5cf029 Mon Sep 17 00:00:00 2001
From: Sven Gothel <sgothel@jausoft.com>
Date: Tue, 14 Mar 2023 14:24:03 +0100
Subject: Graph: Region: Add API doc on markStateDirty() and markShapeDirty()

---
 src/jogl/classes/com/jogamp/graph/curve/Region.java | 18 +++++++++++++-----
 1 file changed, 13 insertions(+), 5 deletions(-)

(limited to 'src/jogl/classes/com/jogamp/graph')

diff --git a/src/jogl/classes/com/jogamp/graph/curve/Region.java b/src/jogl/classes/com/jogamp/graph/curve/Region.java
index 0ffcad2c1..3ae5ef9d2 100644
--- a/src/jogl/classes/com/jogamp/graph/curve/Region.java
+++ b/src/jogl/classes/com/jogamp/graph/curve/Region.java
@@ -232,7 +232,7 @@ public abstract class Region {
     protected abstract void pushIndices(int idx1, int idx2, int idx3);
 
     /**
-     * Return bit-field of render modes, see {@link GLRegion#create(GLProfile, int, TextureSequence)}.
+     * Return bit-field of render modes, see {@link GLRegion#create(GLProfile, int, TextureSequence) create(..)}.
      */
     public final int getRenderModes() { return renderModes; }
 
@@ -663,8 +663,14 @@ public abstract class Region {
     }
 
     /**
-     * Mark this region's shape dirty, i.e. it's
-     * Vertices, Triangles, and or Lines changed.
+     * Mark this region's shape dirty,
+     * i.e. its vertices, triangles, lines and/or color-texture coordinates changed.
+     * <p>
+     * The data will be re-uploaded to the GPU at next {@link GLRegion#draw(com.jogamp.opengl.GL2ES2, com.jogamp.graph.curve.opengl.RegionRenderer, int[]) draw(..)}.
+     * </p>
+     * <p>
+     * In 2-pass mode, this implies updating the FBO itself as well.
+     * </p>
      */
     public final void markShapeDirty() {
         dirty |= DIRTY_SHAPE;
@@ -674,8 +680,10 @@ public abstract class Region {
         return 0 != ( dirty & DIRTY_SHAPE ) ;
     }
     /**
-     * Mark this region's state dirty, i.e.
-     * it's render attributes or parameters changed.
+     * Mark this region's render-state dirty, i.e. enforce rendering the region into the FBO in 2-pass mode.
+     * <p>
+     * In 1-pass mode, this state has no effect since the region is always rendered to the current write-drawable.
+     * </p>
      */
     public final void markStateDirty() {
         dirty |= DIRTY_STATE;
-- 
cgit v1.2.3