squidpony.IFilter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of squidlib-util Show documentation

SquidLib platform-independent logic and utility code. Please refer to https://github.com/SquidPony/SquidLib .

There is a newer version: 3.0.6

package squidpony;

/**
 * A filter is a function on colors. It is usually used in {@link IColorCenter}
 * to tint all colors.
 * 
 * @author Tommy Ettinger
 * @author smelC
 * @param 
 *            The type of colors that this filter outputs.
 * @see IColorCenter
 */
public interface IFilter {
	/**
	 * @param r
	 *            The red component.
	 * @param g
	 *            The green component.
	 * @param b
	 *            The blue component.
	 * @param a
	 *            The alpha component.
	 * @return An alteration of {@code (r,g,b,a)}.
	 */
	T alter(float r, float g, float b, float a);
}