Top Description Constructors Methods
com.sun.scenario.effect.impl.state

public abstract Class LinearConvolveKernel

extends Object
Class Inheritance
Known Direct Subclasses
com.sun.scenario.effect.impl.state.MotionBlurState, com.sun.scenario.effect.impl.state.HVSeparableKernel
Imports
com.sun.javafx.geom.Rectangle, com.sun.javafx.geom.transform.BaseTransform

The helper class for defining a 1 dimensional linear convolution kernel for either the LinearConvolve or LinearConvolveShadow shaders. This class is abstract and must be subclassed for specific linear convolutions.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public abstract int

Returns:

the size of the kernel for the given pass
getKernelSize
(int
the pass of the algorithm being performed
pass
)

Returns the size of the kernel for a given pass.

public abstract LinearConvolveRenderState
public abstract Rectangle

Returns:

the bounds of the result image
getResultBounds
(Rectangle
the bounds of the input image
srcdimension
,
int
the algorithm pass being performed
pass
)

Returns the size of the output image needed for a given input image dimensions and a given pass of the algorithm.

public boolean

Returns:

true if the operation is a NOP
isNop
()

Returns true if the entire operation of this linear convolution would have no effect on the source data.

public boolean

Returns:

true if this is a Shadow operation
isShadow
()

Returns true if this is a LinearConvolveShadow operation, or false if the operation is a regular LinearConvolve.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

LinearConvolveKernelback to summary
public LinearConvolveKernel()

Method Detail

getKernelSizeback to summary
public abstract int getKernelSize(int pass)

Returns the size of the kernel for a given pass.

Parameters
pass:int

the pass of the algorithm being performed

Returns:int

the size of the kernel for the given pass

getRenderStateback to summary
public abstract LinearConvolveRenderState getRenderState(BaseTransform filtertx)
getResultBoundsback to summary
public abstract Rectangle getResultBounds(Rectangle srcdimension, int pass)

Returns the size of the output image needed for a given input image dimensions and a given pass of the algorithm.

Parameters
srcdimension:Rectangle

the bounds of the input image

pass:int

the algorithm pass being performed

Returns:Rectangle

the bounds of the result image

isNopback to summary
public boolean isNop()

Returns true if the entire operation of this linear convolution would have no effect on the source data.

Returns:boolean

true if the operation is a NOP

isShadowback to summary
public boolean isShadow()

Returns true if this is a LinearConvolveShadow operation, or false if the operation is a regular LinearConvolve.

Returns:boolean

true if this is a Shadow operation