com.sun.scenario.effect.GaussianBlur Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of openjfx-78-backport Show documentation
Show all versions of openjfx-78-backport Show documentation
This is a backport of OpenJFX 8 to run on Java 7.
The newest version!
/*
* Copyright (c) 2008, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.sun.scenario.effect;
import com.sun.javafx.geom.BaseBounds;
import com.sun.javafx.geom.DirtyRegionContainer;
import com.sun.javafx.geom.DirtyRegionPool;
import com.sun.javafx.geom.RectBounds;
import com.sun.javafx.geom.Rectangle;
import com.sun.javafx.geom.transform.BaseTransform;
import com.sun.scenario.effect.impl.Renderer;
import com.sun.scenario.effect.impl.state.GaussianBlurState;
/**
* A blur effect using a Gaussian convolution kernel, with a configurable
* radius.
*/
public class GaussianBlur extends CoreEffect {
private GaussianBlurState state = new GaussianBlurState();
/**
* Constructs a new {@code GaussianBlur} effect with the default radius
* (10.0), using the default input for source data.
* This is a shorthand equivalent to:
*
* new GaussianBlur(10f, DefaultInput)
*
*/
public GaussianBlur() {
this(10f, DefaultInput);
}
/**
* Constructs a new {@code GaussianBlur} effect with the given radius,
* using the default input for source data.
* This is a shorthand equivalent to:
*
* new GaussianBlur(radius, DefaultInput)
*
*
* @param radius the radius of the Gaussian kernel
* @throws IllegalArgumentException if {@code radius} is outside the
* allowable range
*/
public GaussianBlur(float radius) {
this(radius, DefaultInput);
}
/**
* Constructs a new {@code GaussianBlur} effect with the given radius.
*
* @param radius the radius of the Gaussian kernel
* @param input the single input {@code Effect}
* @throws IllegalArgumentException if {@code radius} is outside the
* allowable range, or if {@code input} is null
*/
public GaussianBlur(float radius, Effect input) {
super(input);
state.setRadius(radius);
}
@Override
Object getState() {
return state;
}
@Override
public AccelType getAccelType(FilterContext fctx) {
return Renderer.getRenderer(fctx).getAccelType();
}
/**
* Returns the input for this {@code Effect}.
*
* @return the input for this {@code Effect}
*/
public final Effect getInput() {
return getInputs().get(0);
}
/**
* Sets the input for this {@code Effect} to a specific {@code Effect}
* or to the default input if {@code input} is {@code null}.
*
* @param input the input for this {@code Effect}
*/
public void setInput(Effect input) {
setInput(0, input);
}
/**
* Returns the radius of the Gaussian kernel.
*
* @return the radius of the Gaussian kernel
*/
public float getRadius() {
return state.getRadius();
}
/**
* Sets the radius of the Gaussian kernel.
*
* Min: 0.0
* Max: 63.0
* Default: 10.0
* Identity: 0.0
*
*
* @param radius the radius of the Gaussian kernel
* @throws IllegalArgumentException if {@code radius} is outside the
* allowable range
*/
public void setRadius(float radius) {
float old = state.getRadius();
state.setRadius(radius);
}
@Override
public BaseBounds getBounds(BaseTransform transform, Effect defaultInput) {
BaseBounds r = super.getBounds(null, defaultInput);
int hpad = state.getPad(0);
int vpad = state.getPad(1);
RectBounds ret = new RectBounds(r.getMinX(), r.getMinY(), r.getMaxX(), r.getMaxY());
ret.grow(hpad, vpad);
return transformBounds(transform, ret);
}
@Override
public Rectangle getResultBounds(BaseTransform transform,
Rectangle outputClip,
ImageData... inputDatas)
{
Rectangle r = super.getResultBounds(transform, outputClip, inputDatas);
int hpad = state.getPad(0);
int vpad = state.getPad(1);
Rectangle ret = new Rectangle(r);
ret.grow(hpad, vpad);
return ret;
}
@Override
public ImageData filterImageDatas(FilterContext fctx,
BaseTransform transform,
Rectangle outputClip,
ImageData... inputs)
{
return state.filterImageDatas(this, fctx, transform, outputClip, inputs);
}
@Override
public boolean operatesInUserSpace() {
return true;
}
@Override
protected Rectangle getInputClip(int inputIndex,
BaseTransform transform,
Rectangle outputClip)
{
// A blur needs as much "fringe" data from its input as it creates
// around its output so we use the same expansion as is used in the
// result bounds.
if (outputClip != null) {
int hpad = state.getPad(0);
int vpad = state.getPad(1);
if ((hpad | vpad) != 0) {
outputClip = new Rectangle(outputClip);
outputClip.grow(hpad, vpad);
}
}
return outputClip;
}
@Override
public boolean reducesOpaquePixels() {
if (!state.isNop()) {
return true;
}
final Effect input = getInput();
return input != null && input.reducesOpaquePixels();
}
@Override
public DirtyRegionContainer getDirtyRegions(Effect defaultInput, DirtyRegionPool regionPool) {
Effect di = getDefaultedInput(0, defaultInput);
DirtyRegionContainer drc = di.getDirtyRegions(defaultInput, regionPool);
drc.grow(state.getPad(0), state.getPad(1));
return drc;
}
}