aboutsummaryrefslogtreecommitdiffstats
path: root/src/newt/classes/com
diff options
context:
space:
mode:
authorSven Gothel <[email protected]>2019-03-20 15:03:29 +0100
committerSven Gothel <[email protected]>2019-03-20 15:03:29 +0100
commitf4b4716975148111335b9b9e6b2576bbadff160f (patch)
tree19123f95933a206640eea23d209d60f5629127ad /src/newt/classes/com
parent992432a0e2b5e1c510bee246bf4c3990f388c5ea (diff)
JavaFX: Add proper class doc for implementation and unit test
Diffstat (limited to 'src/newt/classes/com')
-rw-r--r--src/newt/classes/com/jogamp/newt/javafx/NewtCanvasJFX.java14
1 files changed, 12 insertions, 2 deletions
diff --git a/src/newt/classes/com/jogamp/newt/javafx/NewtCanvasJFX.java b/src/newt/classes/com/jogamp/newt/javafx/NewtCanvasJFX.java
index 1fe3fa9ba..8da4cfdfe 100644
--- a/src/newt/classes/com/jogamp/newt/javafx/NewtCanvasJFX.java
+++ b/src/newt/classes/com/jogamp/newt/javafx/NewtCanvasJFX.java
@@ -61,9 +61,19 @@ import com.jogamp.newt.event.WindowEvent;
import com.jogamp.newt.util.EDTUtil;
/**
- * JFX {@link Canvas} containing a NEWT {@link Window} using native parenting.
+ * A NEWT based JFX {@link Canvas} specialization allowing a NEWT child {@link Window} to be attached using native parenting.
* <p>
- * Implementation allows use of custom {@link GLCapabilities}.
+ * {@link NewtCanvasJFX} allows utilizing custom {@link GLCapabilities} settings independent from the JavaFX's window
+ * as well as independent rendering from JavaFX's thread.
+ * </p>
+ * <p>
+ * {@link NewtCanvasJFX} allows native parenting operations before and after
+ * it's belonging Group's Scene has been attached to the JavaFX {@link javafx.stage.Window Window}'s actual native window,
+ * i.e. becoming fully realized and visible.
+ * </p>
+ * <p>
+ * Note that {@link JFXAccessor#runOnJFXThread(boolean, Runnable)} is still used to for certain
+ * mandatory JavaFX lifecycle operation on the JavaFX thread.
* </p>
*/
public class NewtCanvasJFX extends Canvas implements WindowClosingProtocol {