Skip to main content

PixelProvenanceFrame

Struct PixelProvenanceFrame 

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

One frame of PixelProvenance, indexed by y * SCREEN_W + x.

Overwritten in place every frame, exactly like the framebuffer it shadows, so a query after run_frame describes the frame the user is looking at.

Implementations§

Source§

impl PixelProvenanceFrame

Source

pub const HEAP_BYTES: usize

Heap cost of one armed frame, in bytes.

Source

pub fn new() -> Self

Allocate a cleared frame.

Source

pub fn get(&self, x: usize, y: usize) -> Option<PixelProvenance>

The record for screen pixel (x, y), or None if either coordinate is off-screen. Returning None rather than clamping matters: a clamped query would answer confidently about a pixel the caller did not ask for.

Source

pub fn set(&mut self, x: usize, y: usize, rec: PixelProvenance)

Record a pixel. Out-of-range coordinates are dropped rather than wrapping into an unrelated pixel.

Source

pub fn pixels(&self) -> &[PixelProvenance]

The whole frame, row-major.

Source

pub fn clear(&mut self)

Forget every recorded pixel, keeping the allocation.

Called on power-cycle and on save-state restore for the same reason WriteAttribution::clear is: the records describe a timeline the restore replaced. The framebuffer analogy does NOT excuse keeping them — the framebuffer is serialized and comes back consistent with the restored state, whereas this frame is not, so a restore landing mid-frame would leave pre-restore addresses for every pixel above the current scanline with nothing marking them stale.

Trait Implementations§

Source§

impl Clone for PixelProvenanceFrame

Source§

fn clone(&self) -> PixelProvenanceFrame

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PixelProvenanceFrame

Source§

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

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

impl Default for PixelProvenanceFrame

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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.