Adds comments to the captureScreen method in Renderer.scala

PurpleKingdomGames · Oct 19, 2024 · ecf17c5 · ecf17c5
1 parent 3902783
commit ecf17c5
Showing 1 changed file with 38 additions and 1 deletion.
diff --git a/indigo/indigo/src/main/scala/indigo/platform/renderer/Renderer.scala b/indigo/indigo/src/main/scala/indigo/platform/renderer/Renderer.scala
@@ -25,13 +25,50 @@ trait Renderer:
       excludeLayers: Batch[BindingKey],
       imageType: ImageType
   ): ImageData
-  def captureScreen(): ImageData                        = captureScreen(None, Batch.empty, ImageType.PNG)
+
+  /** Capture the screen as a WebP image
+    *
+    * @return
+    */
+  def captureScreen(): ImageData = captureScreen(None, Batch.empty, ImageType.WEBP)
+
+  /** Capture the screen as a WebP image, only capturing the specified rectangle
+    *
+    * @param clippingRect
+    * @return
+    */
   def captureScreen(clippingRect: Rectangle): ImageData = captureScreen(Some(clippingRect), Batch.empty, ImageType.PNG)
+
+  /** Capture the screen as an image, only capturing the specified rectangle, with the specified image type
+    *
+    * @param clippingRect
+    * @param imageType
+    * @return
+    */
   def captureScreen(clippingRect: Rectangle, imageType: ImageType): ImageData =
     captureScreen(Some(clippingRect), Batch.empty, imageType)
+
+  /** Capture the screen as an image, excluding the specified layers
+    *
+    * @param excludeLayers
+    * @return
+    */
   def captureScreen(excludeLayers: Batch[BindingKey]): ImageData = captureScreen(None, excludeLayers, ImageType.PNG)
+
+  /** Capture the screen as an image, excluding the specified layers, with the specified image type
+    *
+    * @param excludeLayers
+    * @param imageType
+    * @return
+    */
   def captureScreen(excludeLayers: Batch[BindingKey], imageType: ImageType): ImageData =
     captureScreen(None, excludeLayers, imageType)
+
+  /** Capture the screen as an image, with the specified image type
+    *
+    * @param imageType
+    * @return
+    */
   def captureScreen(imageType: ImageType): ImageData = captureScreen(None, Batch.empty, imageType)
 
 object Renderer: