Home | History | Annotate | Download | only in view
      1 /*
      2  * Copyright (C) 2006 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 package android.view;
     18 
     19 /**
     20  * An instance of this class represents a connection to the surface
     21  * flinger, from which you can create one or more Surface instances that will
     22  * be composited to the screen.
     23  * {@hide}
     24  */
     25 public final class SurfaceSession {
     26     // Note: This field is accessed by native code.
     27     private long mNativeClient; // SurfaceComposerClient*
     28 
     29     private static native long nativeCreate();
     30     private static native long nativeCreateScoped(long surfacePtr);
     31     private static native void nativeDestroy(long ptr);
     32     private static native void nativeKill(long ptr);
     33 
     34     /** Create a new connection with the surface flinger. */
     35     public SurfaceSession() {
     36         mNativeClient = nativeCreate();
     37     }
     38 
     39     public SurfaceSession(Surface root) {
     40         mNativeClient = nativeCreateScoped(root.mNativeObject);
     41     }
     42 
     43     /* no user serviceable parts here ... */
     44     @Override
     45     protected void finalize() throws Throwable {
     46         try {
     47             if (mNativeClient != 0) {
     48                 nativeDestroy(mNativeClient);
     49             }
     50         } finally {
     51             super.finalize();
     52         }
     53     }
     54 
     55     /**
     56      * Forcibly detach native resources associated with this object.
     57      * Unlike destroy(), after this call any surfaces that were created
     58      * from the session will no longer work.
     59      */
     60     public void kill() {
     61         nativeKill(mNativeClient);
     62     }
     63 }
     64 
     65