Struct spectrusty_core::chip::UlaPlusRegFlags
source · pub struct UlaPlusRegFlags { /* private fields */ }
Expand description
ULAplus register port flags.
Implementations§
source§impl UlaPlusRegFlags
impl UlaPlusRegFlags
pub const SCREEN_MODE_MASK: Self = _
pub const SCREEN_HI_ATTRS: Self = _
pub const SCREEN_HI_RES: Self = _
pub const HIRES_COLOR_MASK: Self = _
pub const PALETTE_MASK: Self = _
pub const GROUP_MASK: Self = _
pub const MODE_GROUP: Self = _
pub const PALETTE_GROUP: Self = _
sourcepub const fn bits(&self) -> u8
pub const fn bits(&self) -> u8
Returns the raw value of the flags currently stored.
Examples found in repository?
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
pub fn palette_group(self) -> Option<u8> {
if (self & UlaPlusRegFlags::GROUP_MASK) == UlaPlusRegFlags::PALETTE_GROUP {
return Some((self & UlaPlusRegFlags::PALETTE_MASK).bits())
}
None
}
/// Returns an `true` if `self` selects a mode group.
pub fn is_mode_group(self) -> bool {
(self & UlaPlusRegFlags::GROUP_MASK) == UlaPlusRegFlags::MODE_GROUP
}
/// Returns a color index from high resolution color mask: [0, 7].
#[inline]
pub fn hires_color_index(self) -> u8 {
(self & UlaPlusRegFlags::HIRES_COLOR_MASK).bits() >> 3
}
/// Returns `true` if a screen high resolution bit is 1. Otherwise returns `false`.
#[inline]
pub fn is_screen_hi_res(self) -> bool {
self.intersects(UlaPlusRegFlags::SCREEN_HI_RES)
}
}
impl From<UlaPlusRegFlags> for u8 {
#[inline]
fn from(flags: UlaPlusRegFlags) -> u8 {
flags.bits()
}
sourcepub const fn from_bits(bits: u8) -> Option<Self>
pub const fn from_bits(bits: u8) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u8) -> Self
pub const fn from_bits_truncate(bits: u8) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
Examples found in repository?
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
pub fn into_plus_mode(self) -> UlaPlusRegFlags {
UlaPlusRegFlags::from_bits_truncate(
(self & (ScldCtrlFlags::SCREEN_MODE_MASK
|ScldCtrlFlags::HIRES_COLOR_MASK)
).bits()
)|UlaPlusRegFlags::MODE_GROUP
}
/// Returns a color index from high resolution color mask: [0, 7].
#[inline]
pub fn hires_color_index(self) -> u8 {
(self & ScldCtrlFlags::HIRES_COLOR_MASK).bits() >> 3
}
/// Returns `true` if a map ex rom bit is 1. Otherwise returns `false`.
#[inline]
pub fn is_map_ex_rom(self) -> bool {
self.intersects(ScldCtrlFlags::MAP_EX_ROM)
}
/// Returns `true` if a interrupt disabled bit is 1. Otherwise returns `false`.
#[inline]
pub fn is_intr_disabled(self) -> bool {
self.intersects(ScldCtrlFlags::INTR_DISABLED)
}
/// Returns `true` if a screen high resolution bit is 1. Otherwise returns `false`.
#[inline]
pub fn is_screen_hi_res(self) -> bool {
self.intersects(ScldCtrlFlags::SCREEN_HI_RES)
}
/// Returns `true` if a screen high color bit is 1. Otherwise returns `false`.
#[inline]
pub fn is_screen_hi_attrs(self) -> bool {
self.intersects(ScldCtrlFlags::SCREEN_HI_ATTRS)
}
/// Returns `true` if a screen secondary bit is 1. Otherwise returns `false`.
#[inline]
pub fn is_screen_secondary(self) -> bool {
self.intersects(ScldCtrlFlags::SCREEN_SECONDARY)
}
}
impl From<ScldCtrlFlags> for u8 {
#[inline]
fn from(flags: ScldCtrlFlags) -> u8 {
flags.bits()
}
}
impl From<u8> for ScldCtrlFlags {
#[inline]
fn from(flags: u8) -> ScldCtrlFlags {
ScldCtrlFlags::from_bits_truncate(flags)
}
}
/****************************** UlaPlusRegFlags ******************************/
impl UlaPlusRegFlags {
/// Returns an `index` [0, 63] to the palette entry if `self` selects a palette group.
pub fn palette_group(self) -> Option<u8> {
if (self & UlaPlusRegFlags::GROUP_MASK) == UlaPlusRegFlags::PALETTE_GROUP {
return Some((self & UlaPlusRegFlags::PALETTE_MASK).bits())
}
None
}
/// Returns an `true` if `self` selects a mode group.
pub fn is_mode_group(self) -> bool {
(self & UlaPlusRegFlags::GROUP_MASK) == UlaPlusRegFlags::MODE_GROUP
}
/// Returns a color index from high resolution color mask: [0, 7].
#[inline]
pub fn hires_color_index(self) -> u8 {
(self & UlaPlusRegFlags::HIRES_COLOR_MASK).bits() >> 3
}
/// Returns `true` if a screen high resolution bit is 1. Otherwise returns `false`.
#[inline]
pub fn is_screen_hi_res(self) -> bool {
self.intersects(UlaPlusRegFlags::SCREEN_HI_RES)
}
}
impl From<UlaPlusRegFlags> for u8 {
#[inline]
fn from(flags: UlaPlusRegFlags) -> u8 {
flags.bits()
}
}
impl From<u8> for UlaPlusRegFlags {
#[inline]
fn from(flags: u8) -> UlaPlusRegFlags {
UlaPlusRegFlags::from_bits_truncate(flags)
}
sourcepub const unsafe fn from_bits_unchecked(bits: u8) -> Self
pub const unsafe fn from_bits_unchecked(bits: u8) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
source§impl UlaPlusRegFlags
impl UlaPlusRegFlags
sourcepub fn palette_group(self) -> Option<u8>
pub fn palette_group(self) -> Option<u8>
Returns an index
[0, 63] to the palette entry if self
selects a palette group.
sourcepub fn is_mode_group(self) -> bool
pub fn is_mode_group(self) -> bool
Returns an true
if self
selects a mode group.
sourcepub fn hires_color_index(self) -> u8
pub fn hires_color_index(self) -> u8
Returns a color index from high resolution color mask: [0, 7].
sourcepub fn is_screen_hi_res(self) -> bool
pub fn is_screen_hi_res(self) -> bool
Returns true
if a screen high resolution bit is 1. Otherwise returns false
.
Trait Implementations§
source§impl Binary for UlaPlusRegFlags
impl Binary for UlaPlusRegFlags
source§impl BitAnd<UlaPlusRegFlags> for UlaPlusRegFlags
impl BitAnd<UlaPlusRegFlags> for UlaPlusRegFlags
source§impl BitAndAssign<UlaPlusRegFlags> for UlaPlusRegFlags
impl BitAndAssign<UlaPlusRegFlags> for UlaPlusRegFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr<UlaPlusRegFlags> for UlaPlusRegFlags
impl BitOr<UlaPlusRegFlags> for UlaPlusRegFlags
source§fn bitor(self, other: UlaPlusRegFlags) -> Self
fn bitor(self, other: UlaPlusRegFlags) -> Self
Returns the union of the two sets of flags.
§type Output = UlaPlusRegFlags
type Output = UlaPlusRegFlags
|
operator.source§impl BitOrAssign<UlaPlusRegFlags> for UlaPlusRegFlags
impl BitOrAssign<UlaPlusRegFlags> for UlaPlusRegFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<UlaPlusRegFlags> for UlaPlusRegFlags
impl BitXor<UlaPlusRegFlags> for UlaPlusRegFlags
source§impl BitXorAssign<UlaPlusRegFlags> for UlaPlusRegFlags
impl BitXorAssign<UlaPlusRegFlags> for UlaPlusRegFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for UlaPlusRegFlags
impl Clone for UlaPlusRegFlags
source§fn clone(&self) -> UlaPlusRegFlags
fn clone(&self) -> UlaPlusRegFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for UlaPlusRegFlags
impl Debug for UlaPlusRegFlags
source§impl Default for UlaPlusRegFlags
impl Default for UlaPlusRegFlags
source§fn default() -> UlaPlusRegFlags
fn default() -> UlaPlusRegFlags
source§impl<'de> Deserialize<'de> for UlaPlusRegFlags
impl<'de> Deserialize<'de> for UlaPlusRegFlags
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
source§impl Extend<UlaPlusRegFlags> for UlaPlusRegFlags
impl Extend<UlaPlusRegFlags> for UlaPlusRegFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl From<UlaPlusRegFlags> for u8
impl From<UlaPlusRegFlags> for u8
source§fn from(flags: UlaPlusRegFlags) -> u8
fn from(flags: UlaPlusRegFlags) -> u8
source§impl From<u8> for UlaPlusRegFlags
impl From<u8> for UlaPlusRegFlags
source§fn from(flags: u8) -> UlaPlusRegFlags
fn from(flags: u8) -> UlaPlusRegFlags
source§impl FromIterator<UlaPlusRegFlags> for UlaPlusRegFlags
impl FromIterator<UlaPlusRegFlags> for UlaPlusRegFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for UlaPlusRegFlags
impl Hash for UlaPlusRegFlags
source§impl LowerHex for UlaPlusRegFlags
impl LowerHex for UlaPlusRegFlags
source§impl Not for UlaPlusRegFlags
impl Not for UlaPlusRegFlags
source§impl Octal for UlaPlusRegFlags
impl Octal for UlaPlusRegFlags
source§impl Ord for UlaPlusRegFlags
impl Ord for UlaPlusRegFlags
source§fn cmp(&self, other: &UlaPlusRegFlags) -> Ordering
fn cmp(&self, other: &UlaPlusRegFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq<UlaPlusRegFlags> for UlaPlusRegFlags
impl PartialEq<UlaPlusRegFlags> for UlaPlusRegFlags
source§fn eq(&self, other: &UlaPlusRegFlags) -> bool
fn eq(&self, other: &UlaPlusRegFlags) -> bool
source§impl PartialOrd<UlaPlusRegFlags> for UlaPlusRegFlags
impl PartialOrd<UlaPlusRegFlags> for UlaPlusRegFlags
source§fn partial_cmp(&self, other: &UlaPlusRegFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &UlaPlusRegFlags) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Serialize for UlaPlusRegFlags
impl Serialize for UlaPlusRegFlags
source§impl Sub<UlaPlusRegFlags> for UlaPlusRegFlags
impl Sub<UlaPlusRegFlags> for UlaPlusRegFlags
source§impl SubAssign<UlaPlusRegFlags> for UlaPlusRegFlags
impl SubAssign<UlaPlusRegFlags> for UlaPlusRegFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.