Skip to main content

Array

Struct Array 

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

A 2-D CUDA array. Element format is chosen at creation; channels are typically 1, 2, or 4.

Implementations§

Source§

impl Array

Source

pub fn new( context: &Context, width: usize, height: usize, format: ArrayFormat, num_channels: u32, ) -> Result<Self>

Allocate a width × height 2-D array with num_channels elements of format per texel. Set height = 0 for a 1-D array.

Source

pub fn as_raw(&self) -> CUarray

Raw CUarray. Use with care.

Source

pub fn width(&self) -> usize

Source

pub fn height(&self) -> usize

Source

pub fn num_channels(&self) -> u32

Source

pub fn bytes_per_element(&self) -> usize

Element width in bytes (channel size × channel count).

Source

pub fn copy_from_host<T: DeviceRepr>(&self, host: &[T]) -> Result<()>

Synchronous host→array 2-D copy. host must contain exactly width × height elements of type T; T size must match self.bytes_per_element().

Source

pub fn descriptor(&self) -> Result<CUDA_ARRAY_DESCRIPTOR>

Query this array’s descriptor back from CUDA. Useful for arrays you received from an external source and don’t have shape info for.

Source

pub fn memory_requirements( &self, device: &Device, ) -> Result<CUDA_ARRAY_MEMORY_REQUIREMENTS>

Query the array’s memory-allocation size + alignment requirements on device. Useful when backing an array with a VMM allocation.

Source

pub fn sparse_properties(&self) -> Result<CUDA_ARRAY_SPARSE_PROPERTIES>

Query the array’s sparse-tile properties. Meaningful on sparse / tiled arrays created with the SPARSE flag.

Source

pub fn plane_raw(&self, plane_idx: u32) -> Result<CUarray>

Return the raw CUarray handle of plane plane_idx of a multi-planar array (YUV / NV12). The plane is owned by self — the raw handle must NOT be passed to cuArrayDestroy. Use together with Array::descriptor_of_raw if you need shape info.

Source

pub unsafe fn descriptor_of_raw( handle: CUarray, ) -> Result<CUDA_ARRAY_DESCRIPTOR>

Helper: query the CUDA_ARRAY_DESCRIPTOR of a raw array handle (e.g. a plane returned by Array::plane_raw).

§Safety

handle must be a live CUarray.

Source

pub fn copy_to_host<T: DeviceRepr>(&self, host: &mut [T]) -> Result<()>

Synchronous array→host 2-D copy.

Trait Implementations§

Source§

impl Clone for Array

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 Array

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Array

§

impl RefUnwindSafe for Array

§

impl Send for Array

§

impl Sync for Array

§

impl Unpin for Array

§

impl UnsafeUnpin for Array

§

impl UnwindSafe for Array

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> 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> 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 = 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.