JavaFX 27 · com.sun.scenario.effect.Merge · APIdia, the JavaDoc alternative

Access	Constructor and Description
public	Merge(Effect the bottom input bottomInput, Effect the top input topInput) Constructs a new `Merge` effect for the given inputs.

Method Summary

Modifier and Type	Method and Description
public ImageData	filter(FilterContext fctx, BaseTransform transform, Rectangle outputClip, Object renderHelper, Effect defaultInput) Overrides com.sun.scenario.effect.FilterEffect.filter. Applies this filter effect to the series of images represented by the input `Effect`s and/or the given `defaultInput` viewed under the given `transform`.
public final Effect	Returns: the bottom input for this `Effect` getBottomInput() Returns the bottom input for this `Effect`.
public RenderState	getRenderState(FilterContext fctx, BaseTransform transform, Rectangle outputClip, Object renderHelper, Effect defaultInput) Implements abstract com.sun.scenario.effect.FilterEffect.getRenderState. Returns the object representing the rendering strategy and state for the filter operation characterized by the specified arguments.
public final Effect	Returns: the top input for this `Effect` getTopInput() Returns the top input for this `Effect`.
public boolean	reducesOpaquePixels() Implements abstract com.sun.scenario.effect.Effect.reducesOpaquePixels. Whether an opacity for any pixel is different (lower) than the corresponding pixel in the default input.
public void	setBottomInput(Effect the bottom input for this `Effect` bottomInput) Sets the bottom input for this `Effect` to a specific `Effect` or to the default input if `input` is `null`.
public void	setTopInput(Effect the top input for this `Effect` topInput) Sets the top input for this `Effect` to a specific `Effect` or to the default input if `input` is `null`.
public Point2D	Returns: the transformed point in the coordinate space of the result transform(Point2D the point in the coordinate space of the primary content input to be transformed p, Effect the default input `Effect` to be used in all cases where a filter has a null input defaultInput) 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.
public Point2D	Returns: the untransformed point in the coordinate space of the primary content input untransform(Point2D the point in the coordinate space of the result output to be transformed p, Effect the default input `Effect` to be used in all cases where a filter has a null input defaultInput) 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.

Inherited from com.sun.scenario.effect.CoreEffect:: filterImageDatas getAccelType getPeer updatePeerKey updatePeerKey

Merge	back to summary
public Merge(Effect bottomInput, Effect topInput) Constructs a new `Merge` effect for the given inputs. Parameters bottomInput:Effect the bottom input topInput:Effect the top input

Method Detail

filter back to summary

filter	back to summary
public ImageData filter(FilterContext fctx, BaseTransform transform, Rectangle outputClip, Object renderHelper, Effect defaultInput) 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 `Effect`s 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); Annotations @Override

public ImageData filter(FilterContext fctx, BaseTransform transform, Rectangle outputClip, Object renderHelper, Effect defaultInput)

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);

Annotations

@Override

getBottomInput back to summary

getBottomInput	back to summary
public final Effect getBottomInput() Returns the bottom input for this `Effect`. Returns:Effect the bottom input for this `Effect`

public final Effect getBottomInput()

Returns the bottom input for this Effect.

Returns:Effect: the bottom input for this Effect

getRenderState back to summary

getRenderState	back to summary
public RenderState getRenderState(FilterContext fctx, BaseTransform transform, Rectangle outputClip, Object renderHelper, Effect defaultInput) 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. Annotations @Override

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

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.

Annotations

@Override

getTopInput back to summary

getTopInput	back to summary
public final Effect getTopInput() Returns the top input for this `Effect`. Returns:Effect the top input for this `Effect`

public final Effect getTopInput()

Returns the top input for this Effect.

Returns:Effect: the top input for this Effect

reducesOpaquePixels	back to summary
public boolean reducesOpaquePixels() 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. Annotations @Override

reducesOpaquePixels

back to summary

public boolean reducesOpaquePixels()

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.

Annotations

@Override

setBottomInput back to summary

setBottomInput	back to summary
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:Effect the bottom input for this `Effect`

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

setTopInput back to summary

setTopInput	back to summary
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:Effect the top input for this `Effect`

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

transform back to summary

transform	back to summary
public Point2D transform(Point2D p, Effect defaultInput) 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

public Point2D transform(Point2D p, Effect defaultInput)

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

untransform back to summary

untransform	back to summary
public Point2D untransform(Point2D p, Effect defaultInput) 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

public Point2D untransform(Point2D p, Effect defaultInput)

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

public Class Merge

Constructor Summary

Method Summary

Constructor Detail

Method Detail