aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSven Gothel <[email protected]>2023-03-30 04:02:24 +0200
committerSven Gothel <[email protected]>2023-03-30 04:02:24 +0200
commitc3ae7d6b6ecc98146c2c011aac2edb75af5f928f (patch)
tree36df9dcaea722b7efbfbf4efa37c561249ef33de
parent67cfcbab5497401e15c92746858974c444a0c155 (diff)
Graph*: API doc refinement
-rw-r--r--src/graphui/classes/com/jogamp/graph/ui/gl/GraphShape.java7
-rw-r--r--src/jogl/classes/com/jogamp/graph/curve/Region.java2
2 files changed, 8 insertions, 1 deletions
diff --git a/src/graphui/classes/com/jogamp/graph/ui/gl/GraphShape.java b/src/graphui/classes/com/jogamp/graph/ui/gl/GraphShape.java
index 85037ccd4..8153d2b23 100644
--- a/src/graphui/classes/com/jogamp/graph/ui/gl/GraphShape.java
+++ b/src/graphui/classes/com/jogamp/graph/ui/gl/GraphShape.java
@@ -39,6 +39,7 @@ import com.jogamp.graph.geom.Vertex.Factory;
import com.jogamp.opengl.GL2ES2;
import com.jogamp.opengl.GLProfile;
import com.jogamp.opengl.math.geom.AABBox;
+import com.jogamp.opengl.util.texture.TextureSequence;
/**
* Graph based {@link GLRegion} UI {@link Shape}
@@ -59,12 +60,18 @@ public abstract class GraphShape extends Shape {
private int regionQuality = Region.MAX_QUALITY;
private final List<GLRegion> dirtyRegions = new ArrayList<GLRegion>();
+ /**
+ * Create a Graph based {@link GLRegion} UI {@link Shape}.
+ *
+ * @param renderModes Graph's {@link Region} render modes, see {@link GLRegion#create(GLProfile, int, TextureSequence) create(..)}.
+ */
public GraphShape(final int renderModes) {
super();
this.vertexFactory = OutlineShape.getDefaultVertexFactory();
this.renderModes = renderModes;
}
+ /** Return Graph's {@link Region} render modes, see {@link GLRegion#create(GLProfile, int, TextureSequence) create(..)}. */
public final int getRenderModes() { return renderModes; }
public final int getQuality() { return regionQuality; }
diff --git a/src/jogl/classes/com/jogamp/graph/curve/Region.java b/src/jogl/classes/com/jogamp/graph/curve/Region.java
index 37ae9fc99..6b590a4d8 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) create(..)}.
+ * Returns bit-field of render modes, see {@link GLRegion#create(GLProfile, int, TextureSequence) create(..)}.
*/
public final int getRenderModes() { return renderModes; }