feat: new API for extracting Image from a channel given the frame index

AlmasB · Apr 4, 2023 · 87ca500 · 87ca500
1 parent e539eba
commit 87ca500
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/fxgl-core/src/main/kotlin/com/almasb/fxgl/texture/AnimationChannel.kt b/fxgl-core/src/main/kotlin/com/almasb/fxgl/texture/AnimationChannel.kt
@@ -99,6 +99,15 @@ class AnimationChannel(val image: Image,
     fun getFrameWidth(frame: Int) = getFrameData(frame).width
     fun getFrameHeight(frame: Int) = getFrameData(frame).height
 
+    /**
+     * @return a computed image for a given [frameIndex]
+     */
+    fun getFrameImage(frameIndex: Int): Image {
+        val frameData = getFrameData(frameIndex)
+
+        return Texture(image).subTexture(frameData.viewport).image
+    }
+
     /**
      * Returns next frame index or 0 if [frame] is last.
      */