6502/CLK
1
0
Fork 0
mirror of https://github.com/TomHarte/CLK.git synced 2025-02-18 01:30:56 +00:00
Code Issues Projects Releases Wiki Activity

Improve commentary.

Browse Source
This commit is contained in:
Thomas Harte 2023-01-01 13:41:51 -05:00
parent e8aab1fd2a
commit 71598250ea
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
Components/9918/9918.hpp
View File

@ -57,10 +57,7 @@ namespace TMS {
*/ */
template <Personality personality> class TMS9918: public Base<personality> { template <Personality personality> class TMS9918: public Base<personality> {
public: public:
/*! /*! Constructs an instance of the VDP that behaves according to the templated personality. */
Constructs an instance of the drive controller that behaves according to personality @c p.
@param p The type of controller to emulate.
*/
TMS9918(); TMS9918();
/*! Sets the TV standard for this TMS, if that is hard-coded in hardware. */ /*! Sets the TV standard for this TMS, if that is hard-coded in hardware. */
@ -69,7 +66,7 @@ template <Personality personality> class TMS9918: public Base<personality> {
/*! Sets the scan target this TMS will post content to. */ /*! Sets the scan target this TMS will post content to. */
void set_scan_target(Outputs::Display::ScanTarget *); void set_scan_target(Outputs::Display::ScanTarget *);
/// Gets the current scan status. /*! Gets the current scan status. */
Outputs::Display::ScanStatus get_scaled_scan_status() const; Outputs::Display::ScanStatus get_scaled_scan_status() const;
/*! Sets the type of display the CRT will request. */ /*! Sets the type of display the CRT will request. */
@ -79,8 +76,13 @@ template <Personality personality> class TMS9918: public Base<personality> {
Outputs::Display::DisplayType get_display_type() const; Outputs::Display::DisplayType get_display_type() const;
/*! /*!
Runs the VCP for the number of cycles indicate; it is an implicit assumption of the code Runs the VDP for the number of cycles indicate; the input clock rate is implicitly assumed.
that the input clock rate is 3579545 Hz, the NTSC colour clock rate.
For everything except the Mega Drive VDP:
* the input clock rate should be 3579545 Hz, the NTSC colour clock rate.
For the Mega Drive:
* the input clock rate should be [TODO].
*/ */
void run_for(const HalfCycles cycles); void run_for(const HalfCycles cycles);
@ -90,10 +92,10 @@ template <Personality personality> class TMS9918: public Base<personality> {
/*! Gets a register value. */ /*! Gets a register value. */
uint8_t read(int address); uint8_t read(int address);
/*! Gets the current scan line; provided by the Master System only. */ /*! Gets the current scan line; provided by the Sega VDPs only. */
uint8_t get_current_line(); uint8_t get_current_line();
/*! Gets the current latched horizontal counter; provided by the Master System only. */ /*! Gets the current latched horizontal counter; provided by the Sega VDPs only. */
uint8_t get_latched_horizontal_counter(); uint8_t get_latched_horizontal_counter();
/*! Latches the current horizontal counter. */ /*! Latches the current horizontal counter. */