src.android.renderscript.ScriptIntrinsicConvolve3x3 Maven / Gradle / Ivy
/*
* Copyright (C) 2012 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.renderscript;
/**
* Intrinsic for applying a 3x3 convolve to an allocation.
*
* @deprecated Renderscript has been deprecated in API level 31. Please refer to the migration
* guide for the proposed alternatives.
**/
@Deprecated
public final class ScriptIntrinsicConvolve3x3 extends ScriptIntrinsic {
private final float[] mValues = new float[9];
private Allocation mInput;
private ScriptIntrinsicConvolve3x3(long id, RenderScript rs) {
super(id, rs);
}
/**
* Supported elements types are {@link Element#U8}, {@link
* Element#U8_2}, {@link Element#U8_3}, {@link Element#U8_4},
* {@link Element#F32}, {@link Element#F32_2}, {@link
* Element#F32_3}, and {@link Element#F32_4}.
*
* The default coefficients are:
*
* [ 0, 0, 0 ]
*
[ 0, 1, 0 ]
*
[ 0, 0, 0 ]
*
*
* @param rs The RenderScript context
* @param e Element type for intputs and outputs
*
* @return ScriptIntrinsicConvolve3x3
*/
public static ScriptIntrinsicConvolve3x3 create(RenderScript rs, Element e) {
float f[] = { 0, 0, 0, 0, 1, 0, 0, 0, 0};
if (!e.isCompatible(Element.U8(rs)) &&
!e.isCompatible(Element.U8_2(rs)) &&
!e.isCompatible(Element.U8_3(rs)) &&
!e.isCompatible(Element.U8_4(rs)) &&
!e.isCompatible(Element.F32(rs)) &&
!e.isCompatible(Element.F32_2(rs)) &&
!e.isCompatible(Element.F32_3(rs)) &&
!e.isCompatible(Element.F32_4(rs))) {
throw new RSIllegalArgumentException("Unsupported element type.");
}
long id = rs.nScriptIntrinsicCreate(1, e.getID(rs));
ScriptIntrinsicConvolve3x3 si = new ScriptIntrinsicConvolve3x3(id, rs);
si.setCoefficients(f);
return si;
}
/**
* Set the input of the 3x3 convolve.
* Must match the element type supplied during create.
*
* @param ain The input allocation.
*/
public void setInput(Allocation ain) {
mInput = ain;
setVar(1, ain);
}
/**
* Set the coefficients for the convolve.
*
*
The convolve layout is:
*
* [ 0, 1, 2 ]
*
[ 3, 4, 5 ]
*
[ 6, 7, 8 ]
*
*
* @param v The array of coefficients to set
*/
public void setCoefficients(float v[]) {
FieldPacker fp = new FieldPacker(9*4);
for (int ct=0; ct < mValues.length; ct++) {
mValues[ct] = v[ct];
fp.addF32(mValues[ct]);
}
setVar(0, fp);
}
/**
* Apply the filter to the input and save to the specified
* allocation.
*
* @param aout Output allocation. Must match creation element
* type.
*/
public void forEach(Allocation aout) {
forEach(0, (Allocation) null, aout, null);
}
/**
* Apply the filter to the input and save to the specified
* allocation.
*
* @param aout Output allocation. Must match creation element
* type.
* @param opt LaunchOptions for clipping
*/
public void forEach(Allocation aout, Script.LaunchOptions opt) {
forEach(0, (Allocation) null, aout, null, opt);
}
/**
* Get a KernelID for this intrinsic kernel.
*
* @return Script.KernelID The KernelID object.
*/
public Script.KernelID getKernelID() {
return createKernelID(0, 2, null, null);
}
/**
* Get a FieldID for the input field of this intrinsic.
*
* @return Script.FieldID The FieldID object.
*/
public Script.FieldID getFieldID_Input() {
return createFieldID(1, null);
}
}