Skip to main content

IncrementalRenderer

Struct IncrementalRenderer 

Source
pub struct IncrementalRenderer {
    pub config: RenderConfig,
    pub frame_rate: Rational,
    /* private fields */
}
Expand description

Tracks dirty frame ranges and drives incremental re-renders.

Overlapping or adjacent dirty regions are automatically coalesced on every mark_dirty call to keep the list compact.

Fields§

§config: RenderConfig

Render configuration used when rendering is triggered.

§frame_rate: Rational

Frame rate of the associated timeline.

Implementations§

Source§

impl IncrementalRenderer

Source

pub fn new(config: RenderConfig, frame_rate: Rational) -> Self

Create a new incremental renderer.

Source

pub fn mark_dirty(&mut self, start_frame: u64, end_frame: u64)

Mark the range [start_frame, end_frame) as dirty.

The new region is inserted and then the list is coalesced so that it always consists of non-overlapping, sorted regions.

Source

pub fn mark_all_dirty(&mut self, total_frames: u64)

Mark every frame in [0, total_frames) as dirty.

Source

pub fn is_dirty(&self, frame: u64) -> bool

Returns true if frame falls inside any dirty region.

Source

pub fn get_dirty_regions(&self) -> &[DirtyRegion]

Returns a slice of the current dirty regions (sorted, non-overlapping).

Source

pub fn dirty_frame_count(&self) -> u64

Total number of dirty frames across all regions.

Source

pub fn clear_dirty(&mut self)

Clear all dirty regions.

Source

pub fn render_incremental( &mut self, _timeline: &Arc<Timeline>, ) -> EditResult<usize>

Returns the number of dirty frames that need rendering, then clears the dirty list (signalling that rendering has been requested).

The caller is expected to iterate get_dirty_regions before calling this method in order to render the correct frames.

The _timeline parameter is accepted for API consistency and future use.

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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

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

Source§

impl<T> WasmNotSendSync for T

Source§

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