vr/1.0/IVr.hal

   1 /*
   2  * Copyright (C) 2016 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.hardware.vr@1.0;
  18
  19 interface IVr {
  20   /**
  21    * Convenience method to set up any state needed at runtime startup.  This is
  22    * called once from the VrManagerService during its boot phase.
  23    */
  24   @callflow(next={"*"})
  25   @entry
  26   @exit
  27   init();
  28
  29   /**
  30    * Set the VR mode state.  Possible states of the enabled parameter are:
  31    * false - VR mode is disabled, turn off all VR-specific settings.
  32    * true - VR mode is enabled, turn on all VR-specific settings.
  33    *
  34    * This must be called whenever the the Android system enters or leaves VR
  35    * mode. This will typically occur when the user switches to or from a VR
  36    * application that is doing stereoscopic rendering.
  37    */
  38   @callflow(next={"*"})
  39   @exit
  40   setVrMode(bool enabled);
  41 };