1 /* 2 * Copyright (c) 2009, 2013, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package com.sun.scenario.effect.impl.state; 27 28 import com.sun.javafx.geom.Rectangle; 29 import com.sun.javafx.geom.transform.BaseTransform; 30 31 /** 32 * The helper class for defining a 1 dimensional linear convolution kernel 33 * for either the LinearConvolve or LinearConvolveShadow shaders. 34 * This class is abstract and must be subclassed for specific linear 35 * convolutions. 36 */ 37 public abstract class LinearConvolveKernel { 38 /** 39 * Returns true if this is a LinearConvolveShadow operation, or false 40 * if the operation is a regular LinearConvolve. 41 * 42 * @return true if this is a Shadow operation 43 */ 44 public boolean isShadow() { 45 return false; 46 } 47 48 /** 49 * Returns true if the entire operation of this linear convolution 50 * would have no effect on the source data. 51 * 52 * @return true if the operation is a NOP 53 */ 54 public boolean isNop() { 55 return false; 56 } 57 58 /** 59 * Returns the size of the output image needed for a given input 60 * image dimensions and a given pass of the algorithm. 61 * 62 * @param srcdimension the bounds of the input image 63 * @param pass the algorithm pass being performed 64 * @return the bounds of the result image 65 */ 66 public abstract Rectangle getResultBounds(Rectangle srcdimension, int pass); 67 68 /** 69 * Returns the size of the kernel for a given pass. 70 * 71 * @param pass the pass of the algorithm being performed 72 * @return the size of the kernel for the given pass 73 */ 74 public abstract int getKernelSize(int pass); 75 76 public abstract LinearConvolveRenderState getRenderState(BaseTransform filtertx); 77 }