Karthik Ravi Shankar | cdf9ce7 | 2017-04-12 15:31:20 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2017 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.app; |
| 18 | |
rongliu | 5549266 | 2018-03-21 14:34:58 -0700 | [diff] [blame] | 19 | import android.annotation.IntDef; |
| 20 | import android.annotation.SystemApi; |
Karthik Ravi Shankar | cdf9ce7 | 2017-04-12 15:31:20 -0700 | [diff] [blame] | 21 | import android.os.Parcel; |
| 22 | import android.os.Parcelable; |
| 23 | |
| 24 | import java.io.PrintWriter; |
rongliu | 5549266 | 2018-03-21 14:34:58 -0700 | [diff] [blame] | 25 | import java.lang.annotation.Retention; |
| 26 | import java.lang.annotation.RetentionPolicy; |
Karthik Ravi Shankar | cdf9ce7 | 2017-04-12 15:31:20 -0700 | [diff] [blame] | 27 | |
| 28 | /** |
| 29 | * Display properties to be used by VR mode when creating a virtual display. |
| 30 | * |
| 31 | * @hide |
| 32 | */ |
rongliu | 5549266 | 2018-03-21 14:34:58 -0700 | [diff] [blame] | 33 | @SystemApi |
Santos Cordon | 627a68f | 2017-06-12 17:57:17 -0700 | [diff] [blame] | 34 | public final class Vr2dDisplayProperties implements Parcelable { |
Karthik Ravi Shankar | cdf9ce7 | 2017-04-12 15:31:20 -0700 | [diff] [blame] | 35 | |
Santos Cordon | 627a68f | 2017-06-12 17:57:17 -0700 | [diff] [blame] | 36 | public static final int FLAG_VIRTUAL_DISPLAY_ENABLED = 1; |
| 37 | |
Pat Plunkett | 74d3fa5 | 2018-09-04 10:45:25 -0700 | [diff] [blame] | 38 | /** @hide */ |
rongliu | 5549266 | 2018-03-21 14:34:58 -0700 | [diff] [blame] | 39 | @Retention(RetentionPolicy.SOURCE) |
| 40 | @IntDef({ |
| 41 | FLAG_VIRTUAL_DISPLAY_ENABLED |
| 42 | }) |
| 43 | public @interface Vr2dDisplayFlag {} |
| 44 | |
Santos Cordon | 627a68f | 2017-06-12 17:57:17 -0700 | [diff] [blame] | 45 | /** |
| 46 | * The actual width, height and dpi. |
| 47 | */ |
Karthik Ravi Shankar | cdf9ce7 | 2017-04-12 15:31:20 -0700 | [diff] [blame] | 48 | private final int mWidth; |
| 49 | private final int mHeight; |
| 50 | private final int mDpi; |
| 51 | |
Santos Cordon | 627a68f | 2017-06-12 17:57:17 -0700 | [diff] [blame] | 52 | // Flags describing the virtual display behavior. |
| 53 | private final int mAddedFlags; |
| 54 | private final int mRemovedFlags; |
| 55 | |
Karthik Ravi Shankar | 2b9aaed | 2017-05-01 01:34:19 -0700 | [diff] [blame] | 56 | public Vr2dDisplayProperties(int width, int height, int dpi) { |
Santos Cordon | 627a68f | 2017-06-12 17:57:17 -0700 | [diff] [blame] | 57 | this(width, height, dpi, 0, 0); |
| 58 | } |
| 59 | |
| 60 | private Vr2dDisplayProperties(int width, int height, int dpi, int flags, int removedFlags) { |
Karthik Ravi Shankar | cdf9ce7 | 2017-04-12 15:31:20 -0700 | [diff] [blame] | 61 | mWidth = width; |
| 62 | mHeight = height; |
| 63 | mDpi = dpi; |
Santos Cordon | 627a68f | 2017-06-12 17:57:17 -0700 | [diff] [blame] | 64 | mAddedFlags = flags; |
| 65 | mRemovedFlags = removedFlags; |
Karthik Ravi Shankar | cdf9ce7 | 2017-04-12 15:31:20 -0700 | [diff] [blame] | 66 | } |
| 67 | |
| 68 | @Override |
| 69 | public int hashCode() { |
| 70 | int result = getWidth(); |
| 71 | result = 31 * result + getHeight(); |
| 72 | result = 31 * result + getDpi(); |
| 73 | return result; |
| 74 | } |
| 75 | |
| 76 | @Override |
| 77 | public String toString() { |
Santos Cordon | 627a68f | 2017-06-12 17:57:17 -0700 | [diff] [blame] | 78 | return "Vr2dDisplayProperties{" |
| 79 | + "mWidth=" + mWidth |
| 80 | + ", mHeight=" + mHeight |
| 81 | + ", mDpi=" + mDpi |
| 82 | + ", flags=" + toReadableFlags(mAddedFlags) |
| 83 | + ", removed_flags=" + toReadableFlags(mRemovedFlags) |
| 84 | + "}"; |
Karthik Ravi Shankar | cdf9ce7 | 2017-04-12 15:31:20 -0700 | [diff] [blame] | 85 | } |
| 86 | |
| 87 | @Override |
| 88 | public boolean equals(Object o) { |
| 89 | if (this == o) return true; |
| 90 | if (o == null || getClass() != o.getClass()) return false; |
| 91 | |
Karthik Ravi Shankar | 2b9aaed | 2017-05-01 01:34:19 -0700 | [diff] [blame] | 92 | Vr2dDisplayProperties that = (Vr2dDisplayProperties) o; |
Karthik Ravi Shankar | cdf9ce7 | 2017-04-12 15:31:20 -0700 | [diff] [blame] | 93 | |
rongliu | 5549266 | 2018-03-21 14:34:58 -0700 | [diff] [blame] | 94 | if (getAddedFlags() != that.getAddedFlags()) return false; |
Santos Cordon | 627a68f | 2017-06-12 17:57:17 -0700 | [diff] [blame] | 95 | if (getRemovedFlags() != that.getRemovedFlags()) return false; |
Karthik Ravi Shankar | cdf9ce7 | 2017-04-12 15:31:20 -0700 | [diff] [blame] | 96 | if (getWidth() != that.getWidth()) return false; |
| 97 | if (getHeight() != that.getHeight()) return false; |
| 98 | return getDpi() == that.getDpi(); |
| 99 | } |
| 100 | |
| 101 | @Override |
| 102 | public int describeContents() { |
| 103 | return 0; |
| 104 | } |
| 105 | |
| 106 | @Override |
| 107 | public void writeToParcel(Parcel dest, int flags) { |
| 108 | dest.writeInt(mWidth); |
| 109 | dest.writeInt(mHeight); |
| 110 | dest.writeInt(mDpi); |
Santos Cordon | 627a68f | 2017-06-12 17:57:17 -0700 | [diff] [blame] | 111 | dest.writeInt(mAddedFlags); |
| 112 | dest.writeInt(mRemovedFlags); |
Karthik Ravi Shankar | cdf9ce7 | 2017-04-12 15:31:20 -0700 | [diff] [blame] | 113 | } |
| 114 | |
Jeff Sharkey | 9e8f83d | 2019-02-28 12:06:45 -0700 | [diff] [blame] | 115 | public static final @android.annotation.NonNull Parcelable.Creator<Vr2dDisplayProperties> CREATOR |
Karthik Ravi Shankar | 2b9aaed | 2017-05-01 01:34:19 -0700 | [diff] [blame] | 116 | = new Parcelable.Creator<Vr2dDisplayProperties>() { |
Karthik Ravi Shankar | cdf9ce7 | 2017-04-12 15:31:20 -0700 | [diff] [blame] | 117 | @Override |
Karthik Ravi Shankar | 2b9aaed | 2017-05-01 01:34:19 -0700 | [diff] [blame] | 118 | public Vr2dDisplayProperties createFromParcel(Parcel source) { |
| 119 | return new Vr2dDisplayProperties(source); |
Karthik Ravi Shankar | cdf9ce7 | 2017-04-12 15:31:20 -0700 | [diff] [blame] | 120 | } |
| 121 | |
| 122 | @Override |
Karthik Ravi Shankar | 2b9aaed | 2017-05-01 01:34:19 -0700 | [diff] [blame] | 123 | public Vr2dDisplayProperties[] newArray(int size) { |
| 124 | return new Vr2dDisplayProperties[size]; |
Karthik Ravi Shankar | cdf9ce7 | 2017-04-12 15:31:20 -0700 | [diff] [blame] | 125 | } |
| 126 | }; |
| 127 | |
Karthik Ravi Shankar | 2b9aaed | 2017-05-01 01:34:19 -0700 | [diff] [blame] | 128 | private Vr2dDisplayProperties(Parcel source) { |
Karthik Ravi Shankar | cdf9ce7 | 2017-04-12 15:31:20 -0700 | [diff] [blame] | 129 | mWidth = source.readInt(); |
| 130 | mHeight = source.readInt(); |
| 131 | mDpi = source.readInt(); |
Santos Cordon | 627a68f | 2017-06-12 17:57:17 -0700 | [diff] [blame] | 132 | mAddedFlags = source.readInt(); |
| 133 | mRemovedFlags = source.readInt(); |
Karthik Ravi Shankar | cdf9ce7 | 2017-04-12 15:31:20 -0700 | [diff] [blame] | 134 | } |
| 135 | |
rongliu | 5549266 | 2018-03-21 14:34:58 -0700 | [diff] [blame] | 136 | /** |
| 137 | * Prints out dump info. |
| 138 | */ |
Karthik Ravi Shankar | cdf9ce7 | 2017-04-12 15:31:20 -0700 | [diff] [blame] | 139 | public void dump(PrintWriter pw, String prefix) { |
Santos Cordon | 627a68f | 2017-06-12 17:57:17 -0700 | [diff] [blame] | 140 | pw.println(prefix + toString()); |
Karthik Ravi Shankar | cdf9ce7 | 2017-04-12 15:31:20 -0700 | [diff] [blame] | 141 | } |
| 142 | |
rongliu | 5549266 | 2018-03-21 14:34:58 -0700 | [diff] [blame] | 143 | /** |
| 144 | * Returns the width of VR 2d display. |
| 145 | */ |
Karthik Ravi Shankar | cdf9ce7 | 2017-04-12 15:31:20 -0700 | [diff] [blame] | 146 | public int getWidth() { |
| 147 | return mWidth; |
| 148 | } |
| 149 | |
rongliu | 5549266 | 2018-03-21 14:34:58 -0700 | [diff] [blame] | 150 | /** |
| 151 | * Returns the height of VR 2d display. |
| 152 | */ |
Karthik Ravi Shankar | cdf9ce7 | 2017-04-12 15:31:20 -0700 | [diff] [blame] | 153 | public int getHeight() { |
| 154 | return mHeight; |
| 155 | } |
| 156 | |
rongliu | 5549266 | 2018-03-21 14:34:58 -0700 | [diff] [blame] | 157 | /** |
| 158 | * Returns the dpi of VR 2d display. |
| 159 | */ |
Karthik Ravi Shankar | cdf9ce7 | 2017-04-12 15:31:20 -0700 | [diff] [blame] | 160 | public int getDpi() { |
| 161 | return mDpi; |
| 162 | } |
Santos Cordon | 627a68f | 2017-06-12 17:57:17 -0700 | [diff] [blame] | 163 | |
rongliu | 5549266 | 2018-03-21 14:34:58 -0700 | [diff] [blame] | 164 | /** |
| 165 | * Returns the added flags of VR 2d display. Flags are combined by logic or. |
| 166 | */ |
| 167 | @Vr2dDisplayFlag |
| 168 | public int getAddedFlags() { |
Santos Cordon | 627a68f | 2017-06-12 17:57:17 -0700 | [diff] [blame] | 169 | return mAddedFlags; |
| 170 | } |
| 171 | |
rongliu | 5549266 | 2018-03-21 14:34:58 -0700 | [diff] [blame] | 172 | /** |
| 173 | * Returns the removed flags of VR 2d display. Flags are combined by logic or. |
| 174 | */ |
| 175 | @Vr2dDisplayFlag |
Santos Cordon | 627a68f | 2017-06-12 17:57:17 -0700 | [diff] [blame] | 176 | public int getRemovedFlags() { |
| 177 | return mRemovedFlags; |
| 178 | } |
| 179 | |
| 180 | private static String toReadableFlags(int flags) { |
| 181 | String retval = "{"; |
| 182 | if ((flags & FLAG_VIRTUAL_DISPLAY_ENABLED) == FLAG_VIRTUAL_DISPLAY_ENABLED) { |
| 183 | retval += "enabled"; |
| 184 | } |
| 185 | return retval + "}"; |
| 186 | } |
| 187 | |
| 188 | /** |
| 189 | * Convenience class for creating Vr2dDisplayProperties. |
| 190 | */ |
| 191 | public static class Builder { |
| 192 | private int mAddedFlags = 0; |
| 193 | private int mRemovedFlags = 0; |
| 194 | |
| 195 | // Negative values are translated as an "ignore" to VrManagerService. |
| 196 | private int mWidth = -1; |
| 197 | private int mHeight = -1; |
| 198 | private int mDpi = -1; |
| 199 | |
| 200 | public Builder() { |
| 201 | } |
| 202 | |
| 203 | /** |
| 204 | * Sets the dimensions to use for the virtual display. |
| 205 | */ |
| 206 | public Builder setDimensions(int width, int height, int dpi) { |
| 207 | mWidth = width; |
| 208 | mHeight = height; |
| 209 | mDpi = dpi; |
| 210 | return this; |
| 211 | } |
| 212 | |
| 213 | /** |
| 214 | * Toggles the virtual display functionality for 2D activities in VR. |
| 215 | */ |
| 216 | public Builder setEnabled(boolean enabled) { |
| 217 | if (enabled) { |
| 218 | addFlags(FLAG_VIRTUAL_DISPLAY_ENABLED); |
| 219 | } else { |
| 220 | removeFlags(FLAG_VIRTUAL_DISPLAY_ENABLED); |
| 221 | } |
| 222 | return this; |
| 223 | } |
| 224 | |
| 225 | /** |
| 226 | * Adds property flags. |
| 227 | */ |
rongliu | 5549266 | 2018-03-21 14:34:58 -0700 | [diff] [blame] | 228 | public Builder addFlags(@Vr2dDisplayFlag int flags) { |
Santos Cordon | 627a68f | 2017-06-12 17:57:17 -0700 | [diff] [blame] | 229 | mAddedFlags |= flags; |
| 230 | mRemovedFlags &= ~flags; |
| 231 | return this; |
| 232 | } |
| 233 | |
| 234 | /** |
| 235 | * Removes property flags. |
| 236 | */ |
rongliu | 5549266 | 2018-03-21 14:34:58 -0700 | [diff] [blame] | 237 | public Builder removeFlags(@Vr2dDisplayFlag int flags) { |
Santos Cordon | 627a68f | 2017-06-12 17:57:17 -0700 | [diff] [blame] | 238 | mRemovedFlags |= flags; |
| 239 | mAddedFlags &= ~flags; |
| 240 | return this; |
| 241 | } |
| 242 | |
| 243 | /** |
| 244 | * Builds the Vr2dDisplayProperty instance. |
| 245 | */ |
| 246 | public Vr2dDisplayProperties build() { |
| 247 | return new Vr2dDisplayProperties(mWidth, mHeight, mDpi, mAddedFlags, mRemovedFlags); |
| 248 | } |
| 249 | } |
Karthik Ravi Shankar | cdf9ce7 | 2017-04-12 15:31:20 -0700 | [diff] [blame] | 250 | } |