ShuriZma
/
BizHawk
mirror of https://github.com/TASEmulators/BizHawk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

attempt to document ZwinderStateManagerSettings settings better

This commit is contained in:
adelikat 2020-08-29 10:07:34 -05:00
parent 234642ed0d
commit 991deee549
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/BizHawk.Client.Common/movie/tasproj/ZwinderStateManagerSettings.cs
View File

@ -26,47 +26,50 @@ namespace BizHawk.Client.Common
/// <summary>
/// Buffer settings when navigating near now
/// </summary>
[DisplayName("Current - Use Compression")]
[DisplayName("Current - Use Compression.")]
[Description("The Current buffer is the primary buffer used near the last edited frame. This should be the largest buffer to ensure minimal gaps during editing.")]
public bool CurrentUseCompression { get; set; }
[DisplayName("Current - Buffer Size")]
[Description("Max amount of buffer space to use in MB")]
[Description("Max amount of buffer space to use in MB. \n\nThe Current buffer is the primary buffer used near the last edited frame. This should be the largest buffer to ensure minimal gaps during editing.")]
public int CurrentBufferSize { get; set; } = 256;
[DisplayName("Current - Target Frame Length")]
[Description("Desired frame length (number of emulated frames you can go back before running out of buffer)")]
[Description("Desired frame length (number of emulated frames you can go back before running out of buffer) \n\nThe Current buffer is the primary buffer used near the last edited frame. This should be the largest buffer to ensure minimal gaps during editing.")]
public int CurrentTargetFrameLength { get; set; } = 500;
/// <summary>
/// Buffer settings when navigating directly before the Current buffer
/// </summary>
[DisplayName("Recent - Use Compression")]
[Description("The Recent buffer is the where current frames decay too as the buffer fills up. The goal of this buffer is maximize the amount of movie that can be fairly quickly navigated to. Therefore, a high target frame length is ideal here.")]
public bool RecentUseCompression { get; set; }
[DisplayName("Recent - Buffer Size")]
[Description("Max amount of buffer space to use in MB")]
[Description("Max amount of buffer space to use in MB.\n\nThe Recent buffer is the where current frames decay too as the buffer fills up. The goal of this buffer is maximize the amount of movie that can be fairly quickly navigated to. Therefore, a high target frame length is ideal here.")]
public int RecentBufferSize { get; set; } = 128;
[DisplayName("Recent - Target Frame Length")]
[Description("Desired frame length (number of emulated frames you can go back before running out of buffer)")]
[Description("Desired frame length (number of emulated frames you can go back before running out of buffer). The Recent buffer is the where current frames decay too as the buffer fills up. The goal of this buffer is maximize the amount of movie that can be fairly quickly navigated to. Therefore, a high target frame length is ideal here.")]
public int RecentTargetFrameLength { get; set; } = 2000;
/// <summary>
/// Priority States for special use cases
/// </summary>
[DisplayName("Gaps - Use Compression")]
[Description("The Gap buffer is used for temporary storage when replaying older segment of the run without editing. It is used to 're-greenzone' large gaps while navigating around in an older area of the movie. This buffer can be small, and a similar size to target frame length ratio as current is ideal.")]
public bool GapsUseCompression { get; set; }
[DisplayName("Gaps - Buffer Size")]
[Description("Max amount of buffer space to use in MB")]
[Description("Max amount of buffer space to use in MB\n\nThe Gap buffer is used for temporary storage when replaying older segment of the run without editing. It is used to 're-greenzone' large gaps while navigating around in an older area of the movie. This buffer can be small, and a similar size to target frame length ratio as current is ideal.")]
public int GapsBufferSize { get; set; } = 64;
[DisplayName("Gaps - Target Frame Length")]
[Description("Desired frame length (number of emulated frames you can go back before running out of buffer)")]
[Description("Desired frame length (number of emulated frames you can go back before running out of buffer)\n\nThe Gap buffer is used for temporary storage when replaying older segment of the run without editing. It is used to 're-greenzone' large gaps while navigating around in an older area of the movie. This buffer can be small, and a similar size to target frame length ratio as current is ideal.")]
public int GapsTargetFrameLength { get; set; } = 125;
[DisplayName("Ancient State Interval")]
[Description("How often to maintain states when outside of Current and Recent intervals")]
[Description("Once both the Current and Recent buffers have filled, some states are put into reserved to ensure there is always a state somewhat near a desired frame to navigate to. These states never decay but are invalidated. This number should be as high as possible without being overly cumbersome to replay this many frames.")]
public int AncientStateInterval { get; set; } = 5000;
// Just to simplify some other code.