mirror of
https://github.com/TomHarte/CLK.git
synced 2024-08-19 21:29:04 +00:00
Increased documentation.
This commit is contained in:
parent
fcf63a7547
commit
cf1403bc79
@ -52,7 +52,22 @@ struct Sector {
|
|||||||
};
|
};
|
||||||
|
|
||||||
extern const size_t DefaultSectorGapLength;
|
extern const size_t DefaultSectorGapLength;
|
||||||
|
/*!
|
||||||
|
Converts a vector of sectors into a properly-encoded MFM track.
|
||||||
|
|
||||||
|
@param sectors The sectors to write.
|
||||||
|
@param sector_gap_length If specified, sets the distance in whole bytes between each ID and its data.
|
||||||
|
@param sector_gap_filler_byte If specified, sets the value (unencoded) that is used to populate the gap between each ID and its data.
|
||||||
|
*/
|
||||||
std::shared_ptr<Storage::Disk::Track> GetMFMTrackWithSectors(const std::vector<Sector> §ors, size_t sector_gap_length = DefaultSectorGapLength, uint8_t sector_gap_filler_byte = 0x4e);
|
std::shared_ptr<Storage::Disk::Track> GetMFMTrackWithSectors(const std::vector<Sector> §ors, size_t sector_gap_length = DefaultSectorGapLength, uint8_t sector_gap_filler_byte = 0x4e);
|
||||||
|
|
||||||
|
/*!
|
||||||
|
Converts a vector of sectors into a properly-encoded FM track.
|
||||||
|
|
||||||
|
@param sectors The sectors to write.
|
||||||
|
@param sector_gap_length If specified, sets the distance in whole bytes between each ID and its data.
|
||||||
|
@param sector_gap_filler_byte If specified, sets the value (unencoded) that is used to populate the gap between each ID and its data.
|
||||||
|
*/
|
||||||
std::shared_ptr<Storage::Disk::Track> GetFMTrackWithSectors(const std::vector<Sector> §ors, size_t sector_gap_length = DefaultSectorGapLength, uint8_t sector_gap_filler_byte = 0x4e);
|
std::shared_ptr<Storage::Disk::Track> GetFMTrackWithSectors(const std::vector<Sector> §ors, size_t sector_gap_length = DefaultSectorGapLength, uint8_t sector_gap_filler_byte = 0x4e);
|
||||||
|
|
||||||
class Encoder {
|
class Encoder {
|
||||||
|
Loading…
Reference in New Issue
Block a user