ProgramVertexFixedFunction.java revision 9807155b11a25fb6068edc9b1cd82928ac2f05de 
1/*
2 * Copyright (C) 2008-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
20import android.graphics.Matrix;
21import android.util.Log;
22
23
24/**
25 * @hide
26 * @deprecated in API 16
27 * ProgramVertexFixedFunction is a helper class that provides a
28 * simple way to create a fixed function emulation vertex shader
29 * without writing any GLSL code.
30 *
31 **/
32public class ProgramVertexFixedFunction extends ProgramVertex {
33
34    ProgramVertexFixedFunction(long id, RenderScript rs) {
35        super(id, rs);
36    }
37
38    /**
39     * @deprecated in API 16
40     * Binds the constant buffer containing fixed function emulation
41     * matrices
42     *
43     * @param va allocation containing fixed function matrices
44     */
45    public void bindConstants(Constants va) {
46        mRS.validate();
47        bindConstants(va.getAllocation(), 0);
48    }
49
50    static class InternalBuilder extends BaseProgramBuilder {
51        /**
52         * @deprecated in API 16
53         */
54        public InternalBuilder(RenderScript rs) {
55            super(rs);
56        }
57
58        /**
59         * @deprecated in API 16
60         */
61        public InternalBuilder addInput(Element e) throws IllegalStateException {
62            // Should check for consistant and non-conflicting names...
63            if(mInputCount >= MAX_INPUT) {
64                throw new RSIllegalArgumentException("Max input count exceeded.");
65            }
66            if (e.isComplex()) {
67                throw new RSIllegalArgumentException("Complex elements not allowed.");
68            }
69            mInputs[mInputCount++] = e;
70            return this;
71        }
72
73        /**
74         * @deprecated in API 16
75         * Creates ProgramVertexFixedFunction from the current state of
76         * the builder
77         *
78         * @return  ProgramVertexFixedFunction
79         */
80        public ProgramVertexFixedFunction create() {
81            mRS.validate();
82            long[] tmp = new long[(mInputCount + mOutputCount + mConstantCount + mTextureCount) * 2];
83            String[] texNames = new String[mTextureCount];
84            int idx = 0;
85
86            for (int i=0; i < mInputCount; i++) {
87                tmp[idx++] = ProgramParam.INPUT.mID;
88                tmp[idx++] = mInputs[i].getID(mRS);
89            }
90            for (int i=0; i < mOutputCount; i++) {
91                tmp[idx++] = ProgramParam.OUTPUT.mID;
92                tmp[idx++] = mOutputs[i].getID(mRS);
93            }
94            for (int i=0; i < mConstantCount; i++) {
95                tmp[idx++] = ProgramParam.CONSTANT.mID;
96                tmp[idx++] = mConstants[i].getID(mRS);
97            }
98            for (int i=0; i < mTextureCount; i++) {
99                tmp[idx++] = ProgramParam.TEXTURE_TYPE.mID;
100                tmp[idx++] = mTextureTypes[i].mID;
101                texNames[i] = mTextureNames[i];
102            }
103
104            long id = mRS.nProgramVertexCreate(mShader, texNames, tmp);
105            ProgramVertexFixedFunction pv = new ProgramVertexFixedFunction(id, mRS);
106            initProgram(pv);
107            return pv;
108        }
109    }
110
111    /**
112     * @deprecated in API 16
113     */
114    public static class Builder {
115        boolean mTextureMatrixEnable;
116        String mShader;
117        RenderScript mRS;
118
119        /**
120         * @deprecated in API 16
121         * Creates a builder for fixed function vertex program
122         *
123         * @param rs Context to which the program will belong.
124         */
125        public Builder(RenderScript rs) {
126            mRS = rs;
127        }
128
129        /**
130         * @deprecated in API 16
131         * Specifies whether texture matrix calculations are to be added
132         * to the shader
133         *
134         */
135        public Builder setTextureMatrixEnable(boolean enable) {
136            mTextureMatrixEnable = enable;
137            return this;
138        }
139        static Type getConstantInputType(RenderScript rs) {
140            Element.Builder b = new Element.Builder(rs);
141            b.add(Element.MATRIX4X4(rs), "MV");
142            b.add(Element.MATRIX4X4(rs), "P");
143            b.add(Element.MATRIX4X4(rs), "TexMatrix");
144            b.add(Element.MATRIX4X4(rs), "MVP");
145
146            Type.Builder typeBuilder = new Type.Builder(rs, b.create());
147            typeBuilder.setX(1);
148            return typeBuilder.create();
149        }
150
151        private void buildShaderString() {
152
153            mShader  = "//rs_shader_internal\n";
154            mShader += "varying vec4 varColor;\n";
155            mShader += "varying vec2 varTex0;\n";
156
157            mShader += "void main() {\n";
158            mShader += "  gl_Position = UNI_MVP * ATTRIB_position;\n";
159            mShader += "  gl_PointSize = 1.0;\n";
160
161            mShader += "  varColor = ATTRIB_color;\n";
162            if (mTextureMatrixEnable) {
163                mShader += "  varTex0 = (UNI_TexMatrix * vec4(ATTRIB_texture0, 0.0, 1.0)).xy;\n";
164            } else {
165                mShader += "  varTex0 = ATTRIB_texture0;\n";
166            }
167            mShader += "}\n";
168        }
169
170        /**
171         * @deprecated in API 16
172         * Creates ProgramVertexFixedFunction from the current state of
173         * the builder
174         *
175         * @return Fixed function emulation ProgramVertex
176         */
177        public ProgramVertexFixedFunction create() {
178            buildShaderString();
179
180            InternalBuilder sb = new InternalBuilder(mRS);
181            sb.setShader(mShader);
182            sb.addConstant(getConstantInputType(mRS));
183
184            Element.Builder b = new Element.Builder(mRS);
185            b.add(Element.F32_4(mRS), "position");
186            b.add(Element.F32_4(mRS), "color");
187            b.add(Element.F32_3(mRS), "normal");
188            b.add(Element.F32_2(mRS), "texture0");
189            sb.addInput(b.create());
190
191            return sb.create();
192        }
193    }
194
195    /**
196     * @deprecated in API 16
197     * Helper class to store modelview, projection and texture
198     * matrices for ProgramVertexFixedFunction
199     *
200     */
201    public static class Constants {
202        static final int MODELVIEW_OFFSET = 0;
203        static final int PROJECTION_OFFSET = 16;
204        static final int TEXTURE_OFFSET = 32;
205
206        Matrix4f mModel;
207        Matrix4f mProjection;
208        Matrix4f mTexture;
209
210        Allocation mAlloc;
211        Allocation getAllocation() {
212            return mAlloc;
213        }
214        private FieldPacker mIOBuffer;
215
216        /**
217        * @deprecated in API 16
218        * Creates a buffer to store fixed function emulation matrices
219        *
220        * @param rs Context to which the allocation will belong.
221        **/
222        public Constants(RenderScript rs) {
223            Type constInputType = ProgramVertexFixedFunction.Builder.getConstantInputType(rs);
224            mAlloc = Allocation.createTyped(rs, constInputType);
225            int bufferSize = constInputType.getElement().getBytesSize()*
226                             constInputType.getCount();
227            mIOBuffer = new FieldPacker(bufferSize);
228            mModel = new Matrix4f();
229            mProjection = new Matrix4f();
230            mTexture = new Matrix4f();
231            setModelview(new Matrix4f());
232            setProjection(new Matrix4f());
233            setTexture(new Matrix4f());
234        }
235
236        /**
237        * @deprecated in API 16
238        * Forces deallocation of memory backing the contant matrices.
239        * Normally, this is unnecessary and will be garbage collected
240        *
241        */
242        public void destroy() {
243            mAlloc.destroy();
244            mAlloc = null;
245        }
246
247        private void addToBuffer(int offset, Matrix4f m) {
248            mIOBuffer.reset(offset);
249            for(int i = 0; i < 16; i ++) {
250                mIOBuffer.addF32(m.mMat[i]);
251            }
252            mAlloc.setFromFieldPacker(0, mIOBuffer);
253        }
254
255        /**
256        * @deprecated in API 16
257        * Sets the modelview matrix in the fixed function matrix buffer
258        *
259        * @param m modelview matrix
260        */
261        public void setModelview(Matrix4f m) {
262            mModel.load(m);
263            addToBuffer(MODELVIEW_OFFSET*4, m);
264        }
265
266        /**
267        * @deprecated in API 16
268        * Sets the projection matrix in the fixed function matrix buffer
269        *
270        * @param m projection matrix
271        */
272        public void setProjection(Matrix4f m) {
273            mProjection.load(m);
274            addToBuffer(PROJECTION_OFFSET*4, m);
275        }
276
277        /**
278        * @deprecated in API 16
279        * Sets the texture matrix in the fixed function matrix buffer.
280        * Texture matrix must be enabled in the
281        * ProgramVertexFixedFunction builder for the shader to utilize
282        * it.
283        *
284        * @param m modelview matrix
285        */
286        public void setTexture(Matrix4f m) {
287            mTexture.load(m);
288            addToBuffer(TEXTURE_OFFSET*4, m);
289        }
290    }
291}
292