pulpcore.image.filter
Class ColorOverlay

java.lang.Object
  pulpcore.image.filter.Filter
      pulpcore.image.filter.ColorOverlay

public final class ColorOverlay
extends Filter

The ColorOverlay filter fills visible pixels of an input image with a color, optionally drawing the color over the existing input pixels if alpha is less than 255.

Field Summary

Int	alpha The alpha of the overlay, from 0 to 255.
Color	color The overlay color.

Constructor Summary

ColorOverlay(int argbColor)
Creates a ColorOverlay filter with the specified color.

ColorOverlay(int argbColor, int alpha)
Creates a ColorOverlay filter with the specified color and alpha.

Method Summary

Filter	copy() Creates a copy of the Filter for another Sprite to use.
protected void	filter(CoreImage src, CoreImage dst) Performs this filter on the input image onto the specified output image.
boolean	isOpaque() Returns true if the output of this filter is opaque.
void	update(int elapsedTime) Updates the filter.

Methods inherited from class pulpcore.image.filter.Filter

filter, getHeight, getInput, getOutput, getWidth, getX, getY, isDirty, setDirty, setInput

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

color

public final Color color

The overlay color.

alpha

public final Int alpha

The alpha of the overlay, from 0 to 255. For values less than 255, the original input image is visible underneath the overlay color. The default is 255.

Constructor Detail

ColorOverlay

public ColorOverlay(int argbColor)

Creates a ColorOverlay filter with the specified color.

ColorOverlay

public ColorOverlay(int argbColor,
                    int alpha)

Creates a ColorOverlay filter with the specified color and alpha.

Method Detail

copy

public Filter copy()

Description copied from class: Filter

Creates a copy of the Filter for another Sprite to use. The input filter is also copied. The properties of the copy, if any, will be bound to the original filter's properties.

This method is used by the Sprite class. Most apps will not need to call this method.

Subclasses should bind all properties of the cloned object using bindWithInverse(). For example, for the HSBAdjust filter:

        public Filter copy() {
            HSBAdjust copy = new HSBAdjust();
            copy.hue.bindWithInverse(hue);
            copy.brightness.bindWithInverse(brightness);
            copy.saturation.bindWithInverse(saturation);
            return copy;
        }
        

Specified by:

copy in class Filter

isOpaque

public boolean isOpaque()

Description copied from class: Filter

Returns true if the output of this filter is opaque. By default, the output is opaque if the input is opaque.

Overrides:

isOpaque in class Filter

update

public void update(int elapsedTime)

Description copied from class: Filter

Updates the filter. The default method does nothing.

Overrides:

update in class Filter

filter

protected void filter(CoreImage src,
                      CoreImage dst)

Description copied from class: Filter

Performs this filter on the input image onto the specified output image.

This method is called from Filter.getOutput() if Filter.isDirty() returns true. The output image will be the same dimensions as (Filter.getWidth() x Filter.getHeight(). Implementors must ensure that every pixel in output is drawn.

Specified by:

filter in class Filter