Returns a new image that is most compatible with the given FilterContext. This method will select the image type that is most appropriate for use with the current rendering pipeline, graphics hardware, and screen pixel layout. The image will be cleared prior to being returned. This method may return null if the image can't be created so callers have to check for return value.

Parameters

fctx:FilterContext

the FilterContext for the target screen device

w:int

the width of the image

h:int

the height of the image

Returns:Filterable

a new image with the given dimensions, or null if one can't be created

Exceptions

IllegalArgumentException:

if gc is null, or if either w or h is non-positive

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.

Returns one of the AccelType values, indicating whether this Effect is accelerated in hardware for the given FilterContext.

Returns:Effect.AccelType

one of the AccelType values

Returns the bounding box that will be affected by this filter operation when viewed under the specified transform, given its list of input Effects and the specified defaultInput effect. Note that the returned bounds can be smaller or larger than one or more of the inputs.

Parameters

transform:BaseTransform

the transform the effect will be viewed under

defaultInput:Effect

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

Returns:BaseBounds

the bounding box of this filter

Returns an image that is most compatible with the given FilterContext. This method will select the image type that is most appropriate for use with the current rendering pipeline, graphics hardware, and screen pixel layout. The image will be cleared prior to being returned.

Note that the framework attempts to pool images for recycling purposes whenever possible. Therefore, when finished using an image returned by this method, it is highly recommended that you release the image back to the shared pool for others to use. This method may return null if the image can't be created so callers have to check for return value.

Parameters

fctx:FilterContext

the FilterContext for the target screen device

w:int

the width of the image

h:int

the height of the image

Returns:Filterable

an image with the given dimensions or null if one can't be created

Exceptions

IllegalArgumentException:

if gc is null, or if either w or h is non-positive

See Also

releaseCompatibleImage

Returns the dirty region container containing dirty regions affected by this filter operation.

Parameters

defaultInput:Effect

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

regionPool:DirtyRegionPool

the pool of dirty regions

Returns:DirtyRegionContainer

the dirty region container

Returns the (immutable) list of input Effects, or an empty list if no inputs were specified at construction time.

Returns:List<Effect>

the list of input Effects

Returns the number of inputs processed by this Effect.

Returns:int

the number of inputs for this 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.

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.

Releases an image created by the getCompatibleImage() method back into the shared pool.

Parameters

fctx:FilterContext

the FilterContext for the target screen device

image:Filterable

the image to be released

See Also

getCompatibleImage

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 definition of which input represents the primary content input and how the coordinate space of that input compares to the coordinate space of the result varies from effect to effect. Note that some effects may have a reasonable definition of how to map source coordinates to destination coordinates, but not the reverse. In particular, effects which map source coordinates discontiguously into the result may have several output coordinates that are affected by a given input coordinate and may choose to return one of many equally valid answers, or an undefined result such as NaN, or some other anomalous value. Most effects perform simple transformations of the color of each pixel and so represent an identity transform and return the point unchanged.

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

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 definition of which input represents the primary content input and how the coordinate space of that input compares to the coordinate space of the result varies from effect to effect. Note that some effects may have a reasonable definition of how to map destination coordinates back to source coordinates, but not the reverse. In particular, effects which produce entirely synthetic results not based on any content input may not be able to give a meaningful result to this query and may return undefined coordinates such as 0, Infinity, or NaN. Most effects perform simple transformations of the color of each pixel and so represent an identity transform and return the point unchanged.

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