com.sun.scenario.effect

Class Identity

java.lang.Object

com.sun.scenario.effect.Effect

com.sun.scenario.effect.Identity

public class Identity
extends Effect

A type of source effect that returns a version of the given platform-specific image object (e.g. a BufferedImage) that is suitable for the destination FilterContext. No other processing is performed on the specified image object.

Nested Class Summary

Nested classes/interfaces inherited from class com.sun.scenario.effect.Effect

Effect.AccelType

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<FilterContext,ImageData>	datacache
private Point2D	loc
private Filterable	src

Fields inherited from class com.sun.scenario.effect.Effect

DefaultInput

Constructor Summary

Constructors

Constructor and Description
Identity(Filterable src) Constructs a new Identity effect with the given platform-specific image.

Method Summary

Modifier and Type	Method and Description
private void	clearCache()
ImageData	filter(FilterContext fctx, BaseTransform transform, Rectangle outputClip, java.lang.Object renderHelper, Effect defaultInput) Applies this filter effect to the series of images represented by the input Effects and/or the given defaultInput viewed under the given transform.
Effect.AccelType	getAccelType(FilterContext fctx) Returns one of the AccelType values, indicating whether this Effect is accelerated in hardware for the given FilterContext.
BaseBounds	getBounds(BaseTransform transform, Effect defaultInput) Returns the bounding box that will be affected by this filter operation when viewed under the specified transform, given its list of input Effects and the specified defaultInput effect.
DirtyRegionContainer	getDirtyRegions(Effect defaultInput, DirtyRegionPool regionPool) Returns the dirty region container containing dirty regions affected by this filter operation.
Point2D	getLocation() Returns the location of the source image, relative to the untransformed source content bounds.
Filterable	getSource() Returns the source image (can be null).
boolean	reducesOpaquePixels() Whether an opacity for any pixel is different (lower) than the corresponding pixel in the default input.
void	setLocation(Point2D pt) Sets the location of the source image, relative to the untransformed source content bounds.
void	setSource(Filterable src) Sets the source image.

Methods inherited from class com.sun.scenario.effect.Effect

combineBounds, combineBounds, createCompatibleImage, ensureTransform, getCompatibleImage, getDefaultedInput, getDefaultedInput, getInputs, getNumInputs, getResultBounds, getState, releaseCompatibleImage, setInput, transform, transformBounds, untransform

Methods inherited from class java.lang.Object

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

Field Detail

src

private Filterable src

loc

private Point2D loc

datacache

private final java.util.Map<FilterContext,ImageData> datacache

Constructor Detail

Identity

public Identity(Filterable src)

Constructs a new Identity effect with the given platform-specific image.

Parameters:

src - the source image, or null

Method Detail

getSource

public final Filterable getSource()

Returns the source image (can be null).

Returns:

the source image

setSource

public void setSource(Filterable src)

Sets the source image.

Parameters:

src - the source image, or null

getLocation

public final Point2D getLocation()

Returns the location of the source image, relative to the untransformed source content bounds.

Returns:

the location of the source image

setLocation

public void setLocation(Point2D pt)

Sets the location of the source image, relative to the untransformed source content bounds.

Parameters:

pt - the new location of the source image

Throws:

java.lang.IllegalArgumentException - if pt is null

getBounds

public BaseBounds getBounds(BaseTransform transform,
                            Effect defaultInput)

Description copied from class: Effect

Returns the bounding box that will be affected by this filter operation when viewed under the specified transform, given its list of input Effects and the specified defaultInput effect. Note that the returned bounds can be smaller or larger than one or more of the inputs.

Specified by:

getBounds in class Effect

Parameters:

transform - the transform the effect will be viewed under

defaultInput - the default input Effect to be used in all cases where a filter has a null input

Returns:

the bounding box of this filter

filter

public ImageData filter(FilterContext fctx,
                        BaseTransform transform,
                        Rectangle outputClip,
                        java.lang.Object renderHelper,
                        Effect defaultInput)

Description copied from class: Effect

Applies this filter effect to the series of images represented by the input Effects and/or the given defaultInput viewed under the given transform. The filter does not need to create pixel data for any pixels that fall outside of the destination device-space (pixel) bounds specified by the outputClip Rectangle.

The filter might be able to use the renderHelper object to render the results directly on its own if the object is not null and implements an interface, such as ImageHelper, that the filter recognizes. If the effect renders itself then it will return a null for the ImageData result.

Note that the ImageData object returned by this method must be validated prior to use with ImageData.validate(com.sun.scenario.effect.FilterContext) method.

       boolean valid;

       do {
           ImageData res = filter(fctx, transform, clip, renderer, defaultInput);
           if (res == null) {
               break;
           }
           if (valid = res.validate(fctx)) {
               // Render res.getImage() to the appropriate destination
               // or use it as an input to another chain of effects.
           }
           res.unref();
       } while (!valid);
       

Specified by:

filter in class Effect

Parameters:

fctx - the FilterContext that determines the environment (e.g. the graphics device or code path) on which the filter operation will be performed

transform - an optional transform under which the filter and its inputs will be viewed

outputClip - the device space (pixel) bounds of the output image or window or clip into which the result of the Effect will be rendered, or null if the output dimensions are not known.

renderHelper - an object which might be used to render the results of the effect directly.

defaultInput - the default input Effect to be used in all cases where a filter has a null input.

Returns:

the ImageData holding the result of this filter operation or null if the filter had no output or used the renderHelper to render its results directly.

getAccelType

public Effect.AccelType getAccelType(FilterContext fctx)

Description copied from class: Effect

Returns one of the AccelType values, indicating whether this Effect is accelerated in hardware for the given FilterContext.

Specified by:

getAccelType in class Effect

Returns:

one of the AccelType values

clearCache

private void clearCache()

reducesOpaquePixels

public boolean reducesOpaquePixels()

Description copied from class: Effect

Whether an opacity for any pixel is different (lower) than the corresponding pixel in the default input. It is always safe to return true from this method, though the consequences may be that the caller chooses to not utilize a planned optimization.

Specified by:

reducesOpaquePixels in class Effect

Returns:

true if this effect may reduce opacity of some pixels of one of it's input (and thus the default input) or it's relevant input(s) might have reduced opaque pixels of the default input already.

getDirtyRegions

public DirtyRegionContainer getDirtyRegions(Effect defaultInput,
                                            DirtyRegionPool regionPool)

Description copied from class: Effect

Returns the dirty region container containing dirty regions affected by this filter operation.

Overrides:

getDirtyRegions in class Effect

Parameters:

defaultInput - the default input Effect to be used in all cases where a filter has a null input

regionPool - the pool of dirty regions

Returns:

the dirty region container