Skip to main content

Stat

Struct Stat 

Source
pub struct Stat(/* private fields */);
Expand description

LCD status (STAT).

BitFieldAccessMeaning
7Unused.
6lyc_intR/WRaise the STAT interrupt on LYC=LY.
5mode2_intR/WRaise the STAT interrupt on mode 2 (OAM scan).
4mode1_intR/WRaise the STAT interrupt on mode 1 (VBlank).
3mode0_intR/WRaise the STAT interrupt on mode 0 (HBlank).
2lyc_eq_lyROSet while LY equals LYC.
1-0modeROCurrent PPU mode.

Implementations§

Source§

impl Stat

Source

pub const fn new() -> Self

Creates a new default initialized bitfield.

Source

pub const fn from_bits(bits: u8) -> Self

Convert from bits.

Source

pub const fn into_bits(self) -> u8

Convert into bits.

Source

pub const fn mode(&self) -> PpuMode

Current PPU mode (read-only).

Bits: 0..2

Source

pub const fn lyc_eq_ly(&self) -> bool

Set while LY equals LYC (read-only).

Bits: 2..3

Source

pub const fn mode0_int(&self) -> bool

Raise the STAT interrupt on mode 0 (HBlank).

Bits: 3..4

Source

pub const fn with_mode0_int_checked(self, value: bool) -> Result<Self, ()>

Raise the STAT interrupt on mode 0 (HBlank).

Bits: 3..4

Source

pub const fn with_mode0_int(self, value: bool) -> Self

Raise the STAT interrupt on mode 0 (HBlank).

Bits: 3..4

Source

pub const fn set_mode0_int(&mut self, value: bool)

Raise the STAT interrupt on mode 0 (HBlank).

Bits: 3..4

Source

pub const fn set_mode0_int_checked(&mut self, value: bool) -> Result<(), ()>

Raise the STAT interrupt on mode 0 (HBlank).

Bits: 3..4

Source

pub const fn mode1_int(&self) -> bool

Raise the STAT interrupt on mode 1 (VBlank).

Bits: 4..5

Source

pub const fn with_mode1_int_checked(self, value: bool) -> Result<Self, ()>

Raise the STAT interrupt on mode 1 (VBlank).

Bits: 4..5

Source

pub const fn with_mode1_int(self, value: bool) -> Self

Raise the STAT interrupt on mode 1 (VBlank).

Bits: 4..5

Source

pub const fn set_mode1_int(&mut self, value: bool)

Raise the STAT interrupt on mode 1 (VBlank).

Bits: 4..5

Source

pub const fn set_mode1_int_checked(&mut self, value: bool) -> Result<(), ()>

Raise the STAT interrupt on mode 1 (VBlank).

Bits: 4..5

Source

pub const fn mode2_int(&self) -> bool

Raise the STAT interrupt on mode 2 (OAM scan).

Bits: 5..6

Source

pub const fn with_mode2_int_checked(self, value: bool) -> Result<Self, ()>

Raise the STAT interrupt on mode 2 (OAM scan).

Bits: 5..6

Source

pub const fn with_mode2_int(self, value: bool) -> Self

Raise the STAT interrupt on mode 2 (OAM scan).

Bits: 5..6

Source

pub const fn set_mode2_int(&mut self, value: bool)

Raise the STAT interrupt on mode 2 (OAM scan).

Bits: 5..6

Source

pub const fn set_mode2_int_checked(&mut self, value: bool) -> Result<(), ()>

Raise the STAT interrupt on mode 2 (OAM scan).

Bits: 5..6

Source

pub const fn lyc_int(&self) -> bool

Raise the STAT interrupt on the LYC=LY condition.

Bits: 6..7

Source

pub const fn with_lyc_int_checked(self, value: bool) -> Result<Self, ()>

Raise the STAT interrupt on the LYC=LY condition.

Bits: 6..7

Source

pub const fn with_lyc_int(self, value: bool) -> Self

Raise the STAT interrupt on the LYC=LY condition.

Bits: 6..7

Source

pub const fn set_lyc_int(&mut self, value: bool)

Raise the STAT interrupt on the LYC=LY condition.

Bits: 6..7

Source

pub const fn set_lyc_int_checked(&mut self, value: bool) -> Result<(), ()>

Raise the STAT interrupt on the LYC=LY condition.

Bits: 6..7

Trait Implementations§

Source§

impl Clone for Stat

Source§

fn clone(&self) -> Stat

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Stat

Source§

impl Debug for Stat

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Stat

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for Stat

Source§

impl From<Stat> for u8

Source§

fn from(v: Stat) -> Self

Converts to this type from the input type.
Source§

impl From<u8> for Stat

Source§

fn from(v: u8) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Stat

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Stat

Auto Trait Implementations§

§

impl BankSafe for Stat

§

impl Freeze for Stat

§

impl RefUnwindSafe for Stat

§

impl Send for Stat

§

impl Sync for Stat

§

impl Unpin for Stat

§

impl UnsafeUnpin for Stat

§

impl UnwindSafe for Stat

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CellValue for T
where T: Copy + BankSafe,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.