Struct ImageDesc 

pub struct ImageDesc { /* private fields */ }

Declarative image-allocation request — the full-featured front door for image tensors (TensorDyn::image_desc and the image crate’s ImageProcessor::create_image_desc).

The classic constructors (image, create_image) cover the common cases; the desc carries the optional requests — today the Compression request — without another constructor-parameter sweep. Fields are private and the builders consume/return by value, so future options are non-breaking.

use edgefirst_tensor::{Compression, CpuAccess, DType, ImageDesc, PixelFormat};
let desc = ImageDesc::new(640, 640, PixelFormat::Rgba, DType::U8)
    .with_access(CpuAccess::None)
    .with_compression(Compression::Any);

Implementations

impl ImageDesc

pub fn new( width: usize, height: usize, format: PixelFormat, dtype: DType, ) -> Self

A new image request: auto-selected memory, CpuAccess::ReadWrite, no compression request.

pub fn with_memory(self, memory: Option<TensorMemory>) -> Self

Request a specific memory backing (None = auto-select).

pub fn with_access(self, access: CpuAccess) -> Self

Declare the CPU access (see CpuAccess). Any declaration other than None makes a compression request invalid, so a compression request must also call with_access(CpuAccess::None).

pub fn with_compression(self, compression: Compression) -> Self

Request a tile-compressed layout (see Compression).

pub fn with_contiguous(self, contiguous: bool) -> Self

Require physically contiguous memory (see Contiguity).

The image is allocated from the Linux CMA DMA heap only. Allocation fails, naming the heap, when there is no CMA heap or it cannot fit the image, instead of falling back to the system heap or to another kind of memory. Memory must be auto-selected or TensorMemory::DmaBuf. Other platforms return Error::NotImplemented.

pub fn width(&self) -> usize

Requested width in pixels.

pub fn height(&self) -> usize

Requested height in pixels.

pub fn format(&self) -> PixelFormat

Requested pixel format.

pub fn dtype(&self) -> DType

Requested element type.

pub fn memory(&self) -> Option<TensorMemory>

Requested memory backing (None = auto-select).

pub fn access(&self) -> CpuAccess

Declared CPU access.

pub fn compression(&self) -> Option<Compression>

The compression request, if any.

pub fn contiguous(&self) -> bool

Whether physically contiguous memory is required.

Trait Implementations

impl Clone for ImageDesc

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImageDesc

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

Formats the value using the given formatter.