public Class Merge

Constructs a new Merge effect for the given inputs.

Parameters

bottomInput:Effect

the bottom input

topInput:Effect

the top input

Overrides com.sun.scenario.effect.FilterEffect.filter.

Doc from com.sun.scenario.effect.Effect.filter.

Applies this filter effect to the series of images represented by the input Effects and/or the given defaultInput viewed under the given transform. The filter does not need to create pixel data for any pixels that fall outside of the destination device-space (pixel) bounds specified by the outputClip Rectangle.

The filter might be able to use the renderHelper object to render the results directly on its own if the object is not null and implements an interface, such as ImageHelper, that the filter recognizes. If the effect renders itself then it will return a null for the ImageData result.

Note that the ImageData object returned by this method must be validated prior to use with ImageData#validate(com.sun.scenario.effect.FilterContext) method.

      boolean valid;

      do {
          ImageData res = filter(fctx, transform, clip, renderer, defaultInput);
          if (res == null) {
              break;
          }
          if (valid = res.validate(fctx)) {
              // Render res.getImage() to the appropriate destination
              // or use it as an input to another chain of effects.
          }
          res.unref();
      } while (!valid);
      

Parameters

fctx:FilterContext

the FilterContext that determines the environment (e.g. the graphics device or code path) on which the filter operation will be performed

transform:BaseTransform

an optional transform under which the filter and its inputs will be viewed

outputClip:Rectangle

the device space (pixel) bounds of the output image or window or clip into which the result of the Effect will be rendered, or null if the output dimensions are not known.

renderHelper:Object

an object which might be used to render the results of the effect directly.

defaultInput:Effect

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

Returns:ImageData

the ImageData holding the result of this filter operation or null if the filter had no output or used the renderHelper to render its results directly.

Annotations

@Override

Returns the bottom input for this Effect.

Returns:Effect

the bottom input for this Effect

Implements abstract com.sun.scenario.effect.FilterEffect.getRenderState.

Doc from com.sun.scenario.effect.FilterEffect.getRenderState.

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.

Parameters

fctx:FilterContext

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

transform:BaseTransform

the transform for the output of this operation

outputClip:Rectangle

the clip rectangle that may restrict this operation, or null

renderHelper:Object

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

defaultInput:Effect

the Effect to be used in place of any null inputs

Annotations

@Override

Returns the top input for this Effect.

Returns:Effect

the top input for this Effect

Implements abstract com.sun.scenario.effect.Effect.reducesOpaquePixels.

Doc from com.sun.scenario.effect.Effect.reducesOpaquePixels.

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.

Returns:boolean

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.

Annotations

@Override

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

Parameters

bottomInput:Effect

the bottom input for this Effect

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

Parameters

topInput:Effect

the top input for this Effect

Overrides com.sun.scenario.effect.FilterEffect.transform.

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 Merge effect delegates this operation to its top input, or the defaultInput if the top input is null.

Parameters

p:Point2D

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

defaultInput:Effect

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

Returns:Point2D

the transformed point in the coordinate space of the result

Annotations

@Override

Overrides com.sun.scenario.effect.FilterEffect.untransform.

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 Merge effect delegates this operation to its top input, or the defaultInput if the top input is null.

Parameters

p:Point2D

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

defaultInput:Effect

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

Returns:Point2D

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

Annotations

@Override