com.sun.scenario.effect

Class Blend

java.lang.Object

com.sun.scenario.effect.Effect

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

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

com.sun.scenario.effect.Blend

Direct Known Subclasses:

NGCanvas.MyBlend

public class Blend
extends CoreEffect<RenderState>

An effect that blends the two inputs together using one of the pre-defined Modes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Blend.Mode A blending mode that defines the manner in which the inputs are composited together.

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

Effect.AccelType

Field Summary

Fields

Modifier and Type	Field and Description
private Blend.Mode	mode
private float	opacity

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

DefaultInput

Constructor Summary

Constructors

Constructor and Description
Blend(Blend.Mode mode, Effect bottomInput, Effect topInput) Constructs a new Blend effect with the given mode and the default opacity (1.0).

Method Summary

Modifier and Type	Method and Description
Effect	getBottomInput() Returns the bottom input for this Effect.
Blend.Mode	getMode() Returns the Mode used to blend the two inputs together.
float	getOpacity() Returns the opacity value, which is modulated with the top input prior to blending.
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.
Effect	getTopInput() Returns the top input for this Effect.
boolean	reducesOpaquePixels() Whether an opacity for any pixel is different (lower) than the corresponding pixel in the default input.
void	setBottomInput(Effect bottomInput) Sets the bottom input for this Effect to a specific Effect or to the default input if input is null.
void	setMode(Blend.Mode mode) Sets the Mode used to blend the two inputs together.
void	setOpacity(float opacity) Sets the opacity value, which is modulated with the top input prior to blending.
void	setTopInput(Effect topInput) Sets the top input for this Effect to a specific Effect or to the default input if input is null.
Point2D	transform(Point2D p, Effect defaultInput) Transform the specified point p from the coordinate space of the primary content input to the coordinate space of the effect output.
Point2D	untransform(Point2D p, Effect defaultInput) Transform the specified point p from the coordinate space of the output of the effect into the coordinate space of the primary content input.

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, 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

mode

private Blend.Mode mode

opacity

private float opacity

Constructor Detail

Blend

public Blend(Blend.Mode mode,
             Effect bottomInput,
             Effect topInput)

Constructs a new Blend effect with the given mode and the default opacity (1.0). Either or both inputs may be null to indicate that the default input should be used.

Parameters:

mode - the blending mode

bottomInput - the bottom input

topInput - the top input

Throws:

java.lang.IllegalArgumentException - if mode is null

Method Detail

getBottomInput

public final Effect getBottomInput()

Returns the bottom input for this Effect.

Returns:

the bottom input for this Effect

setBottomInput

public void setBottomInput(Effect bottomInput)

Sets the bottom input for this Effect to a specific Effect or to the default input if input is null.

Parameters:

bottomInput - the bottom input for this Effect

getTopInput

public final Effect getTopInput()

Returns the top input for this Effect.

Returns:

the top input for this Effect

setTopInput

public void setTopInput(Effect topInput)

Sets the top input for this Effect to a specific Effect or to the default input if input is null.

Parameters:

topInput - the top input for this Effect

getMode

public Blend.Mode getMode()

Returns the Mode used to blend the two inputs together.

Returns:

the Mode used to blend the two inputs together.

setMode

public void setMode(Blend.Mode mode)

Sets the Mode used to blend the two inputs together.

       Min: n/a
       Max: n/a
   Default: Mode.SRC_OVER
  Identity: n/a
 

Parameters:

mode - the blending mode

Throws:

java.lang.IllegalArgumentException - if mode is null

getOpacity

public float getOpacity()

Returns the opacity value, which is modulated with the top input prior to blending.

Returns:

the opacity value

setOpacity

public void setOpacity(float opacity)

Sets the opacity value, which is modulated with the top input prior to blending.

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

Parameters:

opacity - the opacity value

Throws:

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

transform

public Point2D transform(Point2D p,
                         Effect defaultInput)

Transform the specified point p from the coordinate space of the primary content input to the coordinate space of the effect output. In essence, this method asks the question "Which output coordinate is most affected by the data at the specified coordinate in the primary source input?"

The Blend effect delegates this operation to its top input, or the defaultInput if the top input is null.

Overrides:

transform in class FilterEffect<RenderState>

Parameters:

p - the point in the coordinate space of the primary content input to be transformed

defaultInput - the default input Effect to be used in all cases where a filter has a null input

Returns:

the transformed point in the coordinate space of the result

untransform

public Point2D untransform(Point2D p,
                           Effect defaultInput)

Transform the specified point p from the coordinate space of the output of the effect into the coordinate space of the primary content input. In essence, this method asks the question "Which source coordinate contributes most to the definition of the output at the specified coordinate?"

The Blend effect delegates this operation to its top input, or the defaultInput if the top input is null.

Overrides:

untransform in class FilterEffect<RenderState>

Parameters:

p - the point in the coordinate space of the result output to be transformed

defaultInput - the default input Effect to be used in all cases where a filter has a null input

Returns:

the untransformed point in the coordinate space of the primary content input

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.