Merge pull request #2 from xxDark/master

Add PixelPainter to reduce memory churn

Author: Col-E

src/main/java/software/coley/bentofx/control/PixelCanvas.java

@@ -3,12 +3,9 @@
 import jakarta.annotation.Nonnull;
 import javafx.scene.canvas.Canvas;
 import javafx.scene.image.ImageView;
-import javafx.scene.image.PixelFormat;
 import javafx.scene.image.WritableImage;
 import javafx.scene.layout.Region;
 
-import java.util.Arrays;
-
 /**
  * This is a very simple alternative to {@link Canvas} that <i>does not</i> keep track of draw operations.
  * In some super niche cases, the default canvas is a memory hog, where this operates on a flat ARGB {@code int[]}.
@@ -18,25 +15,25 @@
 public class PixelCanvas extends Region {
 	private static final int OP_RECT_FILL = 100;
 	private static final int OP_PX_SET = 200;
+	/** Pixel painter. */
+	private final PixelPainter pixelPainter;
 	/** Wrapped display. */
 	private final ImageView view = new ImageView();
-	/** The image to draw with. */
+	/** The image to display. */
 	private WritableImage image;
-	/** ARGB pixel buffer to draw with. */
-	private int[] drawBuffer;
-	/** Current width of {@link #image}. */
-	private int imageWidth;
-	/** Current height of {@link #image}. */
-	private int imageHeight;
 	/** Last committed draw hash. */
 	private int lastDrawHash;
 	/** Current draw hash. */
 	private int currentDrawHash;
 
 	/**
 	 * New pixel canvas.
+	 *
+	 * @param pixelPainter
+	 *  		Painter to draw pixels.
 	 */
-	public PixelCanvas() {
+	public PixelCanvas(@Nonnull PixelPainter pixelPainter) {
+		this.pixelPainter = pixelPainter;
 		getChildren().add(view);
 
 		view.fitWidthProperty().bind(widthProperty());
@@ -46,15 +43,25 @@ public PixelCanvas() {
 		heightProperty().addListener((ob, old, cur) -> markDirty());
 	}
 
+	/**
+	 * New pixel canvas.
+	 */
+	public PixelCanvas() {
+		this(new PixelPainter());
+	}
+
 	/**
 	 * New pixel canvas.
 	 *
+	 * @param pixelPainter
+	 * 		Painter to draw pixels.
 	 * @param width
 	 * 		Assigned width.
 	 * @param height
 	 * 		Assigned height.
 	 */
-	public PixelCanvas(int width, int height) {
+	public PixelCanvas(@Nonnull PixelPainter pixelPainter, int width, int height) {
+		this.pixelPainter = pixelPainter;
 		getChildren().add(view);
 
 		setMinSize(width, height);
@@ -65,15 +72,27 @@ public PixelCanvas(int width, int height) {
 		view.setFitHeight(height);
 	}
 
+	/**
+	 * New pixel canvas.
+	 *
+	 * @param width
+	 * 		Assigned width.
+	 * @param height
+	 * 		Assigned height.
+	 */
+	public PixelCanvas(int width, int height) {
+		this(new PixelPainter(), width, height);
+	}
+
 	/**
 	 * Commits any pending state in the canvas buffer to the display.
 	 */
 	public void commit() {
 		if (lastDrawHash == currentDrawHash) return;
 		lastDrawHash = currentDrawHash;
 
-		checkDirty();
-		image.getPixelWriter().setPixels(0, 0, imageWidth, imageHeight, PixelFormat.getIntArgbInstance(), drawBuffer, 0, imageWidth);
+		pixelPainter.commit(image.getPixelWriter());
+		view.setImage(image);
 	}
 
 	/**
@@ -133,10 +152,7 @@ public void fillRect(double x, double y, double width, double height, int color)
 	 */
 	public void fillRect(int x, int y, int width, int height, int color) {
 		updateDrawHash(hash(OP_RECT_FILL, x, y, width, height));
-		adaptEach(x, y, width, height, (lx, ly, i) -> {
-			if (i >= 0 && i < drawBuffer.length)
-				drawBuffer[i] = color;
-		});
+		pixelPainter.fillRect(x, y, width, height, color);
 	}
 
 	/**
@@ -176,10 +192,8 @@ public void drawRect(double x, double y, double width, double height, double bor
 	 * 		Color to draw.
 	 */
 	public void drawRect(int x, int y, int width, int height, int borderSize, int color) {
-		fillRect(x, y, width, borderSize, color);
-		fillRect(x, y + height - borderSize, width, borderSize, color);
-		fillRect(x, y + borderSize, borderSize, height - borderSize, color);
-		fillRect(x + width - borderSize, y + borderSize, borderSize, height - borderSize, color);
+		updateDrawHash(hash(x, y, width, height, borderSize, color));
+		pixelPainter.drawRect(x, y, width, height, borderSize, color);
 	}
 
 	/**
@@ -215,7 +229,8 @@ public void drawHorizontalLine(double x, double y, double lineLength, double lin
 	 * 		Color to draw.
 	 */
 	public void drawHorizontalLine(int x, int y, int lineLength, int lineWidth, int color) {
-		fillRect(x, y - Math.max(1, lineWidth / 2), lineLength, lineWidth, color);
+		updateDrawHash(hash(x, y, lineLength, lineWidth, color));
+		pixelPainter.drawHorizontalLine(x, y, lineLength, lineWidth, color);
 	}
 
 	/**
@@ -251,7 +266,8 @@ public void drawVerticalLine(double x, double y, double lineLength, double lineW
 	 * 		Color to draw.
 	 */
 	public void drawVerticalLine(int x, int y, int lineLength, int lineWidth, int color) {
-		fillRect(x - Math.max(1, lineWidth / 2), y, lineWidth, lineLength, color);
+		updateDrawHash(hash(x, y, lineLength, lineWidth, color));
+		pixelPainter.drawVerticalLine(x, y, lineLength, lineWidth, color);
 	}
 
 	/**
@@ -266,9 +282,7 @@ public void drawVerticalLine(int x, int y, int lineLength, int lineWidth, int co
 	 */
 	public void setColor(int x, int y, int color) {
 		updateDrawHash(hash(OP_PX_SET, x, y, color));
-		int i = adapt(x, y);
-		if (i >= 0 && i < drawBuffer.length)
-			drawBuffer[i] = color;
+		pixelPainter.setColor(x, y, color);
 	}
 
 	/**
@@ -277,7 +291,7 @@ public void setColor(int x, int y, int color) {
 	public void clear() {
 		currentDrawHash = 0;
 		checkDirty();
-		Arrays.fill(drawBuffer, 0);
+		pixelPainter.clear();
 	}
 
 	/**
@@ -320,12 +334,13 @@ public boolean isDirty() {
 	 */
 	public void markDirty() {
 		image = null;
+		currentDrawHash = ~lastDrawHash;
 	}
 
 	/**
 	 * Check if {@code dirty} and allocates a new buffer when dirty.
 	 */
-	protected void checkDirty() {
+	public void checkDirty() {
 		if (isDirty())
 			reallocate();
 	}
@@ -334,60 +349,13 @@ protected void checkDirty() {
 	 * Allocate the image and associated values.
 	 */
 	protected void reallocate() {
-		imageWidth = (int) Math.max(1, getWidth());
-		imageHeight = (int) Math.max(1, getHeight());
-		image = new WritableImage(imageWidth, imageHeight);
-		drawBuffer = new int[imageWidth * imageHeight];
-		view.setImage(image);
-	}
-
-	/**
-	 * @param x
-	 * 		Canvas x coordinate.
-	 * @param y
-	 * 		Canvas y coordinate.
-	 *
-	 * @return Offset into {@link #drawBuffer}.
-	 */
-	protected int adapt(int x, int y) {
-		return (y * imageWidth) + x;
-	}
+		int imageWidth = (int) Math.max(1, getWidth());
+		int imageHeight = (int) Math.max(1, getHeight());
+		pixelPainter.initialize(imageWidth, imageHeight);
 
-	/**
-	 * @param x
-	 * 		Rect x coordinate.
-	 * @param y
-	 * 		Rect y coordinate.
-	 * @param width
-	 * 		Rect width.
-	 * @param height
-	 * 		Rect height.
-	 * @param consumer
-	 * 		Consumer to operate on all locations in the given rectangle.
-	 */
-	protected void adaptEach(int x, int y, int width, int height, @Nonnull XYConsumer consumer) {
-		int yBound = Math.min(y + height, imageHeight);
-		int xBound = Math.min(x + width, imageWidth);
-		for (int ly = y; ly < yBound; ly++) {
-			int yOffset = ly * imageWidth;
-			for (int lx = x; lx < xBound; lx++) {
-				consumer.consume(lx, ly, yOffset + lx);
-			}
+		WritableImage image = this.image;
+		if (image == null || imageWidth != image.getWidth() || imageHeight != image.getHeight()) {
+			this.image = new WritableImage(imageWidth, imageHeight);
 		}
 	}
-
-	/**
-	 * @see #adaptEach(int, int, int, int, XYConsumer)
-	 */
-	protected interface XYConsumer {
-		/**
-		 * @param x
-		 * 		Canvas x coordinate.
-		 * @param y
-		 * 		Canvas y coordinate.
-		 * @param xy
-		 * 		Offset into {@link #drawBuffer}.
-		 */
-		void consume(int x, int y, int xy);
-	}
 }