From: Jussi Koskela <jussi.koskela@semantum.fi>
Date: Thu, 2 Jul 2020 10:11:39 +0000 (+0300)
Subject: Documented the ColorFilter interface
X-Git-Url: https://gerrit.simantics.org/r/gitweb?a=commitdiff_plain;h=735c325ce6b3a6d6fecb8e80f72f326b54fc9c0e;p=simantics%2Fplatform.git

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 105f8f7cd..8cb80221a 100644
--- 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);
 }