com.sun.scenario.effect

Class GaussianBlur

java.lang.Object

com.sun.scenario.effect.Effect

com.sun.scenario.effect.FilterEffect<T>

com.sun.scenario.effect.LinearConvolveCoreEffect

com.sun.scenario.effect.GaussianBlur

public class GaussianBlur
extends LinearConvolveCoreEffect

A blur effect using a Gaussian convolution kernel, with a configurable radius.

Nested Class Summary

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

Effect.AccelType

Field Summary

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

DefaultInput

Constructor Summary

Constructors

Constructor and Description
GaussianBlur() Constructs a new GaussianBlur effect with the default radius (10.0), using the default input for source data.
GaussianBlur(float radius) Constructs a new GaussianBlur effect with the given radius, using the default input for source data.
GaussianBlur(float radius, Effect input) Constructs a new GaussianBlur effect with the given radius.

Method Summary

Modifier and Type	Method and Description
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.
Effect	getInput() Returns the input for this Effect.
float	getRadius() Returns the radius of the Gaussian kernel.
Rectangle	getResultBounds(BaseTransform transform, Rectangle outputClip, ImageData... inputDatas)
boolean	reducesOpaquePixels() Whether an opacity for any pixel is different (lower) than the corresponding pixel in the default input.
void	setInput(Effect input) Sets the input for this Effect to a specific Effect or to the default input if input is null.
void	setRadius(float radius) Sets the radius of the Gaussian kernel.

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

filterImageDatas, getRenderState

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

filter, transform, untransform, untransformClip

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

combineBounds, combineBounds, createCompatibleImage, ensureTransform, getCompatibleImage, getInputs, getNumInputs, releaseCompatibleImage, setInput, transformBounds

Methods inherited from class java.lang.Object

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

Constructor Detail

GaussianBlur

public GaussianBlur()

Constructs a new GaussianBlur effect with the default radius (10.0), using the default input for source data. This is a shorthand equivalent to:

     new GaussianBlur(10f, DefaultInput)
 

GaussianBlur

public GaussianBlur(float radius)

Constructs a new GaussianBlur effect with the given radius, using the default input for source data. This is a shorthand equivalent to:

     new GaussianBlur(radius, DefaultInput)
 

Parameters:

radius - the radius of the Gaussian kernel

Throws:

IllegalArgumentException - if radius is outside the allowable range

GaussianBlur

public GaussianBlur(float radius,
                    Effect input)

Constructs a new GaussianBlur effect with the given radius.

Parameters:

radius - the radius of the Gaussian kernel

input - the single input Effect

Throws:

IllegalArgumentException - if radius is outside the allowable range, or if input is null

Method Detail

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.

Returns:

one of the AccelType values

getInput

public final Effect getInput()

Returns the input for this Effect.

Returns:

the input for this Effect

setInput

public void setInput(Effect input)

Sets the input for this Effect to a specific Effect or to the default input if input is null.

Parameters:

input - the input for this Effect

getRadius

public float getRadius()

Returns the radius of the Gaussian kernel.

Returns:

the radius of the Gaussian kernel

setRadius

public void setRadius(float radius)

Sets the radius of the Gaussian kernel.

       Min:  0.0
       Max: 63.0
   Default: 10.0
  Identity:  0.0
 

Parameters:

radius - the radius of the Gaussian kernel

Throws:

IllegalArgumentException - if radius is outside the allowable range

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.

Overrides:

getBounds in class FilterEffect<LinearConvolveRenderState>

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

getResultBounds

public Rectangle getResultBounds(BaseTransform transform,
                                 Rectangle outputClip,
                                 ImageData... inputDatas)

Overrides:

getResultBounds in class Effect

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