From 108dfcbe546dcaa0c79c5ba7f08438ff50e08468 Mon Sep 17 00:00:00 2001 From: xmikecampx7 Date: Sun, 20 Jul 2014 16:12:05 +0000 Subject: [PATCH] Added N64 Syncsettings Documentation --- .../Nintendo/N64/N64SyncSettings.Glide.cs | 68 ++++++++++--------- .../Nintendo/N64/N64SyncSettings.GlideMk2.cs | 31 +++++---- .../Nintendo/N64/N64SyncSettings.Rice.cs | 61 +++++++++++++++-- 3 files changed, 107 insertions(+), 53 deletions(-) diff --git a/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64SyncSettings.Glide.cs b/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64SyncSettings.Glide.cs index 0db8eed3d3..61ce21edf1 100644 --- a/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64SyncSettings.Glide.cs +++ b/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64SyncSettings.Glide.cs @@ -77,11 +77,12 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64 } [DefaultValue(1)] - [DisplayName("WR Mode")] + [DisplayName("Wire Frame Mode")] + //0=Normal colors, 1=Vertex colors, 2=Red only public int WFMode { get; set; } [DefaultValue(false)] - [DisplayName("Wire Frame")] + [DisplayName("Wire Frame Display")] public bool WireFrame { get; set; } [DefaultValue(0)] @@ -89,15 +90,15 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64 public int CardId { get; set; } [DefaultValue(false)] - [DisplayName("Flame Corona")] + [DisplayName("Zelda corona fix")] public bool FlameCorona { get; set; } [DefaultValue(2)] - [DisplayName("UCode")] + [DisplayName("Force microcode")] public int UCode { get; set; } [DefaultValue(true)] - [DisplayName("Auto Detect UCode")] + [DisplayName("Auto-detect microcode")] public bool AutodetectUCode { get; set; } [DefaultValue(false)] @@ -105,11 +106,11 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64 public bool MotionBlur { get; set; } [DefaultValue(false)] - [DisplayName("Fb Read Always")] + [DisplayName("Framebuffer read every frame")] public bool FbReadAlways { get; set; } [DefaultValue(false)] - [DisplayName("Unk As Red")] + [DisplayName("Display unknown combines as red")] public bool UnkAsRed { get; set; } [DefaultValue(false)] @@ -125,27 +126,29 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64 public bool DisableAuxBuf { get; set; } [DefaultValue(false)] - [DisplayName("Fbo")] + [DisplayName("Use framebuffer objects")] public bool Fbo { get; set; } [DefaultValue(true)] - [DisplayName("No Glsl")] + [DisplayName("Disable GLSL combiners")] public bool NoGlsl { get; set; } [DefaultValue(true)] - [DisplayName("No Dithered Alpha")] + [DisplayName("Disable dithered alpha")] public bool NoDitheredAlpha { get; set; } [DefaultValue(0)] - [DisplayName("Text Filter")] + [DisplayName("Texture Filter")] + //0=None, 1=Blur edges, 2=Super 2xSai, 3=Hq2x, 4=Hq4x public int TexFilter { get; set; } [DefaultValue(false)] - [DisplayName("Fb Render")] + [DisplayName("Framebuffer Render")] + //Framebuffer Depth Render in main.cpp? public bool FbRender { get; set; } [DefaultValue(false)] - [DisplayName("Wrap Big Text")] + [DisplayName("Wrap textures too big for tmem")] public bool WrapBigTex { get; set; } [DefaultValue(false)] @@ -161,15 +164,15 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64 public bool PPL { get; set; } [DefaultValue(false)] - [DisplayName("Fb Optimize Write")] + [DisplayName("Framebuffer Optimize Write")] public bool FbOptimizeWrite { get; set; } [DefaultValue(true)] - [DisplayName("Fb Optimize Text Rectangle")] + [DisplayName("Framebuffer Optimize Texture Rectangle")] public bool FbOptimizeTexRect { get; set; } [DefaultValue(false)] - [DisplayName("Increase Text Rectangle Edge")] + [DisplayName("Increase Texture Rectangle Edge")] public bool IncreaseTexRectEdge { get; set; } [DefaultValue(false)] @@ -177,15 +180,15 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64 public bool IncreasePrimDepth { get; set; } [DefaultValue(false)] - [DisplayName("Fb Ignore Previous")] + [DisplayName("Framebuffer Ignore Previous")] public bool FbIgnorePrevious { get; set; } [DefaultValue(false)] - [DisplayName("Fb Ignore Aux Copy")] + [DisplayName("Framebuffer Ignore Aux Copy")] public bool FbIgnoreAuxCopy { get; set; } [DefaultValue(true)] - [DisplayName("Fb High Resolution Buffer Clear")] + [DisplayName("Framebuffer High Resolution Buffer Clear")] public bool FbHiResBufClear { get; set; } [DefaultValue(false)] @@ -197,7 +200,7 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64 public bool ForceDepthCompare { get; set; } [DefaultValue(true)] - [DisplayName("Fog")] + [DisplayName("Fog Enabled")] public bool Fog { get; set; } [DefaultValue(false)] @@ -205,27 +208,27 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64 public bool FillColorFix { get; set; } [DefaultValue(false)] - [DisplayName("Fb Smart")] + [DisplayName("Smart Framebuffer")] public bool FbSmart { get; set; } [DefaultValue(false)] - [DisplayName("Fb Read Alpha")] + [DisplayName("Framebuffer Read Alpha")] public bool FbReadAlpha { get; set; } [DefaultValue(false)] - [DisplayName("Fb Get Info")] + [DisplayName("Get Framebuffer Info")] public bool FbGetInfo { get; set; } [DefaultValue(true)] - [DisplayName("Fb High Res")] + [DisplayName("High Res Framebuffer")] public bool FbHiRes { get; set; } [DefaultValue(false)] - [DisplayName("Fb Clear")] + [DisplayName("Clear Framebuffer")] public bool fb_clear { get; set; } [DefaultValue(false)] - [DisplayName("Detect CPU Write")] + [DisplayName("Detect CPU Writes")] public bool detect_cpu_write { get; set; } [DefaultValue(false)] @@ -233,7 +236,7 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64 public bool decrease_fillrect_edge { get; set; } [DefaultValue(true)] - [DisplayName("Buffer Clear")] + [DisplayName("Buffer Clear on Every Frame")] public bool buff_clear { get; set; } [DefaultValue(false)] @@ -249,7 +252,8 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64 public int enable_hacks_for_game { get; set; } [DefaultValue(1)] - [DisplayName("Swap Mode")] + [DisplayName("Buffer swapping method")] + //0=Old, 1=New, 2=Hybrid public int swapmode { get; set; } [DefaultValue(1041204192)] @@ -277,7 +281,8 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64 public int offset_x { get; set; } [DefaultValue(0)] - [DisplayName("LOD Mode")] + [DisplayName("LOD calculation")] + //0=Off, 1=Fast, 2=Precise public int lodmode { get; set; } [DefaultValue(0)] @@ -285,11 +290,12 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64 public int fix_tex_coord { get; set; } [DefaultValue(1)] - [DisplayName("Filtering")] + [DisplayName("Filtering Mode")] + //0=None, 1=Force bilinear, 2=Force point-sampled public int filtering { get; set; } [DefaultValue(20)] - [DisplayName("Depth Bias")] + [DisplayName("Depth bias level")] public int depth_bias { get; set; } public N64GlidePluginSettings Clone() diff --git a/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64SyncSettings.GlideMk2.cs b/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64SyncSettings.GlideMk2.cs index f985685d57..cada5051d2 100644 --- a/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64SyncSettings.GlideMk2.cs +++ b/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64SyncSettings.GlideMk2.cs @@ -59,13 +59,14 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64 } [JsonIgnore] + [DisplayName("Plugin Type")] public PluginType PluginType { get { return PluginType.GLIDE64MK2; } } [DefaultValue(true)] - [DisplayName("WrpFBO")] + [DisplayName("Wrapper FBO")] public bool wrpFBO { get; set; } [DefaultValue(0)] @@ -77,11 +78,11 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64 public bool use_sts1_only { get; set; } [DefaultValue(true)] - [DisplayName("Optimize Text Rectangle")] + [DisplayName("Optimize Texture Rectangle")] public bool optimize_texrect { get; set; } [DefaultValue(false)] - [DisplayName("Increase Text Rectangle Edge")] + [DisplayName("Increase Texture Rectangle Edge")] public bool increase_texrect_edge { get; set; } [DefaultValue(false)] @@ -97,23 +98,23 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64 public bool force_microcheck { get; set; } [DefaultValue(true)] - [DisplayName("Fog")] + [DisplayName("Fog Enabled")] public bool fog { get; set; } [DefaultValue(false)] - [DisplayName("Fb Smart")] + [DisplayName("Smart Framebuffer")] public bool fb_smart { get; set; } [DefaultValue(false)] - [DisplayName("Fb Read Alpha")] + [DisplayName("Framebuffer Read Alpha")] public bool fb_read_alpha { get; set; } [DefaultValue(true)] - [DisplayName("Fb High Res")] + [DisplayName("High Res Framebuffer")] public bool fb_hires { get; set; } [DefaultValue(false)] - [DisplayName("Detect CPU Write")] + [DisplayName("Detect CPU Writes")] public bool detect_cpu_write { get; set; } [DefaultValue(false)] @@ -125,7 +126,7 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64 public bool buff_clear { get; set; } [DefaultValue(false)] - [DisplayName("Alt Text Size")] + [DisplayName("Alt Texture Size")] public bool alt_tex_size { get; set; } [DefaultValue(1)] @@ -141,7 +142,7 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64 public int stipple_mode { get; set; } [DefaultValue(0)] - [DisplayName("LOD Mode")] + [DisplayName("LOD Calcuation")] public int lodmode { get; set; } [DefaultValue(0)] @@ -149,7 +150,7 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64 public int filtering { get; set; } [DefaultValue(false)] - [DisplayName("Wrap Anisotropic")] + [DisplayName("Wrapper Anisotropic Filtering")] public bool wrpAnisotropic { get; set; } [DefaultValue(false)] @@ -201,15 +202,15 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64 public bool useless_is_useless { get; set; } [DefaultValue(false)] - [DisplayName("Fb Read Always")] + [DisplayName("Framebuffer read every frame")] public bool fb_read_always { get; set; } [DefaultValue(false)] - [DisplayName("Fb Get Info")] + [DisplayName("Get Framebuffer Info")] public bool fb_get_info { get; set; } [DefaultValue(true)] - [DisplayName("Fb Render")] + [DisplayName("Framebuffer Render")] public bool fb_render { get; set; } [DefaultValue(0)] @@ -217,7 +218,7 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64 public int aspectmode { get; set; } [DefaultValue(1)] - [DisplayName("Fb CRC Mode")] + [DisplayName("Framebuffer CRC Mode")] public int fb_crc_mode { get; set; } [DefaultValue(true)] diff --git a/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64SyncSettings.Rice.cs b/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64SyncSettings.Rice.cs index 7f28867a98..ef3cb29c88 100644 --- a/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64SyncSettings.Rice.cs +++ b/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64SyncSettings.Rice.cs @@ -87,139 +87,186 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64 } [DefaultValue(0)] - [DisplayName("Frame Buffer Setting")] + [DisplayName("Frame Buffer Emulation")] + // 0=ROM default, 1=disable public int FrameBufferSetting { get; set; } [DefaultValue(0)] - [DisplayName("Frame Buffer Write Back Control")] + [DisplayName("Frame Buffer Wrie Back Control")] + // Frequency to write back the frame buffer + // 0=every frame, 1=every other frame, etc public int FrameBufferWriteBackControl { get; set; } [DefaultValue(0)] - [DisplayName("Frame Buffer Write Back Control")] + [DisplayName("Render-to-texture emulation")] + // 0=none, 1=ignore, 2=normal, 3=write back, 4=write back and reload public int RenderToTexture { get; set; } [DefaultValue(4)] [DisplayName("Screen Update Setting")] + // Control when the screen will be updated + // 0=ROM default, 1=VI origin update, 2=VI origin change, + // 3=CI change, 4=first CI change, 5=first primitive draw, + // 6=before screen clear, 7=after screen drawn public int ScreenUpdateSetting { get; set; } [DefaultValue(2)] [DisplayName("Mip Mapping")] + // 0=no, 1=nearest, 2=bilinear, 3=trilinear public int Mipmapping { get; set; } [DefaultValue(0)] [DisplayName("Fog Method")] + // 0=Disable, 1=Enable n64 choose, 2=Force Fog public int FogMethod { get; set; } [DefaultValue(0)] [DisplayName("Force Texture Filter")] + // Force to use texture filtering or not + // 0=auto: n64 choose, 1=force no filtering, 2=force filtering public int ForceTextureFilter { get; set; } [DefaultValue(0)] - [DisplayName("Texture Enhancement")] + [DisplayName("Primary texture enhancement filter")] + // 0=None, 1=2X, 2=2XSAI, 3=HQ2X, 4=LQ2X, 5=HQ4X, 6=Sharpen, 7=Sharpen More, 8=External, 9=Mirrored public int TextureEnhancement { get; set; } [DefaultValue(0)] - [DisplayName("Texture Enhancement Control")] + [DisplayName("Secondary texture enhancement filter")] + // 0 = none, 1-4 = filtered public int TextureEnhancementControl { get; set; } [DefaultValue(0)] [DisplayName("Texture Quality")] + // Color bit depth to use for textures + // 0=default, 1=32 bits, 2=16 bits public int TextureQuality { get; set; } [DefaultValue(16)] [DisplayName("OpenGL Depth Buffer Setting")] + // Z-buffer depth (only 16 or 32) public int OpenGLDepthBufferSetting { get; set; } [DefaultValue(0)] - [DisplayName("Multi-sampling")] + [DisplayName("Enable/Disable MultiSampling")] + // 0=off, 2,4,8,16=quality public int MultiSampling { get; set; } [DefaultValue(0)] [DisplayName("Color Quality")] + // Color bit depth for rendering window + // 0=32 bits, 1=16 bits public int ColorQuality { get; set; } [DefaultValue(0)] [DisplayName("OpenGL Render Setting")] + // OpenGL level to support + // 0=auto, 1=OGL_1.1, 2=OGL_1.2, 3=OGL_1.3, 4=OGL_1.4, + // 5=OGL_1.4_V2, 6=OGL_TNT2, 7=NVIDIA_OGL, 8=OGL_FRAGMENT_PROGRAM public int OpenGLRenderSetting { get; set; } [DefaultValue(0)] - [DisplayName("Anisotropic Filter")] + [DisplayName("Anisotropic Filtering")] + // Enable/Disable Anisotropic Filtering for Mipmapping + // 0=no filtering, 2-16=quality + //This is uneffective if Mipmapping is 0. If the given value is to high to + // be supported by your graphic card, the value will be the highest value + //your graphic card can support. Better result with Trilinear filtering public int AnisotropicFiltering { get; set; } [DefaultValue(false)] [DisplayName("Normal Alpha Blender")] + // Force to use normal alpha blender public bool NormalAlphaBlender { get; set; } [DefaultValue(false)] [DisplayName("Fast Texture Loading")] + // Use a faster algorithm to speed up texture loading and CRC computation public bool FastTextureLoading { get; set; } [DefaultValue(true)] [DisplayName("Accurate Texture Mapping")] + // Use different texture coordinate clamping code public bool AccurateTextureMapping { get; set; } [DefaultValue(false)] [DisplayName("In N64 Resolution")] + // Force emulated frame buffers to be in N64 native resolution public bool InN64Resolution { get; set; } [DefaultValue(false)] [DisplayName("Save VRAM")] + // Try to reduce Video RAM usage (should never be used) public bool SaveVRAM { get; set; } [DefaultValue(false)] [DisplayName("Double Size for Small Texture Buffer")] + // Enable this option to have better render-to-texture quality public bool DoubleSizeForSmallTxtrBuf { get; set; } [DefaultValue(false)] [DisplayName("Default Combiner Disable")] + // Force to use normal color combiner public bool DefaultCombinerDisable { get; set; } [DefaultValue(true)] [DisplayName("Enable Hacks")] + // Enable game-specific settings from INI file public bool EnableHacks { get; set; } [DefaultValue(false)] [DisplayName("WinFrame Mode")] + // If enabled, graphics will be drawn in WinFrame mode instead of solid and texture mode public bool WinFrameMode { get; set; } [DefaultValue(false)] [DisplayName("Full TMEM Emulation")] + // N64 Texture Memory Full Emulation (may fix some games, may break others) public bool FullTMEMEmulation { get; set; } [DefaultValue(false)] [DisplayName("OpenGL Vertex Clipper")] + // Enable vertex clipper for fog operations public bool OpenGLVertexClipper { get; set; } [DefaultValue(true)] [DisplayName("Enable SSE")] + //Enable/Disable SSE optimizations for capable CPUs public bool EnableSSE { get; set; } [DefaultValue(false)] [DisplayName("Enable Vertex Shader")] + // Use GPU vertex shader public bool EnableVertexShader { get; set; } [DefaultValue(false)] [DisplayName("Skip Frame")] + // If this option is enabled, the plugin will skip every other frame public bool SkipFrame { get; set; } [DefaultValue(false)] [DisplayName("Text Rect Only")] + // If enabled, texture enhancement will be done only for TxtRect ucode public bool TexRectOnly { get; set; } [DefaultValue(false)] [DisplayName("Small Texture Only")] + // If enabled, texture enhancement will be done only for textures width+height<=128 public bool SmallTextureOnly { get; set; } [DefaultValue(true)] [DisplayName("Load Hi Res CRC Only")] + // Select hi-resolution textures based only on the CRC and ignore format+size information (Glide64 compatibility) public bool LoadHiResCRCOnly { get; set; } [DefaultValue(false)] [DisplayName("Load Hi Res Textures")] + // Enable hi-resolution texture file loading public bool LoadHiResTextures { get; set; } [DefaultValue(false)] [DisplayName("Dump Textures to Files")] + // Enable texture dumping public bool DumpTexturesToFiles { get; set; } [DefaultValue(true)]