Skip to main content

CudaSurface

Struct CudaSurface 

Source
pub struct CudaSurface { /* private fields */ }
Available on crate feature wgpu only.
Expand description

Opaque CUDA CUsurfObject bound to a CUarray, used as a surf2Dwrite kernel write target.

Unlike CudaPtr2D (flat device memory) this wraps a surface object — the driver handle a kernel writes through into a tiled CUDA array. The array itself is typically a foreign-API texture (D3D12 / Vulkan / GL) imported as a CUmipmappedArray → CUarray, so a CUDA consumer writes post-YUV→RGB pixels straight into a wgpu-readable driver-tiled texture with no intermediate copy.

format carries the array’s element format (the wgpu render-target format the producer allocated — Rgba8Unorm or Rgba16Float). It is informational for the binding ABI (the kernel learns its output format from the params blob, not this handle); it lets the bridge and any diagnostics reason about the surface without a driver query. Because the field is a wgpu::TextureFormat, the whole newtype is gated on the crate’s wgpu feature — matching the precedent set by crate::PlaneFormat::to_wgpu_texture_format: backend-agnostic code carries crate-native types, wgpu types appear only behind the gate.

keep_alive retains the underlying import chain (cuSurfObjectCreate → CUarray → CUmipmappedArray → cuImportExternalMemory) for at least the lifetime of any kernel launch that receives this handle.

Implementations§

Source§

impl CudaSurface

Source

pub unsafe fn try_from_raw( surf: u64, width: u32, height: u32, format: TextureFormat, uuid: Option<[u8; 16]>, keep_alive: Option<KeepAlive>, ) -> Result<Self, InvalidHandleError>

Wrap a raw CUsurfObject. Borrowing: the handle is stored non-owningly, this type has no Drop, and every obligation below extends to each Clone.

§Safety
  • surf must be a live CUsurfObject created by cuSurfObjectCreate and not yet destroyed, on the CUDA device identified by uuid when that is Some.
  • The bound CUarray must actually have element format format and dimensions width × height. Kernels reached through this handle issue surf2Dwrites sized by format and clipped by width / height; a mismatch writes the wrong number of bytes per texel or past the array’s last row. Zero extents are rejected as InvalidHandleError::InvalidValue and a zero surf as InvalidHandleError::NullHandle, so neither is a caller obligation.
  • Lifetime — the whole import chain, not just the surface. keep_alive (or the caller, when it is None) must retain every link of cuSurfObjectCreate → CUarray → CUmipmappedArray → cuImportExternalMemory, and the foreign texture underneath it, for at least as long as any kernel launch that receives this handle can still be running. A surface object outliving its array, or an array outliving the external-memory import, is a use-after-free inside the kernel. Nothing is retained here and there is no Drop.
  • The caller must not cuSurfObjectDestroy while this value or any Clone of it is reachable.
Source

pub fn surf(&self) -> u64

Source

pub fn width(&self) -> u32

Source

pub fn height(&self) -> u32

Source

pub fn format(&self) -> TextureFormat

Source

pub fn uuid(&self) -> Option<[u8; 16]>

Source

pub fn keep_alive(&self) -> Option<&KeepAlive>

Trait Implementations§

Source§

impl Clone for CudaSurface

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for CudaSurface

Source§

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

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

impl Send for CudaSurface

Source§

impl Sync for CudaSurface

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> MaybeSend for T
where T: Send + ?Sized,

Source§

impl<T> MaybeSendSync for T
where T: Send + Sync + ?Sized,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,