Skip to main content

OverlayNode

ff_render::nodes::overlay

Struct OverlayNode 

Source 
pub struct OverlayNode {
    pub overlay_rgba: Vec<u8>,
    pub overlay_width: u32,
    pub overlay_height: u32,
}
Expand description

Porter-Duff “src over dst” alpha compositing.

The input frame (inputs[0] / process_cpu argument) is the base layer. overlay_rgba is composited on top using its alpha channel.

The CPU path performs the same src_over formula as the shader:

out_rgb = overlay.rgb * overlay.a + base.rgb * (1 − overlay.a)
out_a   = overlay.a + base.a * (1 − overlay.a)

Fields§

§overlay_rgba: Vec<u8>

The overlay frame (top layer) as RGBA bytes.

§overlay_width: u32

Width of overlay_rgba.

§overlay_height: u32

Height of overlay_rgba.

Implementations§

Source§

impl OverlayNode

Source

pub fn new( overlay_rgba: Vec<u8>, overlay_width: u32, overlay_height: u32, ) -> Self

Trait Implementations§

Source§

impl RenderNodeCpu for OverlayNode

Source§

fn process_cpu(&self, rgba: &mut [u8], _w: u32, _h: u32)

Process rgba in-place. 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> 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, 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.