Documentation changes

husker-dev · Nov 6, 2023 · 8f68528 · 8f68528
1 parent 5804023
commit 8f68528
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 7 deletions.
diff --git a/core/src/main/kotlin/com/huskerdev/openglfx/OpenGLCanvas.kt b/core/src/main/kotlin/com/huskerdev/openglfx/OpenGLCanvas.kt
@@ -45,13 +45,17 @@ abstract class OpenGLCanvas(
          *  - LWJGL_MODULE;
          *  - JOGL_MODULE.
          * @param profile Core/Compatibility OpenGL profile
-         *  - GLProfile.Core;
          *  - GLProfile.Compatibility (default).
+         *  - GLProfile.Core;
          * @param flipY Flip Y axis
-         *  - true - 0 is top;
-         *  - false - 0 is bottom (default).
-         * @param msaa Multisampling quality (use -1 for maximum available samples)
-         * @param multiThread If true, OpenGL will render in different thread
+         *  - false – 0 is bottom (default).
+         *  - true – 0 is top;
+         * @param msaa Multisampling quality
+         *  - 0 – disabled (default);
+         *  - -1 – maximum available samples.
+         * @param multiThread Enables rendering in different thread
+         *  - false – render in JavaFX thread (default);
+         *  - true – render in a new thread and synchronise with JavaFX.
          * @return OpenGLCanvas instance
          */
         @JvmOverloads

diff --git a/lwjgl/src/examples/kotlin/LWJGL.kt b/lwjgl/src/examples/kotlin/LWJGL.kt
@@ -1,7 +1,7 @@
 import com.huskerdev.openglfx.GLProfile
 import com.huskerdev.openglfx.OpenGLCanvas
 import com.huskerdev.openglfx.OpenGLCanvasAnimator
-import com.huskerdev.openglfx.lwjgl.LWJGLExecutor
+import com.huskerdev.openglfx.lwjgl.LWJGLExecutor.Companion.LWJGL_MODULE
 import com.sun.prism.GraphicsPipeline
 import javafx.application.Application
 import javafx.application.Platform
@@ -33,7 +33,7 @@ class ExampleApp: Application(){
     }
 
     private fun createGLCanvas(): OpenGLCanvas {
-        val canvas = OpenGLCanvas.create(LWJGLExecutor.LWJGL_MODULE, msaa = 4, profile = GLProfile.Core, multiThread = true)
+        val canvas = OpenGLCanvas.create(LWJGL_MODULE, msaa = 4, profile = GLProfile.Core, multiThread = true)
         canvas.animator = OpenGLCanvasAnimator(60.0)
 
         val renderExample = ExampleScene()