ProgramVertex.java revision 9c9ad3f8c218954e46aab81f9af7834cea5675ca
1/* 2 * Copyright (C) 2008 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 17 /** 18 * <p>The Renderscript vertex program, also known as a vertex shader, describes a stage in 19 * the graphics pipeline responsible for manipulating geometric data in a user-defined way. 20 * The object is constructed by providing the Renderscript system with the following data:</p> 21 * <ul> 22 * <li>Element describing its varying inputs or attributes</li> 23 * <li>GLSL shader string that defines the body of the program</li> 24 * <li>a Type that describes the layout of an Allocation containing constant or uniform inputs</li> 25 * </ul> 26 * 27 * <p>Once the program is created, you bind it to the graphics context, RenderScriptGL, and it will be used for 28 * all subsequent draw calls until you bind a new program. If the program has constant inputs, 29 * the user needs to bind an allocation containing those inputs. The allocation's type must match 30 * the one provided during creation. The Renderscript library then does all the necessary plumbing 31 * to send those constants to the graphics hardware. Varying inputs to the shader, such as position, normal, 32 * and texture coordinates are matched by name between the input Element and the Mesh object being drawn. 33 * The signatures don't have to be exact or in any strict order. As long as the input name in the shader 34 * matches a channel name and size available on the mesh, the runtime takes care of connecting the 35 * two. Unlike OpenGL, there is no need to link the vertex and fragment programs.</p> 36 * 37 **/ 38package android.renderscript; 39 40 41import android.graphics.Matrix; 42import android.util.Log; 43 44 45/** 46 * ProgramVertex, also know as a vertex shader, describes a 47 * stage in the graphics pipeline responsible for manipulating 48 * geometric data in a user-defined way. 49 * 50 **/ 51public class ProgramVertex extends Program { 52 53 ProgramVertex(int id, RenderScript rs) { 54 super(id, rs); 55 } 56 57 /** 58 * @return number of input attribute elements 59 */ 60 public int getInputCount() { 61 return mInputs != null ? mInputs.length : 0; 62 } 63 64 /** 65 * @param slot location of the input to return 66 * @return input attribute element 67 */ 68 public Element getInput(int slot) { 69 if (slot < 0 || slot >= mInputs.length) { 70 throw new IllegalArgumentException("Slot ID out of range."); 71 } 72 return mInputs[slot]; 73 } 74 75 /** 76 * Builder class for creating ProgramVertex objects. 77 * The builder starts empty and the user must minimally provide 78 * the GLSL shader code, and the varying inputs. Constant, or 79 * uniform parameters to the shader may optionally be provided as 80 * well. 81 * 82 **/ 83 public static class Builder extends BaseProgramBuilder { 84 /** 85 * Create a builder object. 86 * 87 * @param rs Context to which the program will belong. 88 */ 89 public Builder(RenderScript rs) { 90 super(rs); 91 } 92 93 /** 94 * Add varying inputs to the program 95 * 96 * @param e element describing the layout of the varying input 97 * structure 98 * @return self 99 */ 100 public Builder addInput(Element e) throws IllegalStateException { 101 // Should check for consistant and non-conflicting names... 102 if(mInputCount >= MAX_INPUT) { 103 throw new RSIllegalArgumentException("Max input count exceeded."); 104 } 105 if (e.isComplex()) { 106 throw new RSIllegalArgumentException("Complex elements not allowed."); 107 } 108 mInputs[mInputCount++] = e; 109 return this; 110 } 111 112 /** 113 * Creates ProgramVertex from the current state of the builder 114 * 115 * @return ProgramVertex 116 */ 117 public ProgramVertex create() { 118 mRS.validate(); 119 int[] tmp = new int[(mInputCount + mOutputCount + mConstantCount + mTextureCount) * 2]; 120 String[] texNames = new String[mTextureCount]; 121 int idx = 0; 122 123 for (int i=0; i < mInputCount; i++) { 124 tmp[idx++] = ProgramParam.INPUT.mID; 125 tmp[idx++] = mInputs[i].getID(mRS); 126 } 127 for (int i=0; i < mOutputCount; i++) { 128 tmp[idx++] = ProgramParam.OUTPUT.mID; 129 tmp[idx++] = mOutputs[i].getID(mRS); 130 } 131 for (int i=0; i < mConstantCount; i++) { 132 tmp[idx++] = ProgramParam.CONSTANT.mID; 133 tmp[idx++] = mConstants[i].getID(mRS); 134 } 135 for (int i=0; i < mTextureCount; i++) { 136 tmp[idx++] = ProgramParam.TEXTURE_TYPE.mID; 137 tmp[idx++] = mTextureTypes[i].mID; 138 texNames[i] = mTextureNames[i]; 139 } 140 141 int id = mRS.nProgramVertexCreate(mShader, texNames, tmp); 142 ProgramVertex pv = new ProgramVertex(id, mRS); 143 initProgram(pv); 144 return pv; 145 } 146 } 147 148} 149