All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.scenario.effect.Brightpass Maven / Gradle / Ivy

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.Rectangle;
import com.sun.javafx.geom.transform.BaseTransform;

/**
 * An effect that filters out (i.e., replaces with a transparent value) all
 * pixels with brightness lower than the configurable threshold value.
 */
public class Brightpass extends CoreEffect {

    private float threshold;

    /**
     * Constructs a new {@code Brightpass} effect with the default
     * threshold value (0.3), using the default input for source data.
     * This is a shorthand equivalent to:
     * 
     *     new Brightpass(DefaultInput)
     * 
*/ public Brightpass() { this(DefaultInput); } /** * Constructs a new {@code Brightpass} effect with the default * threshold value (0.3). * * @param input the single input {@code Effect} * @throws IllegalArgumentException if {@code input} is null */ public Brightpass(Effect input) { super(input); setThreshold(0.3f); updatePeerKey("Brightpass"); } /** * 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}. * * @param input the input for this {@code Effect} * @throws IllegalArgumentException if {@code input} is null */ public void setInput(Effect input) { setInput(0, input); } /** * Returns the threshold, which controls which pixels are included in * the resulting image. Pixel values with brightness greater than * this threshold value will be included. * * @return the threshold value */ public float getThreshold() { return threshold; } /** * Sets the threshold, which controls which pixels are included in * the resulting image. Pixel values with brightness greater than * this threshold value will be included. *
     *       Min: 0.0
     *       Max: 1.0
     *   Default: 0.3
     *  Identity: n/a
     * 
* * @param threshold the threshold value * @throws IllegalArgumentException if {@code threshold} is outside * the allowable range */ public void setThreshold(float threshold) { if (threshold < 0f || threshold > 1f) { throw new IllegalArgumentException("Threshold must be in the range [0,1]"); } float old = this.threshold; this.threshold = threshold; } @Override protected Rectangle getInputClip(int inputIndex, BaseTransform transform, Rectangle outputClip) { // Trivially, this effect simply modifies the alpha values of the // pixels of the input on a 1:1 basis so the input clip is the same // as the output clip. return outputClip; } @Override public boolean reducesOpaquePixels() { return true; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy