From c3ae7d6b6ecc98146c2c011aac2edb75af5f928f Mon Sep 17 00:00:00 2001 From: Sven Gothel Date: Thu, 30 Mar 2023 04:02:24 +0200 Subject: Graph*: API doc refinement --- src/graphui/classes/com/jogamp/graph/ui/gl/GraphShape.java | 7 +++++++ src/jogl/classes/com/jogamp/graph/curve/Region.java | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) (limited to 'src') 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 dirtyRegions = new ArrayList(); + /** + * 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; } -- cgit v1.2.3