From d85e49019345d35532a668f9e30f9e98b908886c Mon Sep 17 00:00:00 2001
From: tpietzsch <tobias.pietzsch@gmail.com>
Date: Tue, 7 Jul 2020 22:01:27 +0200
Subject: [PATCH] ProjectorUtils: javadoc
---
src/main/java/bdv/viewer/render/ProjectorUtils.java | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/src/main/java/bdv/viewer/render/ProjectorUtils.java b/src/main/java/bdv/viewer/render/ProjectorUtils.java
index 09dd08e7..8c0b7d47 100644
--- a/src/main/java/bdv/viewer/render/ProjectorUtils.java
+++ b/src/main/java/bdv/viewer/render/ProjectorUtils.java
@@ -7,6 +7,14 @@ import net.imglib2.type.numeric.ARGBType;
public class ProjectorUtils
{
+ /**
+ * Extracts the underlying {@code int[]} array in case {@code img} is a
+ * standard {@code ArrayImg<ARGBType>}. This supports certain (optional)
+ * optimizations in projector implementations.
+ *
+ * @return the underlying {@code int[]} array of {@code img}, if it is a
+ * standard {@code ArrayImg<ARGBType>}. Otherwise {@code null}.
+ */
public static int[] getARGBArrayImgData( final RandomAccessible< ? > img )
{
if ( ! ( img instanceof ArrayImg ) )
--
GitLab