Module javafx.graphics
Package javafx.scene.effect

Class SepiaTone


  • public class SepiaTone
extends Effect
    A filter that produces a sepia tone effect, similar to antique photographs.

    Example: 

    
 SepiaTone sepiaTone = new SepiaTone();
 sepiaTone.setLevel(0.7);

 Image image = new Image("boat.jpg");
 ImageView imageView = new ImageView(image);
 imageView.setFitWidth(200);
 imageView.setPreserveRatio(true);
 imageView.setEffect(sepiaTone);

    The code above applied on this image:

    A photo

    produces the following:

    The visual effect of SepiaTone on photo

    Since:
    JavaFX 2.0

    • Property Detail

      • input

        public final ObjectProperty<Effect> inputProperty
        The input for this Effect. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used as the input.
        Default value:
        null
        See Also:
        getInput(), setInput(Effect)

      • level

        public final DoubleProperty levelProperty
        The level value, which controls the intensity of the sepia effect. 
               Min: 0.0f
       Max: 1.0f
   Default: 1.0f
  Identity: 0.0f
        Default value:
        1.0f
        See Also:
        getLevel(), setLevel(double)

    • Constructor Detail

      • SepiaTone

        public SepiaTone​()
        Creates a new instance of SepiaTone with default parameters.

      • SepiaTone

        public SepiaTone​(double level)
        Creates a new instance of SepiaTone with the specified level.
        Parameters:
        level - the level value, which controls the intensity of the effect
        Since:
        JavaFX 2.1

    • Method Detail

      • setInput

        public final void setInput​(Effect value)
        Sets the value of the property input.
        Property description:
        The input for this Effect. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used as the input.
        Default value:
        null

      • getInput

        public final Effect getInput​()
        Gets the value of the property input.
        Property description:
        The input for this Effect. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used as the input.
        Default value:
        null

      • inputProperty

        public final ObjectProperty<Effect> inputProperty​()
        The input for this Effect. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used as the input.
        Default value:
        null
        See Also:
        getInput(), setInput(Effect)

      • setLevel

        public final void setLevel​(double value)
        Sets the value of the property level.
        Property description:
        The level value, which controls the intensity of the sepia effect. 
               Min: 0.0f
       Max: 1.0f
   Default: 1.0f
  Identity: 0.0f
        Default value:
        1.0f

      • getLevel

        public final double getLevel​()
        Gets the value of the property level.
        Property description:
        The level value, which controls the intensity of the sepia effect. 
               Min: 0.0f
       Max: 1.0f
   Default: 1.0f
  Identity: 0.0f
        Default value:
        1.0f

      • levelProperty

        public final DoubleProperty levelProperty​()
        The level value, which controls the intensity of the sepia effect. 
               Min: 0.0f
       Max: 1.0f
   Default: 1.0f
  Identity: 0.0f
        Default value:
        1.0f
        See Also:
        getLevel(), setLevel(double)