Skip to main content

Surface

Struct Surface 

Source
pub struct Surface { /* private fields */ }
Expand description

Host- or CUDA-backed decoded surface.

Implementations§

Source§

impl Surface

Source

pub fn residency(&self) -> SurfaceResidency

Return where the surface’s pixels currently reside.

Source

pub fn pitch_bytes(&self) -> usize

Row pitch in bytes.

Source

pub fn as_host_bytes(&self) -> Option<&[u8]>

Borrow host bytes when the surface is host-backed.

Source

pub fn download_into(&self, out: &mut [u8], stride: usize) -> Result<(), Error>

Download or copy the surface into caller-owned strided output.

Source

pub fn download_into_profiled( &self, out: &mut [u8], stride: usize, ) -> Result<u128, Error>

Download the surface and return elapsed host copy time in microseconds.

Source

pub fn cuda_surface(&self) -> Option<CudaSurface<'_>>

Borrow CUDA metadata when the surface is CUDA-backed.

Source

pub fn download_batch_tight(surfaces: &[Self]) -> Result<Vec<u8>, Error>

Download a sequence of surfaces into a tightly concatenated output buffer.

CUDA surfaces produced from one contiguous batch allocation are copied with one device-to-host transfer. Other layouts fall back to downloading each surface tightly in order.

Source

pub fn download_batch_tight_into( surfaces: &[Self], out: &mut [u8], ) -> Result<(), Error>

Download a sequence of surfaces into a tightly concatenated output buffer.

CUDA surfaces produced from one contiguous batch allocation are copied with one device-to-host transfer. Other layouts fall back to downloading each surface tightly in order.

Trait Implementations§

Source§

impl Debug for Surface

Source§

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

Formats the value using the given formatter. Read more
Source§

impl DeviceSurface for Surface

Source§

fn backend_kind(&self) -> BackendKind

Backend that owns or produced the surface.
Source§

fn residency(&self) -> SurfaceResidency

Memory residency of the surface.
Source§

fn dimensions(&self) -> (u32, u32)

Surface dimensions in pixels.
Source§

fn pixel_format(&self) -> PixelFormat

Pixel format stored by the surface.
Source§

fn byte_len(&self) -> usize

Number of bytes represented by the surface.
Source§

fn execution_stats(&self) -> ExecutionStats

Execution statistics attached to the surface.
Source§

fn memory_range(&self) -> Option<DeviceMemoryRange>

Backend-visible memory range, when the backend can expose one safely.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.