Struct OverlayState 

pub struct OverlayState { /* private fields */ }

The watermark’s uploaded pixels plus its current placement and bounce state, kept across frames so a moving (bouncing) watermark can be advanced and re-placed each tick without re-reading or re-uploading the image.

Implementations

impl OverlayState

pub fn load_watermark(&mut self, path: &str, output_scale: f64)

Load the watermark image from disk; output_scale is the output’s fractional scale, ceiled to the integer buffer scale of the upload. A failed load clears the overlay.

pub fn blend_bgra( &self, frame: &mut [u8], stride: usize, frame_w: i32, frame_h: i32, )

Alpha-blend the watermark into a BGRA frame (row stride in bytes) at its current position. Clips per pixel at the frame bounds because the animated position — or a watermark larger than the capture — can leave part of the image off-frame, and only the in-frame portion may be written.

pub fn damage_rect( &self, frame_w: i32, frame_h: i32, ) -> Option<Rectangle<i32, Physical>>

Frame-clipped union of the watermark’s current and previous rectangles — the region a damage-gated encoder must repaint after a bounce step moved the image (the vacated area needs repainting as much as the new one).

pub fn is_active(&self) -> bool

True once a watermark image has been loaded.

pub fn is_animated(&self) -> bool

True when the watermark moves and must be re-rendered every frame.

pub fn update_position( &mut self, frame_width: i32, frame_height: i32, loc_enum: i32, )

Place the watermark for the current frame size. Fixed anchors (corners / middle) are pure geometry, but the AN anchor makes the watermark bounce, so each call also advances that animation one step and reflects it off the frame edges — which is precisely why an AN watermark has to be re-rendered every frame (see is_animated). loc_enum is the i32 form of WatermarkLocation.

pub fn get_watermark_element<R>( &self, renderer: &mut R, ) -> Option<MemoryRenderBufferRenderElement<R>>

where R: Renderer + ImportMem, R::TextureId: Texture + Clone + Send + 'static,

Render element for the watermark; None when no watermark is loaded.

pub fn get_cursor_element<R>( &self, renderer: &mut R, image: Image, pos: Point<f64, Logical>, scale: f64, ) -> Option<MemoryRenderBufferRenderElement<R>>

where R: Renderer + ImportMem, R::TextureId: Texture + Clone + Send + 'static,

Render element for a software cursor image at logical pos on an output with fractional scale; the position converts to physical here so the composited cursor lands where the damage tracker and clients (which work in physical pixels) expect it.

Trait Implementations

impl Default for OverlayState

fn default() -> Self

Returns the “default value” for a type.