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

Modifier and Type	Field and Description
private float	level

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

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 float	Returns: the level value getLevel() Returns the level value, which controls the intensity of the sepia 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 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` to a specific `Effect` or to the default input if `input` is `null`.
public void	setLevel(float the level value level) Sets the level value, which controls the intensity of the sepia effect.

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

level	back to summary
private float level

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

SepiaTone	back to summary
public SepiaTone(Effect input) Constructs a new `SepiaTone` effect with the default level value (1.0). Parameters input:Effect the single input `Effect`

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

getLevel	back to summary
public float getLevel() Returns the level value, which controls the intensity of the sepia effect. Returns:float the level value

getLevel

back to summary

public float getLevel()

Returns the level value, which controls the intensity of the sepia effect.

Returns:float: the level value

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

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

setLevel back to summary

setLevel	back to summary
public void setLevel(float level) Sets the level value, which controls the intensity of the sepia effect. Min: 0.0 Max: 1.0 Default: 1.0 Identity: 0.0 Parameters level:float the level value Exceptions IllegalArgumentException: if `level` is outside the allowable range

public void setLevel(float level)

Sets the level value, which controls the intensity of the sepia effect.

      Min: 0.0
      Max: 1.0
  Default: 1.0
 Identity: 0.0

Parameters

level:float: the level value

Exceptions

IllegalArgumentException:: if level is outside the allowable range

public Class SepiaTone

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail