Documented the ColorFilter interface

gitlab simantics/platform#569

Change-Id: Ib7210842ca58122de6d28293b5780b572f609eab

diff --git a/bundles/org.simantics.scenegraph/src/org/simantics/scenegraph/g2d/color/ColorFilter.java b/bundles/org.simantics.scenegraph/src/org/simantics/scenegraph/g2d/color/ColorFilter.java
index 105f8f7cdd1cdd1ac74cc7ef0a56ee9bf3a9051f..8cb80221a7e2af3762df8f7826364d7d7dc65852 100644 (file)
--- a/bundles/org.simantics.scenegraph/src/org/simantics/scenegraph/g2d/color/ColorFilter.java
+++ b/bundles/org.simantics.scenegraph/src/org/simantics/scenegraph/g2d/color/ColorFilter.java
@@ -13,6 +13,10 @@ package org.simantics.scenegraph.g2d.color;
 
 import java.awt.Color;
 
+/**
+ * Implementations must override <code>equals</code> and <code>hashCode</code> to ensure proper caching of images. 
+ * Filters must also return deterministic results due to caching. 
+ */
 public interface ColorFilter {
     public Color filter(Color c);
 }