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

Modifier and Type	Field and Description
private float	threshold

Access	Constructor and Description
public	Brightpass() Constructs a new `Brightpass` effect with the default threshold value (0.3), using the default input for source data.
public	Brightpass(Effect the single input `Effect` input) Constructs a new `Brightpass` effect with the default threshold value (0.3).

Method Summary

Modifier and Type	Method and Description
public final Effect	Returns: the input for this `Effect` getInput() Returns the input for this `Effect`.
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.
public float	Returns: the threshold value getThreshold() Returns the threshold, which controls which pixels are included in the resulting image.
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	setInput(Effect the input for this `Effect` input) Sets the input for this `Effect`.
public void	setThreshold(float the threshold value threshold) Sets the threshold, which controls which pixels are included in the resulting image.

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

Field Detail

threshold	back to summary
private float threshold

Constructor Detail

Brightpass back to summary

Brightpass	back to summary
public Brightpass() Constructs a new `Brightpass` effect with the default threshold value (0.3), using the default input for source data. This is a shorthand equivalent to: new Brightpass(DefaultInput)

public Brightpass()

Constructs a new Brightpass effect with the default threshold value (0.3), using the default input for source data. This is a shorthand equivalent to:

    new Brightpass(DefaultInput)

Brightpass back to summary

Brightpass	back to summary
public Brightpass(Effect input) Constructs a new `Brightpass` effect with the default threshold value (0.3). Parameters input:Effect the single input `Effect` Exceptions IllegalArgumentException: if `input` is null

public Brightpass(Effect input)

Constructs a new Brightpass effect with the default threshold value (0.3).

Parameters

input:Effect: the single input Effect

Exceptions

IllegalArgumentException:: if input is null

Method Detail

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

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

getThreshold	back to summary
public float getThreshold() Returns the threshold, which controls which pixels are included in the resulting image. Pixel values with brightness greater than this threshold value will be included. Returns:float the threshold value

getThreshold

back to summary

public float getThreshold()

Returns the threshold, which controls which pixels are included in the resulting image. Pixel values with brightness greater than this threshold value will be included.

Returns:float: the threshold value

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

setInput back to summary

setInput	back to summary
public void setInput(Effect input) Sets the input for this `Effect`. Parameters input:Effect the input for this `Effect` Exceptions IllegalArgumentException: if `input` is null

public void setInput(Effect input)

Sets the input for this Effect.

Parameters

input:Effect: the input for this Effect

Exceptions

IllegalArgumentException:: if input is null

setThreshold back to summary

setThreshold	back to summary
public void setThreshold(float threshold) Sets the threshold, which controls which pixels are included in the resulting image. Pixel values with brightness greater than this threshold value will be included. Min: 0.0 Max: 1.0 Default: 0.3 Identity: n/a Parameters threshold:float the threshold value Exceptions IllegalArgumentException: if `threshold` is outside the allowable range

public void setThreshold(float threshold)

Sets the threshold, which controls which pixels are included in the resulting image. Pixel values with brightness greater than this threshold value will be included.

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

Parameters

threshold:float: the threshold value

Exceptions

IllegalArgumentException:: if threshold is outside the allowable range

public Class Brightpass

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail