Struct ndk::surface_texture::SurfaceTexture

pub struct SurfaceTexture { /* private fields */ }

Available on crate feature api-level-28 only.

An opaque type to manage android.graphics.SurfaceTexture from native code

Implementations

impl SurfaceTexture

pub unsafe fn from_ptr(ptr: NonNull<ASurfaceTexture>) -> Self

Assumes ownership of ptr

Safety

ptr must be a valid pointer to an Android ffi::ASurfaceTexture.

pub unsafe fn from_surface_texture(
    env: *mut JNIEnv,
    surface_texture: jobject
) -> Option<Self>

Get a reference to the native SurfaceTexture from the corresponding Java object.

Safety

This function should be called with a healthy JVM pointer and with a non-null android.graphics.SurfaceTexture, which must be kept alive on the Java/Kotlin side.

The caller must keep a reference to the Java android.graphics.SurfaceTexture during the lifetime of the returned SurfaceTexture. Failing to do so could result in the SurfaceTexture to stop functioning properly once the Java object gets finalized. However, this will not result in program termination.

pub fn ptr(&self) -> NonNull<ASurfaceTexture>

Returns a pointer to the native ffi::ASurfaceTexture.

pub fn acquire_native_window(&self) -> Option<NativeWindow>

Returns a reference to a NativeWindow (i.e. the Producer) for this SurfaceTexture.

This is equivalent to Java’s:

Surface sur = new Surface(surfaceTexture);

pub fn attach_to_gl_context(&self, tex_name: u32) -> Result<()>

Attach the SurfaceTexture to the OpenGL ES context that is current on the calling thread.

A new OpenGL ES texture object is created and populated with the SurfaceTexture image frame that was current at the time of the last call to detach_from_gl_context(). This new texture is bound to the GL_TEXTURE_EXTERNAL_OES texture target.

This can be used to access the SurfaceTexture image contents from multiple OpenGL ES contexts. Note, however, that the image contents are only accessible from one OpenGL ES context at a time.

pub fn detach_from_gl_context(&self) -> Result<()>

Detach the SurfaceTexture from the OpenGL ES context that owns the OpenGL ES texture object.

This call must be made with the OpenGL ES context current on the calling thread. The OpenGL ES texture object will be deleted as a result of this call. After calling this method all calls to update_tex_image() will fail until a successful call to attach_to_gl_context() is made.

This can be used to access the SurfaceTexture image contents from multiple OpenGL ES contexts. Note, however, that the image contents are only accessible from one OpenGL ES context at a time.

pub fn transform_matrix(&self) -> [f32; 16]

Retrieve the 4x4 texture coordinate transform matrix associated with the texture image set by the most recent call to update_tex_image().

This transform matrix maps 2D homogeneous texture coordinates of the form (s, t, 0, 1) with s and t in the inclusive range [0, 1] to the texture coordinate that should be used to sample that location from the texture. Sampling the texture outside of the range of this transform is undefined.

The matrix is stored in column-major order so that it may be passed directly to OpenGL ES via the glLoadMatrixf() or glUniformMatrix4fv() functions.

pub fn timestamp(&self) -> Duration

Retrieve the timestamp associated with the texture image set by the most recent call to update_tex_image().

This timestamp is in nanoseconds, and is normally monotonically increasing. The timestamp should be unaffected by time-of-day adjustments, and for a camera should be strictly monotonic but for a MediaPlayer may be reset when the position is set. The specific meaning and zero point of the timestamp depends on the source providing images to the SurfaceTexture. Unless otherwise specified by the image source, timestamps cannot generally be compared across SurfaceTexture instances, or across multiple program 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.

pub fn update_tex_image(&self) -> Result<()>

Update the texture image to the most recent frame from the image stream.

This may only be called while the OpenGL ES context that owns the texture is current on the calling thread. It will implicitly bind its texture to the GL_TEXTURE_EXTERNAL_OES texture target.

Trait Implementations

impl Debug for SurfaceTexture

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for SurfaceTexture

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for SurfaceTexture

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for SurfaceTexture

fn cmp(&self, other: &SurfaceTexture) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<SurfaceTexture> for SurfaceTexture

fn eq(&self, other: &SurfaceTexture) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SurfaceTexture) -> bool

This method tests for !=.

impl PartialOrd<SurfaceTexture> for SurfaceTexture

fn partial_cmp(&self, other: &SurfaceTexture) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for SurfaceTexture

impl Send for SurfaceTexture

impl StructuralEq for SurfaceTexture

impl StructuralPartialEq for SurfaceTexture