Skip to main content

TileBuf

Struct TileBuf 

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

An owned, densely packed buffer of pixels for one region.

This is what the M1 evaluator materializes per node. It is deliberately simple: M2 replaces most uses with scheduler-owned tile memory, but the buffer’s view API (TileBuf::as_tile, TileBuf::as_tile_mut) is the same one kernels already program against, so kernels do not change.

Implementations§

Source§

impl TileBuf

Source

pub fn zeroed(region: Region, pixel: PixelFormat) -> Result<Self>

Allocate a zeroed, densely packed buffer covering region.

§Errors

Returns PixelsError::InvalidArgument if the region’s byte length overflows usize on this platform.

Source

pub fn for_image(desc: &ImageDescriptor) -> Result<Self>

Allocate a zeroed buffer covering the whole of desc.

§Errors

As TileBuf::zeroed.

Source

pub fn from_vec( region: Region, pixel: PixelFormat, data: Vec<u8>, ) -> Result<Self>

Take ownership of data as the pixels of region, densely packed.

§Errors

Returns PixelsError::InvalidArgument if data is not exactly the packed byte length of region.

Source

pub const fn region(&self) -> Region

The region this buffer covers.

Source

pub const fn pixel(&self) -> PixelFormat

The pixel format of the samples in this buffer.

Source

pub fn bytes(&self) -> &[u8] ⓘ

The packed bytes of this buffer.

Source

pub fn into_bytes(self) -> Vec<u8> ⓘ

Consume the buffer, returning its packed bytes.

Source

pub fn as_tile(&self) -> Result<Tile<'_>>

Borrow the buffer as an immutable tile.

§Errors

Only if the buffer’s own invariants were violated, which construction prevents.

Source

pub fn as_tile_mut(&mut self) -> Result<TileMut<'_>>

Borrow the buffer as a mutable tile.

§Errors

As TileBuf::as_tile.

Trait Implementations§

Source§

impl Clone for TileBuf

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 TileBuf

Source§

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

Formats the value using the given formatter. Read more

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