Module javafx.graphics
Package javafx.scene.effect

Class ColorAdjust

  • public class ColorAdjust
extends Effect
    An effect that allows for per-pixel adjustments of hue, saturation, brightness, and contrast.

    Example: 

    
 ColorAdjust colorAdjust = new ColorAdjust();
 colorAdjust.setContrast(0.1);
 colorAdjust.setHue(-0.05);
 colorAdjust.setBrightness(0.1);
 colorAdjust.setSaturation(0.2);

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

    The code above applied on this image:

    A photo

    produces the following:

    The visual effect of ColorAdjust on photo

    Since:
    JavaFX 2.0

    • Constructor Detail

      • ColorAdjust

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

      • ColorAdjust

        public ColorAdjust​(double hue,
                   double saturation,
                   double brightness,
                   double contrast)
        Creates a new instance of ColorAdjust with the specified hue, saturation, brightness, and contrast.
        Parameters:
        hue - the hue adjustment value
        saturation - the saturation adjustment value
        brightness - the brightness adjustment value
        contrast - the contrast adjustment value
        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)

      • setHue

        public final void setHue​(double value)
        Sets the value of the property hue.
        Property description:
        The hue adjustment value. 
               Min: -1.0
       Max: +1.0
   Default:  0.0
  Identity:  0.0
        Default value:
        0.0

      • getHue

        public final double getHue()
        Gets the value of the property hue.
        Property description:
        The hue adjustment value. 
               Min: -1.0
       Max: +1.0
   Default:  0.0
  Identity:  0.0
        Default value:
        0.0

      • hueProperty

        public final DoubleProperty hueProperty()
        The hue adjustment value. 
               Min: -1.0
       Max: +1.0
   Default:  0.0
  Identity:  0.0
        Default value:
        0.0
        See Also:
        getHue(), setHue(double)

      • setSaturation

        public final void setSaturation​(double value)
        Sets the value of the property saturation.
        Property description:
        The saturation adjustment value. 
               Min: -1.0
       Max: +1.0
   Default:  0.0
  Identity:  0.0
        Default value:
        0.0

      • getSaturation

        public final double getSaturation()
        Gets the value of the property saturation.
        Property description:
        The saturation adjustment value. 
               Min: -1.0
       Max: +1.0
   Default:  0.0
  Identity:  0.0
        Default value:
        0.0

      • setBrightness

        public final void setBrightness​(double value)
        Sets the value of the property brightness.
        Property description:
        The brightness adjustment value. 
               Min: -1.0
       Max: +1.0
   Default:  0.0
  Identity:  0.0
        Default value:
        0.0

      • getBrightness

        public final double getBrightness()
        Gets the value of the property brightness.
        Property description:
        The brightness adjustment value. 
               Min: -1.0
       Max: +1.0
   Default:  0.0
  Identity:  0.0
        Default value:
        0.0

      • setContrast

        public final void setContrast​(double value)
        Sets the value of the property contrast.
        Property description:
        The contrast adjustment value. 
               Min: -1.0
       Max: +1.0
   Default:  0.0
  Identity:  0.0
        Default value:
        0.0

      • getContrast

        public final double getContrast()
        Gets the value of the property contrast.
        Property description:
        The contrast adjustment value. 
               Min: -1.0
       Max: +1.0
   Default:  0.0
  Identity:  0.0
        Default value:
        0.0