Struct RetainedFramebuffer 

pub struct RetainedFramebuffer { /* private fields */ }

Pixel memory that outlives the frames drawn into it.

A platform without a native surface to lock (a script-driven canvas, a test harness) keeps one of these per render target: each frame locks it, the renderer draws, and unlocking hands the pixels to blit.

Implementations

impl RetainedFramebuffer

pub fn new( size: PixelSize, format: PixelFormat, alpha_format: AlphaFormat, ) -> Rc<Self>

Creates a framebuffer whose rows are exactly as long as their pixels.

Panics

Panics when a pixel of format does not occupy whole bytes or when size is empty.

pub fn with_row_bytes( size: PixelSize, format: PixelFormat, alpha_format: AlphaFormat, row_bytes: i32, ) -> Rc<Self>

Creates a framebuffer with the given row length.

Panics

Panics when size is empty or row_bytes is too small for a row of pixels.

pub fn size(&self) -> PixelSize

The size in device pixels.

pub fn row_bytes(&self) -> i32

The number of bytes per row.

pub fn format(&self) -> PixelFormat

The pixel format.

pub fn alpha_format(&self) -> AlphaFormat

The alpha format.

pub fn address(&self) -> *mut u8

The address of the first pixel.

Panics

Panics when the framebuffer has been disposed.

pub fn lock( self: &Rc<Self>, dpi: Vector, blit: impl Fn(&Rc<RetainedFramebuffer>) + 'static, ) -> Rc<dyn ILockedFramebuffer>

Locks the framebuffer for one frame. blit runs whenever the returned framebuffer is disposed and receives this framebuffer.

Panics

Panics when the framebuffer has been disposed.

pub fn dispose(&self)

Releases the pixel memory. Further calls do nothing.