Struct Stream 

pub struct Stream(/* private fields */);

Available on crate feature cgb only.

A stream under way, one block per HBlank.

Until it is done or stopped, the program must not:

• change the video memory bank, which rules out with_vram_bank and edit_attrs;
• unmap the bank the source sits in;
• execute halt, which stops the copier until the CPU wakes. That includes Vblank::wait, so a frame paced with it will barely advance the transfer.

Dropping this leaves the transfer running. Nothing is torn by that; the obligations above simply go unwatched.

Implementations

impl Stream

pub fn is_done(&self) -> bool

Whether the copier has stopped, whether by finishing or by stop.

pub fn remaining(&self) -> u16

Bytes still to move, zero once is_done.

pub fn stop(self)

Stop early, leaving what has arrived in place. Does nothing once the transfer has finished on its own.