com.sun.scenario.effect

Class BoxBlur

java.lang.Object

com.sun.scenario.effect.Effect

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

com.sun.scenario.effect.CoreEffect<LinearConvolveRenderState>

com.sun.scenario.effect.LinearConvolveCoreEffect

com.sun.scenario.effect.BoxBlur

public class BoxBlur
extends LinearConvolveCoreEffect

A blur effect using a box-shaped convolution kernel, with a configurable size for each dimension of the kernel and a number of passes to control the quality of the blur.

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 BoxBlurState	state

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

DefaultInput

Constructor Summary

Constructors

Constructor and Description
BoxBlur() Constructs a new BoxBlur effect with the default blur sizes (1, 1) and the default number of passes (1), using the default input for source data.
BoxBlur(int hsize, int vsize) Constructs a new BoxBlur effect with the given blur sizes and the default number of passes (1), using the default input for source data.
BoxBlur(int hsize, int vsize, int passes) Constructs a new BoxBlur effect with the given blur sizes and number of passes, using the default input for source data.
BoxBlur(int hsize, int vsize, int passes, Effect input) Constructs a new BoxBlur effect with the given blur sizes and number of passes, using the output of the specified effect for source data.

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.
int	getHorizontalSize() Returns the horizontal size of the effect kernel.
Effect	getInput() Returns the input for this Effect.
int	getPasses() Returns the number of passes of the effect kernel to control the quality of the blur.
Rectangle	getResultBounds(BaseTransform transform, Rectangle outputClip, ImageData... inputDatas)
(package private) LinearConvolveKernel	getState() Returns state object that is associated with this effect instance.
int	getVerticalSize() Returns the vertical size of the effect kernel.
boolean	reducesOpaquePixels() Whether an opacity for any pixel is different (lower) than the corresponding pixel in the default input.
void	setHorizontalSize(int hsize) Sets the horizontal size of the effect kernel.
void	setInput(Effect input) Sets the input for this Effect.
void	setPasses(int passes) Sets the number of passes of the effect kernel to control the quality of the blur.
void	setVerticalSize(int vsize) Sets the vertical size of the effect kernel.

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

filterImageDatas, getRenderState

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

getPeer, updatePeerKey, updatePeerKey

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, getDefaultedInput, getDefaultedInput, getInputs, getNumInputs, releaseCompatibleImage, setInput, transformBounds

Methods inherited from class java.lang.Object

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

Field Detail

state

private final BoxBlurState state

Constructor Detail

BoxBlur

public BoxBlur()

Constructs a new BoxBlur effect with the default blur sizes (1, 1) and the default number of passes (1), using the default input for source data. This is a shorthand equivalent to:

     new BoxBlur(1, 1, 1, DefaultInput)
 

BoxBlur

public BoxBlur(int hsize,
               int vsize)

Constructs a new BoxBlur effect with the given blur sizes and the default number of passes (1), using the default input for source data. This is a shorthand equivalent to:

     new BoxBlur(hsize, vsize, 1, DefaultInput)
 

Parameters:

hsize - the horizontal size of the BoxBlur kernel

vsize - the vertical size of the BoxBlur kernel

Throws:

java.lang.IllegalArgumentException - if either hsize or vsize is outside the allowable range

BoxBlur

public BoxBlur(int hsize,
               int vsize,
               int passes)

Constructs a new BoxBlur effect with the given blur sizes and number of passes, using the default input for source data. This is a shorthand equivalent to:

     new BoxBlur(hsize, vsize, passes, DefaultInput)
 

Parameters:

hsize - the horizontal size of the BoxBlur kernel

vsize - the vertical size of the BoxBlur kernel

passes - the number of blur passes to execute

Throws:

java.lang.IllegalArgumentException - if either hsize or vsize or passes is outside the allowable range

BoxBlur

public BoxBlur(int hsize,
               int vsize,
               int passes,
               Effect input)

Constructs a new BoxBlur effect with the given blur sizes and number of passes, using the output of the specified effect for source data.

Parameters:

hsize - the horizontal size of the BoxBlur kernel

vsize - the vertical size of the BoxBlur kernel

passes - the number of blur passes to execute

input - the single input Effect

Throws:

java.lang.IllegalArgumentException - if either hsize or vsize or passes is outside the allowable range

Method Detail

getState

LinearConvolveKernel getState()

Description copied from class: Effect

Returns state object that is associated with this effect instance. Subclasses may override this method to return some sort of state object that contains implementation details that are hidden from the public API. Classes outside this package can use the AccessHelper class to get access to this package-private method.

Specified by:

getState in class LinearConvolveCoreEffect

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. 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

getHorizontalSize

public int getHorizontalSize()

Returns the horizontal size of the effect kernel.

Returns:

the horizontal size of the effect kernel

setHorizontalSize

public final void setHorizontalSize(int hsize)

Sets the horizontal size of the effect kernel.

       Min:   0
       Max: 255
   Default:   1
  Identity:   0
 

Parameters:

hsize - the horizontal size of the effect kernel

Throws:

java.lang.IllegalArgumentException - if hsize is outside the allowable range

getVerticalSize

public int getVerticalSize()

Returns the vertical size of the effect kernel.

Returns:

the vertical size of the effect kernel

setVerticalSize

public final void setVerticalSize(int vsize)

Sets the vertical size of the effect kernel.

       Min:   0
       Max: 255
   Default:   1
  Identity:   0
 

Parameters:

vsize - the vertical size of the effect kernel

Throws:

java.lang.IllegalArgumentException - if vsize is outside the allowable range

getPasses

public int getPasses()

Returns the number of passes of the effect kernel to control the quality of the blur.

Returns:

the number of passes of the effect kernel

setPasses

public final void setPasses(int passes)

Sets the number of passes of the effect kernel to control the quality of the blur.

       Min:   0
       Max:   3
   Default:   1
  Identity:   0
 

A setting of 1 creates a low quality blur. A setting of 3 creates a blur that is very close to a Gaussian blur.

Parameters:

passes -

Throws:

java.lang.IllegalArgumentException - if passes is outside the allowable range

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.

Overrides:

getAccelType in class CoreEffect<LinearConvolveRenderState>

Returns:

one of the AccelType values

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