JavaFX 24 · com.sun.scenario.effect.MotionBlur · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private MotionBlurState	state

Access	Constructor and Description
public	MotionBlur() Constructs a new `MotionBlur` effect with the default radius (10.0) and default angle (0.0), using the default input for source data.
public	MotionBlur(float the radius of the Gaussian kernel radius, float the angle of the motion effect, in radians angle) Constructs a new `MotionBlur` effect with the given radius and angle, using the default input for source data.
public	MotionBlur(float the radius of the Gaussian kernel radius, float the angle of the motion effect, in radians angle, Effect the single input `Effect` input) Constructs a new `MotionBlur` effect with the given radius and angle.

Method Summary

Modifier and Type	Method and Description
public Effect.AccelType	getAccelType(FilterContext fctx) Overrides com.sun.scenario.effect.CoreEffect.getAccelType. Returns one of the `AccelType` values, indicating whether this `Effect` is accelerated in hardware for the given `FilterContext`.
public float	Returns: the angle of the motion effect, in radians getAngle() Returns the angle of the motion effect, in radians.
public BaseBounds	getBounds(BaseTransform the transform the effect will be viewed under transform, Effect the default input `Effect` to be used in all cases where a filter has a null input defaultInput) Overrides com.sun.scenario.effect.FilterEffect.getBounds. Returns the bounding box that will be affected by this filter operation when viewed under the specified `transform`, given its list of input `Effect`s and the specified `defaultInput` effect.
public DirtyRegionContainer	getDirtyRegions(Effect the default input `Effect` to be used in all cases where a filter has a null input defaultInput, DirtyRegionPool the pool of dirty regions regionPool) Overrides com.sun.scenario.effect.Effect.getDirtyRegions. Returns the dirty region container containing dirty regions affected by this filter operation.
public final Effect	Returns: the input for this `Effect` getInput() Returns the input for this `Effect`.
public float	Returns: the radius of the Gaussian kernel getRadius() Returns the radius of the Gaussian kernel.
public Rectangle	getResultBounds(BaseTransform transform, Rectangle outputClip, ImageData... inputDatas) Overrides com.sun.scenario.effect.Effect.getResultBounds.
pack-priv LinearConvolveKernel	getState() Implements abstract com.sun.scenario.effect.LinearConvolveCoreEffect.getState. Returns state object that is associated with this effect instance.
public boolean	reducesOpaquePixels() Implements abstract com.sun.scenario.effect.Effect.reducesOpaquePixels. Whether an opacity for any pixel is different (lower) than the corresponding pixel in the default input.
public void	setAngle(float the angle of the motion effect, in radians angle) Sets the angle of the motion effect, in radians.
public void	setInput(Effect the input for this `Effect` input) Sets the input for this `Effect` to a specific `Effect` or to the default input if `input` is `null`.
public void	setRadius(float the radius of the Gaussian kernel radius) Sets the radius of the Gaussian kernel.

Inherited from com.sun.scenario.effect.LinearConvolveCoreEffect:: filterImageDatas getRenderState

Field Detail

state	back to summary
private MotionBlurState state

Constructor Detail

MotionBlur back to summary

MotionBlur	back to summary
public MotionBlur() Constructs a new `MotionBlur` effect with the default radius (10.0) and default angle (0.0), using the default input for source data. This is a shorthand equivalent to: new MotionBlur(10f, 0f, DefaultInput)

public MotionBlur()

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

    new MotionBlur(10f, 0f, DefaultInput)

MotionBlur back to summary

MotionBlur	back to summary
public MotionBlur(float radius, float angle) Constructs a new `MotionBlur` effect with the given radius and angle, using the default input for source data. This is a shorthand equivalent to: new MotionBlur(radius, angle, DefaultInput) Parameters radius:float the radius of the Gaussian kernel angle:float the angle of the motion effect, in radians Exceptions IllegalArgumentException: if `radius` is outside the allowable range

public MotionBlur(float radius, float angle)

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

    new MotionBlur(radius, angle, DefaultInput)

Parameters

radius:float: the radius of the Gaussian kernel
angle:float: the angle of the motion effect, in radians

Exceptions

IllegalArgumentException:: if radius is outside the allowable range

MotionBlur back to summary

MotionBlur	back to summary
public MotionBlur(float radius, float angle, Effect input) Constructs a new `MotionBlur` effect with the given radius and angle. Parameters radius:float the radius of the Gaussian kernel angle:float the angle of the motion effect, in radians input:Effect the single input `Effect` Exceptions IllegalArgumentException: if `radius` is outside the allowable range

public MotionBlur(float radius, float angle, Effect input)

Constructs a new MotionBlur effect with the given radius and angle.

Parameters

radius:float: the radius of the Gaussian kernel
angle:float: the angle of the motion effect, in radians
input:Effect: the single input Effect

Exceptions

IllegalArgumentException:: if radius is outside the allowable range

Method Detail

getAccelType back to summary

getAccelType	back to summary
public Effect.AccelType getAccelType(FilterContext fctx) Overrides com.sun.scenario.effect.CoreEffect.getAccelType. Doc from com.sun.scenario.effect.Effect.getAccelType. Returns one of the `AccelType` values, indicating whether this `Effect` is accelerated in hardware for the given `FilterContext`. Returns:Effect.AccelType one of the `AccelType` values Annotations @Override

public Effect.AccelType getAccelType(FilterContext fctx)

Overrides com.sun.scenario.effect.CoreEffect.getAccelType.

Doc from com.sun.scenario.effect.Effect.getAccelType.

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

Returns:Effect.AccelType

one of the AccelType values

Annotations

@Override

getAngle	back to summary
public float getAngle() Returns the angle of the motion effect, in radians. Returns:float the angle of the motion effect, in radians

getAngle

back to summary

public float getAngle()

Returns the angle of the motion effect, in radians.

Returns:float: the angle of the motion effect, in radians

getBounds back to summary

getBounds	back to summary
public BaseBounds getBounds(BaseTransform transform, Effect defaultInput) Overrides com.sun.scenario.effect.FilterEffect.getBounds. Doc from com.sun.scenario.effect.Effect.getBounds. Returns the bounding box that will be affected by this filter operation when viewed under the specified `transform`, given its list of input `Effect`s and the specified `defaultInput` effect. Note that the returned bounds can be smaller or larger than one or more of the inputs. Parameters transform:BaseTransform the transform the effect will be viewed under defaultInput:Effect the default input `Effect` to be used in all cases where a filter has a null input Returns:BaseBounds the bounding box of this filter Annotations @Override

public BaseBounds getBounds(BaseTransform transform, Effect defaultInput)

Overrides com.sun.scenario.effect.FilterEffect.getBounds.

Doc from com.sun.scenario.effect.Effect.getBounds.

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.

Parameters

transform:BaseTransform: the transform the effect will be viewed under
defaultInput:Effect: the default input Effect to be used in all cases where a filter has a null input

Returns:BaseBounds

the bounding box of this filter

Annotations

@Override

getDirtyRegions back to summary

getDirtyRegions	back to summary
public DirtyRegionContainer getDirtyRegions(Effect defaultInput, DirtyRegionPool regionPool) Overrides com.sun.scenario.effect.Effect.getDirtyRegions. Doc from com.sun.scenario.effect.Effect.getDirtyRegions. Returns the dirty region container containing dirty regions affected by this filter operation. Parameters defaultInput:Effect the default input `Effect` to be used in all cases where a filter has a null input regionPool:DirtyRegionPool the pool of dirty regions Returns:DirtyRegionContainer the dirty region container Annotations @Override

public DirtyRegionContainer getDirtyRegions(Effect defaultInput, DirtyRegionPool regionPool)

Overrides com.sun.scenario.effect.Effect.getDirtyRegions.

Doc from com.sun.scenario.effect.Effect.getDirtyRegions.

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

Parameters

defaultInput:Effect: the default input Effect to be used in all cases where a filter has a null input
regionPool:DirtyRegionPool: the pool of dirty regions

Returns:DirtyRegionContainer

the dirty region container

Annotations

@Override

getInput back to summary

getInput	back to summary
public final Effect getInput() Returns the input for this `Effect`. Returns:Effect the input for this `Effect`

public final Effect getInput()

Returns the input for this Effect.

Returns:Effect: the input for this Effect

getRadius	back to summary
public float getRadius() Returns the radius of the Gaussian kernel. Returns:float the radius of the Gaussian kernel

getRadius

back to summary

public float getRadius()

Returns the radius of the Gaussian kernel.

Returns:float: the radius of the Gaussian kernel

getResultBounds	back to summary
public Rectangle getResultBounds(BaseTransform transform, Rectangle outputClip, ImageData... inputDatas) Overrides com.sun.scenario.effect.Effect.getResultBounds. Annotations @Override

getResultBounds

back to summary

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

Overrides com.sun.scenario.effect.Effect.getResultBounds.

Annotations

@Override

getState	back to summary
pack-priv LinearConvolveKernel getState() Implements abstract com.sun.scenario.effect.LinearConvolveCoreEffect.getState. Doc from com.sun.scenario.effect.Effect.getState. 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. Annotations @Override

getState

back to summary

pack-priv LinearConvolveKernel getState()

Implements abstract com.sun.scenario.effect.LinearConvolveCoreEffect.getState.

Doc from com.sun.scenario.effect.Effect.getState.

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.

Annotations

@Override

reducesOpaquePixels	back to summary
public boolean reducesOpaquePixels() Implements abstract com.sun.scenario.effect.Effect.reducesOpaquePixels. Doc from com.sun.scenario.effect.Effect.reducesOpaquePixels. 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. Returns:boolean 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. Annotations @Override

reducesOpaquePixels

back to summary

public boolean reducesOpaquePixels()

Implements abstract com.sun.scenario.effect.Effect.reducesOpaquePixels.

Doc from com.sun.scenario.effect.Effect.reducesOpaquePixels.

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.

Returns:boolean

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.

Annotations

@Override

setAngle	back to summary
public void setAngle(float angle) Sets the angle of the motion effect, in radians. Min: n/a Max: n/a Default: 0.0 Identity: n/a Parameters angle:float the angle of the motion effect, in radians

setAngle

back to summary

public void setAngle(float angle)

Sets the angle of the motion effect, in radians.

      Min: n/a
      Max: n/a
  Default: 0.0
 Identity: n/a

Parameters

angle:float: the angle of the motion effect, in radians

setInput back to summary

setInput	back to summary
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:Effect the input for this `Effect`

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:Effect: the input for this Effect

setRadius back to summary

setRadius	back to summary
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:float the radius of the Gaussian kernel Exceptions IllegalArgumentException: if `radius` is outside the allowable range

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:float: the radius of the Gaussian kernel

Exceptions

IllegalArgumentException:: if radius is outside the allowable range

public Class MotionBlur

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail