Struct spectrusty_core::clock::VFrameTsCounter

pub struct VFrameTsCounter<V, C> {
    pub vts: VFrameTs<V>,
    pub contention: C,
}

A generic VFrameTs<V> based T-states counter.

Implements Clock for counting cycles when code is being executed by z80emu::Cpu.

Inserts additional T-states according to the contention model specified by generic parameters: V: VideoFrame and C: MemoryContention.

Fields

vts: VFrameTs<V>

The current value of the counter.

contention: C

An instance implementing a MemoryContention trait.

Implementations

impl<V, C> VFrameTsCounter<V, C> where
    V: VideoFrame,
    C: MemoryContention, 

pub fn new(vc: Ts, hc: Ts, contention: C) -> Self

Constructs a new and normalized VFrameTsCounter from the given vertical and horizontal counter values.

Panics

Panics when the given values lead to an overflow of the capacity of VideoTs.

pub fn from_tstates(ts: FTs, contention: C) -> Self

Builds a normalized VFrameTsCounter from the given count of T-states.

Panics

Panics when the given ts overflows the capacity of VideoTs.

pub fn from_video_ts(vts: VideoTs, contention: C) -> Self

Builds a normalized VFrameTsCounter from the given count of T-states.

Panics

Panics when the given ts overflows the capacity of VideoTs.

pub fn from_vframe_ts(vfts: VFrameTs<V>, contention: C) -> Self

Builds a normalized VFrameTsCounter from the given count of T-states.

Panics

Panics when the given ts overflows the capacity of VideoTs.

pub fn is_contended_address(self, address: u16) -> bool

Methods from Deref<Target = VFrameTs<V>>

pub const EOF: VFrameTs<V>

pub fn wrap_frame(&mut self)

Ensures the vertical counter is in the range: (-VSL_COUNT, VSL_COUNT) by calculating a remainder of the division of the vertical counter by VideoFrame::VSL_COUNT.

Methods from Deref<Target = VideoTs>

Trait Implementations

impl<V: VideoFrame, C> AddAssign<u32> for VFrameTsCounter<V, C>

pub fn add_assign(&mut self, delta: u32)

Performs the += operation.

impl<V: VideoFrame, C: MemoryContention> Clock for VFrameTsCounter<V, C>

type Limit = Ts

This type is being used for an arbitrary representation of the limit argument when executing instructions. See Cpu::execute_with_limit for an explanation.

type Timestamp = VideoTs

This type is being used for timestamping the interactions between Cpu, Io and Memory implementations.

pub fn is_past_limit(&self, limit: Self::Limit) -> bool

Should return true if the Clock has reached the given limit otherwise should return false.

pub fn add_irq(&mut self, _pc: u16) -> Self::Timestamp

This method should increase the counter by at least IRQ_ACK_CYCLE_TS 6 T-states. The method should return the timestamp that may be passed to Io::irq_data. It's being used at the beginning of the maskable interrupt request/acknowledge cycle. The pc is a value of the program counter when the interrupt was accepted.

pub fn add_no_mreq(&mut self, address: u16, add_ts: NonZeroU8)

This method should increase the counter by at least the value given in add_ts. It's being used by internal operations of the Cpu without any external access. The address given here is whatever was put on the address bus before.

pub fn add_m1(&mut self, address: u16) -> Self::Timestamp

This method should increase the counter by at least M1_CYCLE_TS 4 and should return the timestamp that may be passed to Memory::read_opcode. This method is also being used when the non-maskable interrupt is being accepted and while the Cpu is wasting cycles in the halted state.

pub fn add_mreq(&mut self, address: u16) -> Self::Timestamp

This method should increase the counter by at least the value given in MEMRW_CYCLE_TS 3 and should return the timestamp that may be passed to Memory::read_mem,

pub fn add_io(&mut self, port: u16) -> Self::Timestamp

This method should increase the counter by at least IO_CYCLE_TS 4 T-states and should return the timestamp that may be passed to Io::read_io or Io::write_io.

pub fn add_wait_states(&mut self, _bus: u16, wait_states: NonZeroU16)

This method should increase the counter by the value given in wait_states. A call to one of Io::read_io, Io::write_io or Io::irq_data may request such additional number of wait states to be added.

pub fn as_timestamp(&self) -> Self::Timestamp

Should return the current state of the Clock as a timestamp.

impl<V: Clone, C: Clone> Clone for VFrameTsCounter<V, C>

pub fn clone(&self) -> VFrameTsCounter<V, C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V: Copy, C: Copy> Copy for VFrameTsCounter<V, C>

impl<V: Debug, C: Debug> Debug for VFrameTsCounter<V, C>

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

Formats the value using the given formatter.

impl<V, C> Deref for VFrameTsCounter<V, C>

type Target = VFrameTs<V>

The resulting type after dereferencing.

pub fn deref(&self) -> &Self::Target

Dereferences the value.

impl<V, C> DerefMut for VFrameTsCounter<V, C>

pub fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<V: Eq, C: Eq> Eq for VFrameTsCounter<V, C>

impl<V, C> From<VFrameTsCounter<V, C>> for VideoTs

pub fn from(vftsc: VFrameTsCounter<V, C>) -> VideoTs

Performs the conversion.

impl<V, C> From<VFrameTsCounter<V, C>> for VFrameTs<V>

pub fn from(vftsc: VFrameTsCounter<V, C>) -> VFrameTs<V>

Performs the conversion.

impl<V: Hash, C: Hash> Hash for VFrameTsCounter<V, C>

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<V: Ord, C: Ord> Ord for VFrameTsCounter<V, C>

pub fn cmp(&self, other: &VFrameTsCounter<V, C>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<V: PartialEq, C: PartialEq> PartialEq<VFrameTsCounter<V, C>> for VFrameTsCounter<V, C>

pub fn eq(&self, other: &VFrameTsCounter<V, C>) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &VFrameTsCounter<V, C>) -> bool

This method tests for !=.

impl<V: PartialOrd, C: PartialOrd> PartialOrd<VFrameTsCounter<V, C>> for VFrameTsCounter<V, C>

pub fn partial_cmp(&self, other: &VFrameTsCounter<V, C>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &VFrameTsCounter<V, C>) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &VFrameTsCounter<V, C>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &VFrameTsCounter<V, C>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &VFrameTsCounter<V, C>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<V, C> StructuralEq for VFrameTsCounter<V, C>

impl<V, C> StructuralPartialEq for VFrameTsCounter<V, C>

impl<V: VideoFrame, C> SubAssign<u32> for VFrameTsCounter<V, C>

pub fn sub_assign(&mut self, delta: u32)

Performs the -= operation.