Add documentation for HardwareBuffer::as_ptr()

Co-authored-by: Marijn Suijten <[email protected]>
rust-mobile · Jan 5, 2022 · 4d8ef35 · 4d8ef35
1 parent a4bad4b
commit 4d8ef35
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/ndk/src/hardware_buffer.rs b/ndk/src/hardware_buffer.rs
@@ -131,6 +131,11 @@ impl HardwareBuffer {
         Self { inner: ptr }
     }
 
+    /// Returns the underlying [`ffi::AHardwareBuffer`] pointer
+    ///
+    /// The pointer can be used to import this hardware buffer into a Vulkan memory object using [`VK_ANDROID_external_memory_android_hardware_buffer`].
+    ///
+    /// [`VK_ANDROID_external_memory_android_hardware_buffer`]: https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/VK_ANDROID_external_memory_android_hardware_buffer.html
     pub fn as_ptr(&self) -> *mut ffi::AHardwareBuffer {
         self.inner.as_ptr()
     }