com.sun.scenario.effect

Class SepiaTone

java.lang.Object

com.sun.scenario.effect.Effect

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

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

com.sun.scenario.effect.SepiaTone

public class SepiaTone
extends CoreEffect<RenderState>

A filter that produces a sepia tone effect, similar to antique photographs.

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	level

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

DefaultInput

Constructor Summary

Constructors

Constructor and Description
SepiaTone() Constructs a new SepiaTone effect with the default level value (1.0), using the default input for source data.
SepiaTone(Effect input) Constructs a new SepiaTone effect with the default level value (1.0).

Method Summary

Modifier and Type	Method and Description
Effect	getInput() Returns the input for this Effect.
float	getLevel() Returns the level value, which controls the intensity of the sepia 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.
boolean	reducesOpaquePixels() Whether an opacity for any pixel is different (lower) than the corresponding pixel in the default input.
void	setInput(Effect input) Sets the input for this Effect to a specific Effect or to the default input if input is null.
void	setLevel(float level) Sets the level value, which controls the intensity of the sepia effect.

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

level

private float level

Constructor Detail

SepiaTone

public SepiaTone()

Constructs a new SepiaTone effect with the default level value (1.0), using the default input for source data. This is a shorthand equivalent to:

     new SepiaTone(DefaultInput)
 

SepiaTone

public SepiaTone(Effect input)

Constructs a new SepiaTone effect with the default level value (1.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

getLevel

public float getLevel()

Returns the level value, which controls the intensity of the sepia effect.

Returns:

the level value

setLevel

public void setLevel(float level)

Sets the level value, which controls the intensity of the sepia effect.

       Min: 0.0
       Max: 1.0
   Default: 1.0
  Identity: 0.0
 

Parameters:

level - the level value

Throws:

java.lang.IllegalArgumentException - if level 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.