Skip to content

Commit

Permalink
More doc links
Browse files Browse the repository at this point in the history
  • Loading branch information
MarijnS95 committed Jun 9, 2022
1 parent fc0c399 commit 2acd6d3
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions ndk/src/surface_texture.rs
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
//! Bindings for [`ffi::ASurfaceTexture`]
//! Bindings for Android's [`ASurfaceTexture`]
//!
//! See <https://source.android.com/devices/graphics/arch-st> for an architectural overview of
//! [`SurfaceTexture`] internals.
//!
//! [`ASurfaceTexture`]: https://developer.android.com/ndk/reference/group/surface-texture
#![cfg(feature = "api-level-28")]

use super::posix::PosixError;
use crate::native_window::NativeWindow;
use jni_sys::{jobject, JNIEnv};
use std::{convert::TryInto, ptr::NonNull, time::Duration};

/// <https://developer.android.com/ndk/reference/group/surface-texture>
/// An opaque type to manage [`android.graphics.SurfaceTexture`] from native code
///
/// [`android.graphics.SurfaceTexture`]: https://developer.android.com/reference/android/graphics/SurfaceTexture
#[derive(Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct SurfaceTexture {
ptr: NonNull<ffi::ASurfaceTexture>,
Expand All @@ -32,7 +36,7 @@ impl SurfaceTexture {
Self { ptr }
}

/// Get a reference to the native [`SurfaceTexture`] from the corresponding java object.
/// Get a reference to the native [`SurfaceTexture`] from the corresponding Java object.
///
/// # Safety
///
Expand Down Expand Up @@ -139,7 +143,7 @@ impl SurfaceTexture {
/// invocations. It is mostly useful for determining time offsets between subsequent frames.
///
/// For EGL/Vulkan producers, this timestamp is the desired present time set with the
/// `EGL_ANDROID_presentation_time` or `VK_GOOGLE_display_timing` extensions.
/// [`EGL_ANDROID_presentation_time`] or [`VK_GOOGLE_display_timing`] extensions.
///
/// [`MediaPlayer`]: https://developer.android.com/reference/android/media/MediaPlayer
/// [`EGL_ANDROID_presentation_time`]: https://www.khronos.org/registry/EGL/extensions/ANDROID/EGL_ANDROID_presentation_time.txt
Expand Down

0 comments on commit 2acd6d3

Please sign in to comment.