Shader.java revision 9066cfe9886ac131c34d59ed0e2d287b0e3c0087
19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2006 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.graphics; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Shader is the based class for objects that return horizontal spans of colors 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * during drawing. A subclass of Shader is installed in a Paint calling 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * paint.setShader(shader). After that any object (other than a bitmap) that is 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * drawn with that paint will get its color(s) from the shader. 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic class Shader { 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // this is set by subclasses, but don't make it public 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* package */ int native_instance; 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public enum TileMode { 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * replicate the edge color if the shader draws outside of its 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * original bounds 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project CLAMP (0), 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * repeat the shader's image horizontally and vertically 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project REPEAT (1), 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * repeat the shader's image horizontally and vertically, alternating 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * mirror images so that adjacent images always seam 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project MIRROR (2); 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project TileMode(int nativeInt) { 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this.nativeInt = nativeInt; 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final int nativeInt; 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return true if the shader has a non-identity local matrix. 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param localM If not null, it is set to the shader's local matrix. 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return true if the shader has a non-identity local matrix 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean getLocalMatrix(Matrix localM) { 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return nativeGetLocalMatrix(native_instance, localM.native_instance); 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Set the shader's local matrix. Passing null will reset the shader's 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * matrix to identity 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param localM The shader's new local matrix, or null to specify identity 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setLocalMatrix(Matrix localM) { 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project nativeSetLocalMatrix(native_instance, 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project localM != null ? localM.native_instance : 0); 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected void finalize() throws Throwable { 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project nativeDestructor(native_instance); 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private static native void nativeDestructor(int native_shader); 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private static native boolean nativeGetLocalMatrix(int native_shader, 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int matrix_instance); 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private static native void nativeSetLocalMatrix(int native_shader, 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int matrix_instance); 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 81