Struct DisplayStatusValue

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

Relates to the status of the display.

When writing this value to DISPSTAT, the vblank, hblank, and vcounter settings aren’t actually written. They can still be modified on this type if you want to set up a specific value and then check for equality or something.

Setting the interrupt related flags is dangerous if your interrupt handler isn’t set up to handle the appropriate types of interrupts. Even if you set for interrupt types to occur here they won’t fire unless you also enable them in the IME register, and of course you must have interrupts enabled overall using the IE register.

• vblank: Set during VCOUNT lines 160 to 226, but not 227.
• hblank: Set when you’re in hblank, after the current line has completed drawing. It takes 960 cycles to draw a line, but GBATEK says that this is off for 1006 cycles per line.
• vcounter: Set if the current VCOUNT value matches the vcount_trigger value.
• vblank_irq: If an interrupt should be triggered at start of vblank.
• hblank_irq: If an interrupt should be triggered at start of hblank.
• vcounter_irq: If an interrupt should be triggered when VCOUNT matches the vcount_trigger value.
• vcount_trigger: The scanline that you want to use for vcount interrupts and the vcounter flag.

Implementations

impl DisplayStatusValue

pub const fn new() -> Self

pub const fn vblank(self) -> bool

pub const fn with_vblank(self, b: bool) -> Self

pub fn set_vblank(&mut self, b: bool)

pub const fn hblank(self) -> bool

pub const fn with_hblank(self, b: bool) -> Self

pub fn set_hblank(&mut self, b: bool)

pub const fn vcounter(self) -> bool

pub const fn with_vcounter(self, b: bool) -> Self

pub fn set_vcounter(&mut self, b: bool)

pub const fn vblank_irq(self) -> bool

pub const fn with_vblank_irq(self, b: bool) -> Self

pub fn set_vblank_irq(&mut self, b: bool)

pub const fn hblank_irq(self) -> bool

pub const fn with_hblank_irq(self, b: bool) -> Self

pub fn set_hblank_irq(&mut self, b: bool)

pub const fn vcounter_irq(self) -> bool

pub const fn with_vcounter_irq(self, b: bool) -> Self

pub fn set_vcounter_irq(&mut self, b: bool)

pub const fn vcount_trigger(self) -> u16

pub const fn with_vcount_trigger(self, u: u16) -> Self

pub fn set_vcount_trigger(&mut self, u: u16)

Trait Implementations

impl Clone for DisplayStatusValue

fn clone(&self) -> DisplayStatusValue

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DisplayStatusValue

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DisplayStatusValue

fn default() -> DisplayStatusValue

Returns the “default value” for a type.

impl PartialEq for DisplayStatusValue

fn eq(&self, other: &DisplayStatusValue) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for DisplayStatusValue

impl Eq for DisplayStatusValue

impl StructuralPartialEq for DisplayStatusValue