Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: ColorAdjust

[12:7] extends: FxObj

Wraps JavaFX ColorAdjust, an effect that adjusts the hue, saturation, brightness, and contrast of a node's pixels. Each property accepts a value between -1.0 and 1.0, where 0.0 leaves that channel unchanged. Positive values increase the channel and negative values decrease it. Apply it to any node via the node's setEffect() method.

Methods

  • ColorAdjust ()

    Creates a new ColorAdjust effect with all adjustments set to 0.0 (no change).

  • setHue (double H)

    Sets the hue adjustment applied to each pixel.

    • @p H is a double in the range -1.0 to 1.0; 0.0 leaves hue unchanged.
    • @r this object
  • setSaturation (double S)

    Sets the saturation adjustment applied to each pixel.

    • @p S is a double in the range -1.0 to 1.0; 0.0 leaves saturation unchanged.
    • @r this object
  • setBrightness (double B)

    Sets the brightness adjustment applied to each pixel.

    • @p B is a double in the range -1.0 to 1.0; 0.0 leaves brightness unchanged.
    • @r this object
  • setContrast (double Contrast)

    Sets the contrast adjustment applied to each pixel.

    • @p Contrast is a double in the range -1.0 to 1.0; 0.0 leaves contrast unchanged.
    • @r this object
  • getHue ()

    Returns the current hue adjustment.

    • @r A double in the range -1.0 to 1.0.
  • getSaturation ()

    Returns the current saturation adjustment.

    • @r A double in the range -1.0 to 1.0.
  • getBrightness ()

    Returns the current brightness adjustment.

    • @r A double in the range -1.0 to 1.0.
  • getContrast ()

    Returns the current contrast adjustment.

    • @r A double in the range -1.0 to 1.0.
  • hueProperty ()

    Returns the property holding the hue adjustment.

    • @r A DoubleProperty AJO.
  • saturationProperty ()

    Returns the property holding the saturation adjustment.

    • @r A DoubleProperty AJO.
  • brightnessProperty ()

    Returns the property holding the brightness adjustment.

    • @r A DoubleProperty AJO.
  • contrastProperty ()

    Returns the property holding the contrast adjustment.

    • @r A DoubleProperty AJO.
  • setInput (EffectObj)

    Sets the upstream effect whose output this ColorAdjust processes.

    • @p EffectObj is an Effect wrapper or an AJO around a javafx.scene.effect.Effect.
    • @r this object for chaining
  • getInput ()

    Returns the upstream effect feeding this ColorAdjust.

    • @r An AJO around the Effect, or null when unset.
  • inputProperty ()

    Returns the property holding the upstream Effect.

    • @r An ObjectProperty AJO around the Effect.