From 557ab7c475f9778cb1704b0bcd9f72b5f3ec8bea Mon Sep 17 00:00:00 2001 From: John Reck Date: Fri, 6 Jan 2023 16:21:32 -0500 Subject: [PATCH] Add some docs Fixes: 262735300 Test: n/a doc only change Change-Id: I2f387fe9a770c1c9cf06778783b93d0938b0951d --- core/java/android/hardware/HardwareBuffer.java | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/core/java/android/hardware/HardwareBuffer.java b/core/java/android/hardware/HardwareBuffer.java index 11892fea20f27..ddbfb9e0bd58e 100644 --- a/core/java/android/hardware/HardwareBuffer.java +++ b/core/java/android/hardware/HardwareBuffer.java @@ -320,6 +320,15 @@ public final class HardwareBuffer implements Parcelable, AutoCloseable { /** * Returns the system-wide unique id for this buffer * + * This can be useful as a cache key for associating additional objects with + * a given HardwareBuffer, such as associating an imported EGLImage with + * the target HardwareBuffer when processing a stream of buffers from + * ImageReader. + * + * This can also be useful for doing cross-process buffer caching. As sending + * a HardwareBuffer over Binder is slower than sending a long, this can be + * used as reliable cache key after an initial handshake that passes the + * HardwareBuffers themselves to later be referred to using only the id. */ public long getId() { checkClosed("id");