TintingFilter (Strange Eons API)

All Superinterfaces:

java.awt.image.BufferedImageOp

All Known Implementing Classes:

AbstractTintingFilter, ReplaceHueSaturationFilter, ShiftHReplaceSBFilter, TintFilter, TintFilter.ScaledTintFilter, TintOverlayFilter
```
public interface TintingFilter
extends java.awt.image.BufferedImageOp
```
An interface implemented by filters that filter an image by adjusting them in the HSB colour space. Classes that implement this interface can be used with a TintCache to optimize performance when a tinted image is drawn repeatedly with infrequent factor changes.

Author:

Chris Jennings

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.awt.image.BufferedImage`	`filter(java.awt.image.BufferedImage source, java.awt.image.BufferedImage dest)`	Apply the filter to `source`, storing the result in `dest`.
`float`	`getBFactor()`	Returns the brightness adjustment factor.
`float`	`getHFactor()`	Returns the hue adjustment factor.
`float`	`getSFactor()`	Returns the saturation adjustment factor.
`boolean`	`isIdentity()`	Returns `true` if applying this filter would have no effect.
`void`	`setFactors(float h, float s, float b)`	Sets the factors that will be used during tinting.

Methods inherited from interface java.awt.image.BufferedImageOp
createCompatibleDestImage, getBounds2D, getPoint2D, getRenderingHints

- Method Detail
  - getHFactor
```
float getHFactor()
```
    Returns the hue adjustment factor.
    
    Returns:
    
    hue factor
  - getSFactor
```
float getSFactor()
```
    Returns the saturation adjustment factor.
    
    Returns:
    
    saturation factor
  - getBFactor
```
float getBFactor()
```
    Returns the brightness adjustment factor.
    
    Returns:
    
    brightness factor
  - setFactors
```
void setFactors(float h,
                float s,
                float b)
```
    Sets the factors that will be used during tinting. The exact effect depends on the particular filter.
    
    Parameters:
    
    h - hue factor
    
    s - saturation factor
    
    b - brightness factor
  - isIdentity
```
boolean isIdentity()
```
    Returns true if applying this filter would have no effect. This can be used as an optimization hint.
    
    Returns:
    
    true if a filtered image would not change
  - filter
```
java.awt.image.BufferedImage filter(java.awt.image.BufferedImage source,
                                    java.awt.image.BufferedImage dest)
```
    Apply the filter to source, storing the result in dest.
    
    Specified by:
    
    filter in interface java.awt.image.BufferedImageOp
    
    Parameters:
    
    source - the source image
    
    dest - the destination image (may be null)
    
    Returns:
    
    the destination image