com.sun.scenario.effect

Class ColorAdjust

java.lang.Object

com.sun.scenario.effect.Effect

com.sun.scenario.effect.FilterEffect<T>

com.sun.scenario.effect.CoreEffect<RenderState>

com.sun.scenario.effect.ColorAdjust

public class ColorAdjust
extends CoreEffect<RenderState>

An effect that allows for per-pixel adjustments of hue, saturation, brightness, and contrast.

Nested Class Summary

Nested classes/interfaces inherited from class com.sun.scenario.effect.Effect

Effect.AccelType

Field Summary

Fields

Modifier and Type	Field and Description
private float	brightness
private float	contrast
private float	hue
private float	saturation

Fields inherited from class com.sun.scenario.effect.Effect

DefaultInput

Constructor Summary

Constructors

Constructor and Description
ColorAdjust() Constructs a new ColorAdjust effect with the default hue (0.0), saturation (0.0), brightness (0.0), and contrast (1.0), using the default input for source data.
ColorAdjust(Effect input) Constructs a new ColorAdjust effect with the default hue (0.0), saturation (0.0), brightness (0.0), and contrast (0.0).

Method Summary

Modifier and Type	Method and Description
float	getBrightness() Returns the brightness adjustment.
float	getContrast() Returns the contrast adjustment.
float	getHue() Returns the hue adjustment.
Effect	getInput() Returns the input for this Effect.
RenderState	getRenderState(FilterContext fctx, BaseTransform transform, Rectangle outputClip, java.lang.Object renderHelper, Effect defaultInput) Returns the object representing the rendering strategy and state for the filter operation characterized by the specified arguments.
float	getSaturation() Returns the saturation adjustment.
boolean	reducesOpaquePixels() Whether an opacity for any pixel is different (lower) than the corresponding pixel in the default input.
void	setBrightness(float brightness) Sets the brightness adjustment.
void	setContrast(float contrast) Sets the contrast adjustment.
void	setHue(float hue) Sets the hue adjustment.
void	setInput(Effect input) Sets the input for this Effect to a specific Effect or to the default input if input is null.
void	setSaturation(float saturation) Sets the saturation adjustment.

Methods inherited from class com.sun.scenario.effect.CoreEffect

filterImageDatas, getAccelType, getPeer, updatePeerKey, updatePeerKey

Methods inherited from class com.sun.scenario.effect.FilterEffect

filter, getBounds, transform, untransform, untransformClip

Methods inherited from class com.sun.scenario.effect.Effect

combineBounds, combineBounds, createCompatibleImage, ensureTransform, getCompatibleImage, getDefaultedInput, getDefaultedInput, getDirtyRegions, getInputs, getNumInputs, getResultBounds, getState, releaseCompatibleImage, setInput, transformBounds

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

hue

private float hue

saturation

private float saturation

brightness

private float brightness

contrast

private float contrast

Constructor Detail

ColorAdjust

public ColorAdjust()

Constructs a new ColorAdjust effect with the default hue (0.0), saturation (0.0), brightness (0.0), and contrast (1.0), using the default input for source data. This is a shorthand equivalent to:

     new ColorAdjust(DefaultInput)
 

ColorAdjust

public ColorAdjust(Effect input)

Constructs a new ColorAdjust effect with the default hue (0.0), saturation (0.0), brightness (0.0), and contrast (0.0).

Parameters:

input - the single input Effect

Method Detail

getInput

public final Effect getInput()

Returns the input for this Effect.

Returns:

the input for this Effect

setInput

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 - the input for this Effect

Throws:

java.lang.IllegalArgumentException - if input is null

getHue

public float getHue()

Returns the hue adjustment.

Returns:

the hue adjustment

setHue

public void setHue(float hue)

Sets the hue adjustment.

       Min: -1.0
       Max: +1.0
   Default:  0.0
  Identity:  0.0
 

Parameters:

hue - the hue adjustment

Throws:

java.lang.IllegalArgumentException - if hue is outside the allowable range

getSaturation

public float getSaturation()

Returns the saturation adjustment.

Returns:

the saturation adjustment

setSaturation

public void setSaturation(float saturation)

Sets the saturation adjustment.

       Min: -1.0
       Max: +1.0
   Default:  0.0
  Identity:  0.0
 

Parameters:

saturation - the saturation adjustment

Throws:

java.lang.IllegalArgumentException - if saturation is outside the allowable range

getBrightness

public float getBrightness()

Returns the brightness adjustment.

Returns:

the brightness adjustment

setBrightness

public void setBrightness(float brightness)

Sets the brightness adjustment.

       Min: -1.0
       Max: +1.0
   Default:  0.0
  Identity:  0.0
 

Parameters:

brightness - the brightness adjustment

Throws:

java.lang.IllegalArgumentException - if brightness is outside the allowable range

getContrast

public float getContrast()

Returns the contrast adjustment.

Returns:

the contrast adjustment

setContrast

public void setContrast(float contrast)

Sets the contrast adjustment.

       Min: -1.0
       Max: +1.0
   Default:  0.0
  Identity:  0.0
 

Parameters:

contrast - the contrast adjustment

Throws:

java.lang.IllegalArgumentException - if contrast is outside the allowable range

getRenderState

public RenderState getRenderState(FilterContext fctx,
                                  BaseTransform transform,
                                  Rectangle outputClip,
                                  java.lang.Object renderHelper,
                                  Effect defaultInput)

Description copied from class: FilterEffect

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.

Specified by:

getRenderState in class FilterEffect<RenderState>

Parameters:

fctx - the context object that would be used by the Renderer if this call is preparing for a render operation, or null

transform - the transform for the output of this operation

outputClip - the clip rectangle that may restrict this operation, or null

renderHelper - the rendering helper object that can be used to shortcut this operation under certain conditions, or null

defaultInput - the Effect to be used in place of any null inputs

Returns:

reducesOpaquePixels

public boolean reducesOpaquePixels()

Description copied from class: Effect

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.

Specified by:

reducesOpaquePixels in class Effect

Returns:

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.