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

Modifier and Type	Field and Description
private float	centerX
private float	centerY
private int	r
private final ZoomRadialBlurState	state

Access	Constructor and Description
public	ZoomRadialBlur() Constructs a new `ZoomRadialBlur` effect with the default radius (1), using the default input for source data.
public	ZoomRadialBlur(int the radius of the kernel radius) Constructs a new `ZoomRadialBlur` effect with the given radius, using the default input for source data.
public	ZoomRadialBlur(int of ZoomRadialBlur radius, Effect the single input `Effect` input) Constructs a new `ZoomRadialBlur` effect with the given radius.

Method Summary

Modifier and Type	Method and Description
public ImageData	filterImageDatas(FilterContext fctx, BaseTransform transform, Rectangle outputClip, RenderState rstate, ImageData... inputs) Overrides com.sun.scenario.effect.CoreEffect.filterImageDatas. Convenience method that sends the given input data through the current peer, and then attempts to release the input image data.
public float	Returns: the X coordinate of the center point getCenterX() Returns the X coordinate of the center point of this effect.
public float	Returns: the Y coordinate of the center point getCenterY() Returns the Y coordinate of the center point of this 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 int	Returns: the radius of the effect kernel getRadius() Returns the radius of the effect kernel.
public RenderState	getRenderState(FilterContext the context object that would be used by the Renderer if this call is preparing for a render operation, or null fctx, BaseTransform the transform for the output of this operation transform, Rectangle the clip rectangle that may restrict this operation, or null outputClip, Object the rendering helper object that can be used to shortcut this operation under certain conditions, or null renderHelper, Effect the `Effect` to be used in place of any null inputs defaultInput) Implements abstract com.sun.scenario.effect.FilterEffect.getRenderState. Returns the object representing the rendering strategy and state for the filter operation characterized by the specified arguments.
pack-priv Object	getState() Overrides com.sun.scenario.effect.Effect.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	setCenterX(float the X coordinate of the center point centerX) Sets the X coordinate of the center point of this effect.
public void	setCenterY(float the Y coordinate of the center point centerY) Sets the Y coordinate of the center point of this effect.
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(int the radius of the effect kernel radius) Sets the radius of the effect kernel.
private void	updatePeer() Updates the peer "key" for the current radius.

Inherited from com.sun.scenario.effect.CoreEffect:: getAccelType getPeer updatePeerKey updatePeerKey

Field Detail

centerX	back to summary
private float centerX

centerY	back to summary
private float centerY

r	back to summary
private int r

state	back to summary
private final ZoomRadialBlurState state

Constructor Detail

ZoomRadialBlur back to summary

ZoomRadialBlur	back to summary
public ZoomRadialBlur() Constructs a new `ZoomRadialBlur` effect with the default radius (1), using the default input for source data. This is a shorthand equivalent to: new ZoomRadialBlur(1, DefaultInput)

public ZoomRadialBlur()

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

    new ZoomRadialBlur(1, DefaultInput)

ZoomRadialBlur back to summary

ZoomRadialBlur	back to summary
public ZoomRadialBlur(int radius) Constructs a new `ZoomRadialBlur` effect with the given radius, using the default input for source data. This is a shorthand equivalent to: new ZoomRadialBlur(radius, DefaultInput) Parameters radius:int the radius of the kernel Exceptions IllegalArgumentException: if `radius` is outside the allowable range

public ZoomRadialBlur(int radius)

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

    new ZoomRadialBlur(radius, DefaultInput)

Parameters

radius:int: the radius of the kernel

Exceptions

IllegalArgumentException:: if radius is outside the allowable range

ZoomRadialBlur back to summary

ZoomRadialBlur	back to summary
public ZoomRadialBlur(int radius, Effect input) Constructs a new `ZoomRadialBlur` effect with the given radius. Parameters radius:int of ZoomRadialBlur input:Effect the single input `Effect` Exceptions IllegalArgumentException: if `radius` is outside the allowable range

public ZoomRadialBlur(int radius, Effect input)

Constructs a new ZoomRadialBlur effect with the given radius.

Parameters

radius:int: of ZoomRadialBlur
input:Effect: the single input Effect

Exceptions

IllegalArgumentException:: if radius is outside the allowable range

Method Detail

filterImageDatas	back to summary
public ImageData filterImageDatas(FilterContext fctx, BaseTransform transform, Rectangle outputClip, RenderState rstate, ImageData... inputs) Overrides com.sun.scenario.effect.CoreEffect.filterImageDatas. Doc from com.sun.scenario.effect.CoreEffect.filterImageDatas. Convenience method that sends the given input data through the current peer, and then attempts to release the input image data. Annotations @Override

filterImageDatas

back to summary

public ImageData filterImageDatas(FilterContext fctx, BaseTransform transform, Rectangle outputClip, RenderState rstate, ImageData... inputs)

Overrides com.sun.scenario.effect.CoreEffect.filterImageDatas.

Doc from com.sun.scenario.effect.CoreEffect.filterImageDatas.

Convenience method that sends the given input data through the current peer, and then attempts to release the input image data.

Annotations

@Override

getCenterX	back to summary
public float getCenterX() Returns the X coordinate of the center point of this effect. Returns:float the X coordinate of the center point

getCenterX

back to summary

public float getCenterX()

Returns the X coordinate of the center point of this effect.

Returns:float: the X coordinate of the center point

getCenterY	back to summary
public float getCenterY() Returns the Y coordinate of the center point of this effect. Returns:float the Y coordinate of the center point

getCenterY

back to summary

public float getCenterY()

Returns the Y coordinate of the center point of this effect.

Returns:float: the Y coordinate of the center point

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 int getRadius() Returns the radius of the effect kernel. Returns:int the radius of the effect kernel

getRadius

back to summary

public int getRadius()

Returns the radius of the effect kernel.

Returns:int: the radius of the effect kernel

getRenderState back to summary

getRenderState	back to summary
public RenderState getRenderState(FilterContext fctx, BaseTransform transform, Rectangle outputClip, Object renderHelper, Effect defaultInput) Implements abstract com.sun.scenario.effect.FilterEffect.getRenderState. Doc from com.sun.scenario.effect.FilterEffect.getRenderState. Returns the object representing the rendering strategy and state for the filter operation characterized by the specified arguments. This call can also be used to get a state object for non-rendering cases like querying the bounds of an operation in which case the `FilterContext` object may be null. `outputClip` and `renderHelper` may always be null just as they may be null for a given filter operation. Parameters fctx:FilterContext the context object that would be used by the Renderer if this call is preparing for a render operation, or null transform:BaseTransform the transform for the output of this operation outputClip:Rectangle the clip rectangle that may restrict this operation, or null renderHelper:Object the rendering helper object that can be used to shortcut this operation under certain conditions, or null defaultInput:Effect the `Effect` to be used in place of any null inputs Annotations @Override

public RenderState getRenderState(FilterContext fctx, BaseTransform transform, Rectangle outputClip, Object renderHelper, Effect defaultInput)

Implements abstract com.sun.scenario.effect.FilterEffect.getRenderState.

Doc from com.sun.scenario.effect.FilterEffect.getRenderState.

Returns the object representing the rendering strategy and state for the filter operation characterized by the specified arguments. This call can also be used to get a state object for non-rendering cases like querying the bounds of an operation in which case the FilterContext object may be null. outputClip and renderHelper may always be null just as they may be null for a given filter operation.

Parameters

fctx:FilterContext: the context object that would be used by the Renderer if this call is preparing for a render operation, or null
transform:BaseTransform: the transform for the output of this operation
outputClip:Rectangle: the clip rectangle that may restrict this operation, or null
renderHelper:Object: the rendering helper object that can be used to shortcut this operation under certain conditions, or null
defaultInput:Effect: the Effect to be used in place of any null inputs

Annotations

@Override

getState	back to summary
pack-priv Object getState() Overrides com.sun.scenario.effect.Effect.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 Object getState()

Overrides com.sun.scenario.effect.Effect.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

setCenterX	back to summary
public void setCenterX(float centerX) Sets the X coordinate of the center point of this effect. Parameters centerX:float the X coordinate of the center point

setCenterX

back to summary

public void setCenterX(float centerX)

Sets the X coordinate of the center point of this effect.

Parameters

centerX:float: the X coordinate of the center point

setCenterY	back to summary
public void setCenterY(float centerY) Sets the Y coordinate of the center point of this effect. Parameters centerY:float the Y coordinate of the center point

setCenterY

back to summary

public void setCenterY(float centerY)

Sets the Y coordinate of the center point of this effect.

Parameters

centerY:float: the Y coordinate of the center point

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(int radius) Sets the radius of the effect kernel. Min: 1 Max: 64 Default: 1 Identity: n/a Parameters radius:int the radius of the effect kernel Exceptions IllegalArgumentException: if `radius` is outside the allowable range

public void setRadius(int radius)

Sets the radius of the effect kernel.

      Min:   1
      Max:  64
  Default:   1
 Identity: n/a

Parameters

radius:int: the radius of the effect kernel

Exceptions

IllegalArgumentException:: if radius is outside the allowable range

updatePeer	back to summary
private void updatePeer() Updates the peer "key" for the current radius.

public Class ZoomRadialBlur

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail