diff --git a/src/main/java/bdv/viewer/render/ProjectorUtils.java b/src/main/java/bdv/viewer/render/ProjectorUtils.java index 09dd08e73115794eff36a1575cbbcb1a69f02526..8c0b7d476ad4ef4a2a9b532703c43069ac1d0536 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 ) )