1/*
2 * Copyright (C) 2012 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.renderscript;
18
19/**
20 * Intrinsic Gausian blur filter. Applies a gaussian blur of the
21 * specified radius to all elements of an allocation.
22 *
23 *
24 **/
25public final class ScriptIntrinsicBlur extends ScriptIntrinsic {
26    private final float[] mValues = new float[9];
27    private Allocation mInput;
28
29    private ScriptIntrinsicBlur(long id, RenderScript rs) {
30        super(id, rs);
31    }
32
33    /**
34     * Create an intrinsic for applying a blur to an allocation. The
35     * default radius is 5.0.
36     *
37     * Supported elements types are {@link Element#U8_4}
38     *
39     * @param rs The RenderScript context
40     * @param e Element type for inputs and outputs
41     *
42     * @return ScriptIntrinsicBlur
43     */
44    public static ScriptIntrinsicBlur create(RenderScript rs, Element e) {
45        if ((!e.isCompatible(Element.U8_4(rs))) && (!e.isCompatible(Element.U8(rs)))) {
46            throw new RSIllegalArgumentException("Unsuported element type.");
47        }
48        long id = rs.nScriptIntrinsicCreate(5, e.getID(rs));
49        ScriptIntrinsicBlur sib = new ScriptIntrinsicBlur(id, rs);
50        sib.setRadius(5.f);
51        return sib;
52    }
53
54    /**
55     * Set the input of the blur.
56     * Must match the element type supplied during create.
57     *
58     * @param ain The input allocation
59     */
60    public void setInput(Allocation ain) {
61        mInput = ain;
62        setVar(1, ain);
63    }
64
65    /**
66     * Set the radius of the Blur.
67     *
68     * Supported range 0 < radius <= 25
69     *
70     * @param radius The radius of the blur
71     */
72    public void setRadius(float radius) {
73        if (radius <= 0 || radius > 25) {
74            throw new RSIllegalArgumentException("Radius out of range (0 < r <= 25).");
75        }
76        setVar(0, radius);
77    }
78
79    /**
80     * Apply the filter to the input and save to the specified
81     * allocation.
82     *
83     * @param aout Output allocation. Must match creation element
84     *             type.
85     */
86    public void forEach(Allocation aout) {
87        forEach(0, (Allocation) null, aout, null);
88    }
89
90    /**
91     * Apply the filter to the input and save to the specified
92     * allocation.
93     *
94     * @param aout Output allocation. Must match creation element
95     *             type.
96     * @param opt LaunchOptions for clipping
97     */
98    public void forEach(Allocation aout, Script.LaunchOptions opt) {
99        forEach(0, (Allocation) null, aout, null, opt);
100    }
101
102
103    /**
104     * Get a KernelID for this intrinsic kernel.
105     *
106     * @return Script.KernelID The KernelID object.
107     */
108    public Script.KernelID getKernelID() {
109        return createKernelID(0, 2, null, null);
110    }
111
112    /**
113     * Get a FieldID for the input field of this intrinsic.
114     *
115     * @return Script.FieldID The FieldID object.
116     */
117    public Script.FieldID getFieldID_Input() {
118        return createFieldID(1, null);
119    }
120}
121