T - the specific subclass of RenderState returned from the
#getRenderState() method.public abstract class FilterEffect<T extends RenderState> extends Effect
Effect subclasses that operate
by filtering the inputs at the pixel level.Effect.AccelTypeDefaultInput| Modifier | Constructor and Description |
|---|---|
protected |
FilterEffect() |
protected |
FilterEffect(Effect input) |
protected |
FilterEffect(Effect input1,
Effect input2) |
| Modifier and Type | Method and Description |
|---|---|
ImageData |
filter(FilterContext fctx,
BaseTransform transform,
Rectangle outputClip,
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. |
protected abstract ImageData |
filterImageDatas(FilterContext fctx,
BaseTransform transform,
Rectangle outputClip,
T rstate,
ImageData... inputDatas) |
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. |
abstract T |
getRenderState(FilterContext fctx,
BaseTransform transform,
Rectangle outputClip,
Object renderHelper,
Effect defaultInput)
Returns the object representing the rendering strategy and state for
the filter operation characterized by the specified arguments.
|
Point2D |
transform(Point2D p,
Effect defaultInput)
Transform the specified point
p from the coordinate space
of the primary content input to the coordinate space of the effect
output. |
Point2D |
untransform(Point2D p,
Effect defaultInput)
Transform the specified point
p from the coordinate space
of the output of the effect into the coordinate space of the
primary content input. |
protected static Rectangle |
untransformClip(BaseTransform transform,
Rectangle clip) |
combineBounds, combineBounds, createCompatibleImage, ensureTransform, getAccelType, getCompatibleImage, getDirtyRegions, getInputs, getNumInputs, getResultBounds, reducesOpaquePixels, releaseCompatibleImage, setInput, transformBoundsprotected FilterEffect()
protected FilterEffect(Effect input)
public BaseBounds getBounds(BaseTransform transform, Effect defaultInput)
Effecttransform,
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.protected static Rectangle untransformClip(BaseTransform transform, Rectangle clip)
public abstract T getRenderState(FilterContext fctx, BaseTransform transform, Rectangle outputClip, Object renderHelper, Effect defaultInput)
FilterContext object may be null.
outputClip and renderHelper may always be null just
as they may be null for a given filter operation.fctx - the context object that would be used by the Renderer
if this call is preparing for a render operation, or nulltransform - the transform for the output of this operationoutputClip - the clip rectangle that may restrict this operation, or nullrenderHelper - the rendering helper object that can be used to shortcut
this operation under certain conditions, or nulldefaultInput - the Effect to be used in place of any null inputspublic ImageData filter(FilterContext fctx, BaseTransform transform, Rectangle outputClip, Object renderHelper, Effect defaultInput)
EffectEffects 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);
filter in class Effectfctx - the FilterContext that determines the
environment (e.g. the graphics device or code path) on which
the filter operation will be performedtransform - an optional transform under which the filter and
its inputs will be viewedoutputClip - 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.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.public Point2D transform(Point2D p, Effect defaultInput)
Effectp from the coordinate space
of the primary content input to the coordinate space of the effect
output.
In essence, this method asks the question "Which output coordinate
is most affected by the data at the specified coordinate in the
primary source input?"
The definition of which input represents the primary content input
and how the coordinate space of that input compares to the coordinate
space of the result varies from effect to effect.
Note that some effects may have a reasonable definition of how to
map source coordinates to destination coordinates, but not the
reverse.
In particular, effects which map source coordinates discontiguously
into the result may have several output coordinates that are affected
by a given input coordinate and may choose to return one of many
equally valid answers, or an undefined result such as NaN,
or some other anomalous value.
Most effects perform simple transformations of the color of each
pixel and so represent an identity transform and return the point
unchanged.
public Point2D untransform(Point2D p, Effect defaultInput)
Effectp from the coordinate space
of the output of the effect into the coordinate space of the
primary content input.
In essence, this method asks the question "Which source coordinate
contributes most to the definition of the output at the specified
coordinate?"
The definition of which input represents the primary content input
and how the coordinate space of that input compares to the coordinate
space of the result varies from effect to effect.
Note that some effects may have a reasonable definition of how to
map destination coordinates back to source coordinates, but not the
reverse.
In particular, effects which produce entirely synthetic results not
based on any content input may not be able to give a meaningful
result to this query and may return undefined coordinates such as
0, Infinity, or NaN.
Most effects perform simple transformations of the color of each
pixel and so represent an identity transform and return the point
unchanged.
untransform in class Effectp - the point in the coordinate space of the result output
to be transformeddefaultInput - the default input Effect to be used in
all cases where a filter has a null inputprotected abstract ImageData filterImageDatas(FilterContext fctx, BaseTransform transform, Rectangle outputClip, T rstate, ImageData... inputDatas)
Copyright © 2021. All rights reserved.