java.lang.Object
javafx.scene.effect.Effect
javafx.scene.effect.ColorAdjust
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:
produces the following:
- Since:
- JavaFX 2.0
-
Property Summary
PropertiesTypePropertyDescriptionfinal DoublePropertyThe brightness adjustment value.final DoublePropertyThe contrast adjustment value.final DoublePropertyThe hue adjustment value.final ObjectProperty<Effect>The input for thisEffect.final DoublePropertyThe saturation adjustment value. -
Constructor Summary
ConstructorsConstructorDescriptionCreates a new instance of ColorAdjust with default parameters.ColorAdjust(double hue, double saturation, double brightness, double contrast) Creates a new instance of ColorAdjust with the specified hue, saturation, brightness, and contrast. -
Method Summary
Modifier and TypeMethodDescriptionfinal DoublePropertyThe brightness adjustment value.final DoublePropertyThe contrast adjustment value.final doubleGets the value of thebrightnessproperty.final doubleGets the value of thecontrastproperty.final doublegetHue()Gets the value of thehueproperty.final EffectgetInput()Gets the value of theinputproperty.final doubleGets the value of thesaturationproperty.final DoublePropertyThe hue adjustment value.final ObjectProperty<Effect>The input for thisEffect.final DoublePropertyThe saturation adjustment value.final voidsetBrightness(double value) Sets the value of thebrightnessproperty.final voidsetContrast(double value) Sets the value of thecontrastproperty.final voidsetHue(double value) Sets the value of thehueproperty.final voidSets the value of theinputproperty.final voidsetSaturation(double value) Sets the value of thesaturationproperty.
-
Property Details
-
input
The input for thisEffect. If set tonull, or left unspecified, a graphical image of theNodeto which theEffectis attached will be used as the input.- Default value:
- null
- See Also:
-
hue
The hue adjustment value.Min: -1.0 Max: +1.0 Default: 0.0 Identity: 0.0- Default value:
- 0.0
- See Also:
-
saturation
The saturation adjustment value.Min: -1.0 Max: +1.0 Default: 0.0 Identity: 0.0- Default value:
- 0.0
- See Also:
-
brightness
The brightness adjustment value.Min: -1.0 Max: +1.0 Default: 0.0 Identity: 0.0- Default value:
- 0.0
- See Also:
-
contrast
The contrast adjustment value.Min: -1.0 Max: +1.0 Default: 0.0 Identity: 0.0- Default value:
- 0.0
- See Also:
-
-
Constructor Details
-
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 valuesaturation- the saturation adjustment valuebrightness- the brightness adjustment valuecontrast- the contrast adjustment value- Since:
- JavaFX 2.1
-
-
Method Details
-
setInput
Sets the value of theinputproperty.- Property description:
- The input for this
Effect. If set tonull, or left unspecified, a graphical image of theNodeto which theEffectis attached will be used as the input. - Default value:
- null
- Parameters:
value- the value for theinputproperty- See Also:
-
getInput
Gets the value of theinputproperty.- Property description:
- The input for this
Effect. If set tonull, or left unspecified, a graphical image of theNodeto which theEffectis attached will be used as the input. - Default value:
- null
- Returns:
- the value of the
inputproperty - See Also:
-
inputProperty
The input for thisEffect. If set tonull, or left unspecified, a graphical image of theNodeto which theEffectis attached will be used as the input.- Default value:
- null
- Returns:
- the
inputproperty - See Also:
-
setHue
public final void setHue(double value) Sets the value of thehueproperty.- Property description:
- The hue adjustment value.
Min: -1.0 Max: +1.0 Default: 0.0 Identity: 0.0 - Default value:
- 0.0
- Parameters:
value- the value for thehueproperty- See Also:
-
getHue
public final double getHue()Gets the value of thehueproperty.- Property description:
- The hue adjustment value.
Min: -1.0 Max: +1.0 Default: 0.0 Identity: 0.0 - Default value:
- 0.0
- Returns:
- the value of the
hueproperty - See Also:
-
hueProperty
The hue adjustment value.Min: -1.0 Max: +1.0 Default: 0.0 Identity: 0.0- Default value:
- 0.0
- Returns:
- the
hueproperty - See Also:
-
setSaturation
public final void setSaturation(double value) Sets the value of thesaturationproperty.- Property description:
- The saturation adjustment value.
Min: -1.0 Max: +1.0 Default: 0.0 Identity: 0.0 - Default value:
- 0.0
- Parameters:
value- the value for thesaturationproperty- See Also:
-
getSaturation
public final double getSaturation()Gets the value of thesaturationproperty.- Property description:
- The saturation adjustment value.
Min: -1.0 Max: +1.0 Default: 0.0 Identity: 0.0 - Default value:
- 0.0
- Returns:
- the value of the
saturationproperty - See Also:
-
saturationProperty
The saturation adjustment value.Min: -1.0 Max: +1.0 Default: 0.0 Identity: 0.0- Default value:
- 0.0
- Returns:
- the
saturationproperty - See Also:
-
setBrightness
public final void setBrightness(double value) Sets the value of thebrightnessproperty.- Property description:
- The brightness adjustment value.
Min: -1.0 Max: +1.0 Default: 0.0 Identity: 0.0 - Default value:
- 0.0
- Parameters:
value- the value for thebrightnessproperty- See Also:
-
getBrightness
public final double getBrightness()Gets the value of thebrightnessproperty.- Property description:
- The brightness adjustment value.
Min: -1.0 Max: +1.0 Default: 0.0 Identity: 0.0 - Default value:
- 0.0
- Returns:
- the value of the
brightnessproperty - See Also:
-
brightnessProperty
The brightness adjustment value.Min: -1.0 Max: +1.0 Default: 0.0 Identity: 0.0- Default value:
- 0.0
- Returns:
- the
brightnessproperty - See Also:
-
setContrast
public final void setContrast(double value) Sets the value of thecontrastproperty.- Property description:
- The contrast adjustment value.
Min: -1.0 Max: +1.0 Default: 0.0 Identity: 0.0 - Default value:
- 0.0
- Parameters:
value- the value for thecontrastproperty- See Also:
-
getContrast
public final double getContrast()Gets the value of thecontrastproperty.- Property description:
- The contrast adjustment value.
Min: -1.0 Max: +1.0 Default: 0.0 Identity: 0.0 - Default value:
- 0.0
- Returns:
- the value of the
contrastproperty - See Also:
-
contrastProperty
The contrast adjustment value.Min: -1.0 Max: +1.0 Default: 0.0 Identity: 0.0- Default value:
- 0.0
- Returns:
- the
contrastproperty - See Also:
-