Difference between revisions of "HelixMod Feature List"

From Bo3b's School for Shaderhackers
Jump to: navigation, search
(→‎Gotchas)
Line 14: Line 14:
  
 
* Gotcha - Output registers cannot be read.  ''mov r3, o0'' will silently fail, but still assemble.  Overwriting an output register works.
 
* Gotcha - Output registers cannot be read.  ''mov r3, o0'' will silently fail, but still assemble.  Overwriting an output register works.
 +
 +
  
 
== Helix Mod Advanced Techniques, Tips and Tricks ==
 
== Helix Mod Advanced Techniques, Tips and Tricks ==

Revision as of 18:41, 4 January 2015

Contents

Gotchas

HelixMod
  • Gotcha - it's a good to add comments to your DX9Settings.ini, but beware that comments must go on their own separate lines. If you add them to the end of a line the entire line will be ignored.
  • Gotcha - Pressing F7 in the game (to save custom separation and convergence settings to a preset) will remove all comments (in fact - all lines the DLL does not understand) from the DX9Settings.ini. It seems that comments starting with a semicolon instead of a double slash are retained.
  • Gotcha - Games can sometimes crash when moving the view with the mouse, when a particular shader is disabled while hunting. Press the Numpad- key to clear the disable list before moving to a new spot.
ASM
  • Gotcha - You cannot use two different constants in a given instruction. add r30.x, c250.y, c220.x will silently fail.
  • Gotcha - Output registers cannot be read. mov r3, o0 will silently fail, but still assemble. Overwriting an output register works.


Helix Mod Advanced Techniques, Tips and Tricks

This section is mostly for advanced techniques that may be useful in certain situations. For the basics of using Helix mod, refer to the lessons.

Shader Hunting a Vertex Shader for a Given Pixel Shader (or vice versa)

If you are having difficulty finding a pixel or vertex shader for a given effect, but you are able to find the other type of shader for the effect, you can look at the numbers next to VertexPair and PixelPair to work out possible shaders.

e.g. If you are looking for a pixel shader for an effect, but can only identify the vertex shader, cycle until the vertex shader is disabled and look at the number next to VertexPair. Then cycle pixel shaders to that same number and you will be on the corresponding pixel shader.

Note that these numbers may change while cycling shaders, so I'd suggest cycling both pixel and vertex shaders to different effects and back to make sure the numbers still match up.

e.g. If you have successfully disabled both vertex and pixel shaders for the same effect, you will have VS = PixelPair and PS = VertexPair, like this: 

   VS 36 CRC32 0xblah PS 28 CRC32 0xblah ... VertexPair 28 PixelPair 36

Also, keep in mind that that some effects may have multiple layers, so you may need to check several shader pairs (and sometimes these even have the same CRCs for one of the shaders) to find the right one.

Texture Hunting and Filtering

If you have altered a shader and find it is affecting things that you would rather leave alone, you need to find a way to distinguish between the different effects it is used for. This is quite common for UI shaders, where you may only want to adjust the depth for part of the UI (e.g. crosshair), or where you find the UI shader also affects other non-UI things in the scene. One common technique do achieve this is by filtering on the CRC of the texture used for the effects.

To get started you will need to identify the CRCs of the relevant textures. Helix mod supports hunting for textures in much the same way as it does for shaders. To get started you first need to add bCalcTexCRCatStart = true in the ini. The up/down arrow keys will cycle textures by default, but you can change them with PrevTexKey and NextTexKey if they interfere with the game.

For the most part textures will go black while they are disabled, and once you have found the right one you should write down the CRC displayed in the red text (if they are shorter than 8 characters, pad them with zeros in the same way we do for shaders).

You will need to add a section similar to the following to the ini file (replace nnnnnnnn with the CRC of the vertex shader you are filtering in): 

   [VSnnnnnnnn]
   CheckTexCRC = true
   ValForDefined = 1
   ValNotDefined = 0
   TexCounterReg = 251
   UseDefinedOnly = false
   DefinedTexturesVS = 01234567;89ABCDEF;

The DefinedTexturesVS list needs to be filled out with the texture CRCs you found. You have two choices - you either need to list all the textures where you *DO* want the depth adjustment to be enabled (whitelisting), or list those where you *DON'T* want the adjustment to be enabled (blacklisting), but *not both*. If you can only find textures for some of the effects that might force your decision, or if you find that one way would require you to keep finding more and more textures it might be easier to go the other way (e.g. for a while in Dreamfall Chapters I was whitelisting every texture used on an inventory object, but that didn't seem smart as I'd have to keep finding more and more textures, so I blacklisted the inventory background instead).

It's probably worthwhile leaving a comment in the ini with what CRC corresponds with what. It's also a good idea to leave a comment for the textures you didn't inlcude in the DefiendTexturesVS list as well, so if find you need to invert the test later on you don't have to hunt them all again.

In the shader you will be able to determine if the texture was in the list or not by testing the x component of the constant register defined by TexCounterReg (c251.x in this example). If it is in the list, it will have the value in ValForDefined (1.0 in this example), otherwise it will have the value defined by ValNotDefined (0.0 in this example).

Then, in the shader you add an if_eq around the stereo adjustment, something like: 

   def c220, 0, 1, 0.0625, 0.5 // Added a 0 and 1 in .x and .y of this constant
   
   // ...
   
   // We can't use two constant registers in the same instruction, so copy
   // TexCounterReg to a temporary register first:
   mov r29.x, c251.x
   
   // Test if the texture is whitelisted if TexCounterReg.x == ValForDefined
   // For blacklisting, check if TexCounterReg.x == ValNotDefined instead
   if_eq r29.x, c220.y
   
       // Whatever needs to be conditional, e.g. a UI depth adjustment:
       texldl r31, c220.z, s0
       mad r30.x, r31.x, c200.z, r30.x
   
   endif
   
   // Anything that needs to always happen, e.g. copying the temporary position
   // register to the output position register:
   mov o1, r30

Reliability: Sometimes a texture will have a different CRC every time the game is launched which will make it impossible to filter on. In this case the test should be inverted to avoid the need for that CRC, or an alternate filtering method will need to be employed.

Pixel Shaders: Helix Mod appears to support texture filtering in pixel shaders as well (with DefinedTexturesPS and a TexCounterReg no higher than 223), however it appears that this may not work. One possible workaround might be to use the vertex shader to pass the TexCounterReg through to the pixel shader as an extra texcoord output.


Overriding an Individual Instance of a Shader

If you find multiple shaders with the same CRC and need to apply different fixes to each instance, you can add an index number to the filename, as in XXXXXXXX.txt.1, XXXXXXXX.txt.2 and so on.

This technique was originally documented here:

http://helixmod.blogspot.com/2012/03/dlls-update.html

Examples of fixes using this technique:


Overriding a Vertex Shader Based on the Matching Pixel Shader

If you find a vertex shader that is used for multiple effects and you need to apply different fixes to different instances of the vertex shader you need to find a way to distinguish between them. If they use different pixel shaders you may be able to use this technique to do so.

You will need to hunt down the pixel shaders for each of the effects you need to fix. These will all need to be added to the ShaderOverride\PixelShaders folder, though you do not need to alter them (except maybe to upgrade them to ps_3_0 if they are an earlier version).

Then, rename your vertex shader to the CRC of the pixel shader and add a .txt.ps extension (e.g. if the pixel shader for the UI was 12345678.txt, you would rename the vertex shader to Shaderoverride\VetexShaders\12345678.txt.ps). Make a copy of this shader for each pixel shader and name it appropriately.

Then, apply the appropriate fix for each of the vertex shaders for whichever pixel shader they correspond with.

Default vertex shader:

If you find a vertex shader used for a lot of effects and most of them need to be fixed in the same way, you may prefer to leave a default vertex shader with it's original filename for most of the effects, and use the pixel shader specific ones only where you need a different fix. Note that reliability issues have been noted in this case, where a pixel shader specific vertex shader may sometimes be used in other instances.

Example:

In Montague's Mount, one of the vertex shaders is used for three different effects - part of the UI, the lens flare and halos around lights. Originally I was using the texture filtering technique to distinguish between UI and flare/halos and depth to distinguish between flares and halos:

https://github.com/DarkStarSword/3d-fixes/blob/c8956ee23d6ad7518dd31b1bbe6c2467b10c158c/Montague%27s%20Mount/ShaderOverride/VertexShaders/CD61F9B3.txt

As an experiment, I replaced the texture filtering technique with these two separate vertex shaders (the flare and halos use the same pixel shader, so I still needed the depth test to distinguish between them):


Inserting a Missing Vertex Shader Before a Pixel Shader

This is a variation on the above, but for the situation where you need to move the position of an effect, but no vertex shader exists for the effect, but a pixel shader does. In this case you will have to manufacture a new vertex shader that has the passes it's inputs straight through to it's outputs (except for the position which you are adjusting).

Presumably you would need to pass through any inputs that the pixel shader uses, such as texcoords, colors, etc.

This technique is known to be used in the X3 fix:

http://helixmod.blogspot.com/2012/03/x3-terran-conflict-and-albion-prelude.html


Overview of DX9Settings.ini

[General]

UseAlternateCRC

This is either true or false. It is unclear if this was a general feature or specific to a given game. It is believed that it was provided to get round the issue whereby a game will write the installation directory to the shaders, so the CRCs are different depending on where the game is installed.

Currently only know to be used in DarkSiders2.

DefModuleName

This is used in conjunction with the separate helix launcher tool to define the name of the game executable to hook to. It was introduced to get around issues some games had with Steam, Uplay etc.

InitMouse

This is either true or false.

Set to false if you find a game where the mouse stops working.

ProxyLib

Used to specify another d3d9 proxy dll to pass onto after "finishing" the helix dll operation. Often used to specifiy other post-process injectors like sweetfx etc.

UseRenderedShaders

UseRenderedShaders=true is nearly always useful, because it trims the list of shaders seen while hunting down to just those active in the current scene. Disable this only if you get crashes during hunting.

DumpAll

DumpAll will generate ASM text files for every shader seen by the game. This is usually worth doing once, but not useful for every run.

DefPSSampler

Defines which sampler register is used to retrieve the stereo settings from pixel shaders.

Defaults to s13

DefVSSampler

Defines which sampler register is used to retrieve the stereo settings from vertex shaders.

Note that you need to add 257 to the desired sampler number (this quirk only applies to vertex shaders).

Defaults to s0

DefVSConst1

Defines which c register Const1 through Const4 will end up in in vertex shaders.

Note that all four constant values end up in the one register as x, y, z and w. e.g. to access Const2 you would use c200.y if DefVSConst1 is set to 200.

It's a good idea to search through the AllShaders dump to find a constant register that is not used by the game.

DefPSConst1

Same as DefVSConst1, but for pixel shaders.

DefVSConst2

Defines which c register Const5 through Const7 will end up in in vertex shaders.

NOTE THAT THIS IS NOT WHERE Const2 ENDS UP - THAT IS IN DefVSConst1!

Note that all four constant values end up in the one register as x, y, z and w.

DefPSConst2

Same as DefVSConst2, but for pixel shaders.

NOTE THAT THIS IS NOT WHERE Const2 ENDS UP - THAT IS IN DefVSConst1!

PresetsKeysList

Defines which KEY sections are used by the DLL. Note that every number in this list needs to be followed by a semicolon, including the last number.

UseEndScene

This can be "true" or "false". If you have issues with the rendering of the red CRC text, so either you can't see it, or on occasion it gets rendered *in game*, projected on objects, or perhaps it might be rendered as really large text, cycle these values.

bCalcTexCRCatStart

Enables cycling of textures using PrexTexKey and NextTexKey

PrevTexKey

Defines which key cycles backwards through textures. Must have bCalcTexCRCatStart = true

Default Value: Down

NextTexKey

Defines which key cycles forwards through textures. Must have bCalcTexCRCatStart = true

Default Value: Up

DefPSViewSizeConst

This has a default value of 221. It is used to store screen size in the x and y values, and the inverse screen sizes in the z and w values. This is primarilly useful when you need to map from x-y coordinates passed into a PS via the vPOS variable to "texture coordinates" for use in samplers.

DefSquareSurfaceMode

Sets the default stereoization rendering mode for all square surfaces & render targets:

0 = render according to Nvidia automatic

1 = render forcing this surface to be stereoized

2 = render forcing this surface to be monoscopic

This can be overridden by individual surface & render target declarations in the DX9Settings.ini file in sections labelled "[SFn]" (surfaces) and "[RTn]" (render targets), where n is a number. This is most relevant for shadow maps, which are usually square, and which must be forced to mono.

DefDepthStencilSurfaceMode

Sets the default stereoization rendering mode for all depth surfaces (render targets): 0 = render according to Nvidia automatic 1 = render forcing this surface to be stereoized 2 = render forcing this surface to be monoscopic This can be overridden by individual surface declaration in the DX9Settings.ini file in sections labelled "[SFn]", where n is a number.

DefSurfaceCreationMode

Sets the default stereoization rendering mode for all surfaces (except non-texture render targets): 0 = render according to Nvidia automatic 1 = render forcing this surface to be stereoized 2 = render forcing this surface to be monoscopic This can be overridden by individual surface declaration in the DX9Settings.ini file in sections labelled "[SFn]", where n is a number.

DefRtCreationMode

Sets the default stereoization rendering mode for all non-square render targets: 0 = render according to Nvidia automatic 1 = render forcing this surface to be stereoized 2 = render forcing this surface to be monoscopic

Default rendering mode for square render targets are instead set by DefSquareSurfaceMode, and individual render targets may be overridden in "[RTn]" sections.

SurfaceCreationModeList

Defines a list of of which surface properties defined in the DX9Settings.ini to load in an use for override purposes in sections labelled [SFn], where n is one of the list values. Usage: SurfaceCreationModeList = 0;2;3; Note - you must use ";" and you must have a ";" at the end of the list.

RtCreationModeList

This is like "SurfaceCreationModeList" but for render targets. Individual settings are defined in sections labelled [RTn], where n is one of the list values.

DepthStencilSurfaceModeList

Same as "SurfaceCreationModeList", but for all depth surfaces. Individual settings are defined in sections labelled [DSn], where n is one of the list values.

SkipSetScissorRect

This is set to either true or false. It is best to always default this to "true". It instructs the renderer to ignore (when it can) the application of a feature that tries to save memory by using a stencil cutout to limit the area that needs rendering. In 3D this leads to issues with parts of an object or effect being "cut-off" at the edges. It is not possible to always fix this in all games though.

OverrideMethod

Can have values of 0,1 or 2. It is unknown exactly what these are doing, and for most games it does not matter which one is used, but if any given game there seems to be an issue loading in shader fixes (e.g. if you press F10 and nothing happens), cycle through the options. The value of 2 seems to have been added to cater for preshaders. In this case you should be able to to just comment out the preshader sections in a shader. It is not clear if this always works.

GetCurDirAtLoad

Set to true if you want to force the dll to look in the game exe dir (where the dll is) for the settings file, shader folders etc. Set to false otherwise. Exists because some games get linked to the parent directory etc to look for shader folders. Mostly seems to work, and is a good default option.

UseExtInterfaceOnly

This can be either true or false. ExtInterface is an internal programmatic thing with an "extended" set of capabilities that some newer games require. It is unclear when you would know to use this option, however it is known to be necessary for newer Telltale games such as Wolf Among Us and Walking Dead.

PSPREVKEY

DEBUG DLL ONLY - Defines which key cycles backwards through pixel shaders

Default Value: Numpad 1

PSNEXTKEY

DEBUG DLL ONLY - Defines which key cycles forwards through pixel shaders

Default Value: Numpad 2

PSSAVEKEY

DEBUG DLL ONLY - Defines which key dumps the currently disabled pixel shader to a file

Default Value: Numpad 3

VSPREVKEY

DEBUG DLL ONLY - Defines which key cycles backwards through vertex shaders

Default Value: Numpad 4

VSNEXTKEY

DEBUG DLL ONLY - Defines which key cycles forwards through vertex shaders

Default Value: Numpad 5

VSSAVEKEY

DEBUG DLL ONLY - Defines which key dumps the currently disabled vertex shader to a file

Default Value: Numpad 6

PSADDTOSKIPLSTKEY

DEBUG DLL ONLY - Add the currently disabled pixel shader to the skip list, to allow multiple shaders to be disabled simultaneously

Default Value: Numpad 7

PSRMFROMSKIPLSTKEY

DEBUG DLL ONLY - Remove the currently selected pixel shader from the skip list

Default Value: Numpad 8

PSCLRSKIPLSTKEY

DEBUG DLL ONLY - Remove all pixel shaders from the skip list

Default Value: Numpad 9

VSADDTOSKIPLSTKEY

DEBUG DLL ONLY - Add the currently disabled vertex shader to the skip list, to allow multiple shaders to be disabled simultaneously

Default Value: Home

VSRMFROMSKIPLSTKEY

DEBUG DLL ONLY - Remove the currently selected vertex shader from the skip list

Default Value: End

VSCLRSKIPLSTKEY

DEBUG DLL ONLY - Remove all vertex shaders from the skip list

Default Value: Insert

RELOADSHADERSKEY

DEBUG DLL ONLY - Defines which key reloads the shaders from the ShaderOverrides directory.

Note: Shaders must have been succesfully overridden at launch for the reload to work, therefore it is a good idea to start the game with known working shaders if you intend to edit them while the game is running

Default Value: F10

SHOWTEXTKEY

DEBUG DLL ONLY - Toggles the red debug text on and off

Default Value: Pause

SaveTextureLogKey

This key does several things:

- Writes out TEXTURESLOG.txt, which can be used to find texture CRCs, as well as other information about the vertex buffers passed to the shader. In order to have useful information in the log, you need [VSnnnnnnnn] and [VBnnnnnnnn.m] sections for a shader, with at least: 

   [VSnnnnnnnn]
   CheckTexCRC = true
   VBOffsetList = 0;
   
   [VBnnnnnnnn.0]


- If GetSamplerNFromReg is enabled on a shader, pressing this key will also save the texture captured from that sampler to TexN.dds.

- If MakeWTexture=true this will also save out Depth.dds, but so far I've only ended up with a blank texture.

Note that these DDS files may not be readable by all tools, depending on what format (fourCC) the texture is in and what formats the tools support.

If you get a crash when pressing this key, it may be due to a conflict with the screenshot feature of the Steam overlay. Remap one of the two functions to a different button, or kill the steam overlay.

Default Value: F12

SaveSettingsKey

Defines which key re-writes DX9Settings.ini with custom convergence and separation settings to the active preset.

Must have UseSepSettings = true and SaveSepSettings = true in a preset to be useful.

CAUTION: Comments are removed from the ini when this key is pressed!

Default Value: F7

GameProfile

Set the default stereo profile for the game. Set to the name of the executable in the desired profile, not the name of the profile.

This is useful to automate selecting an alternate stereo profile to enable various stereo tweaks in the driver, but should be considered potentially unreliable. If a game is already assigned to a profile this will be ignored, and further - a game can become assigned to a profile at any time (e.g. this happens when using Ctrl+F7 to save convergence settings) and may lose the desired settings from this profile.

Notably, the setting to enable stereo in windowed mode for DX9 titles seems to be preserved even if a profile is created with Ctrl+F7, so it seems safe to use for that purpose. I recommend using the "3D-Hub Player" profile for that purpose, as in:

GameProfile = fxdplayer

UNKNOWN FEATURES

These features have been discovered in Helix Mod, but need further testing to determine how and if they work. Please edit the page if you can fill in more details about them.

TexToMonoKey

Uncertain. Force the currently selected texture to mono?

Default Value: U

TexToStereoKey

Uncertain. Force the currently selected texture to stereo?

Default Value: I

DefPSIdxConst

Unknown. Probably defines which constant register the pixel shader index can be read from?

Default Value: 222

DefVSIdxConst

Unknown. Probably defines which constant register the vertexshader index can be read from?

Default Value: 222

DepthForceWidth

Type: Integer

DepthForceHeight

Type: Integer

ForceWidth

Type: Integer

ForceHeight

Type: Integer

BehaviourFlags

Type: Integer

UseAsm

Type: Boolean

StartDump

Type: Boolean

CalcMatrixOncePerFrame

Type: Boolean

CalcTexCRCatUpdate

Type: Boolean

MakeWTexture

Appears to create a depth texture that can be passed into shaders. I have successfully injected it to a shader, but it was blank. The texture can be dumped out with F12 as Depth.dds.

Type: Boolean

CheckDepthResolution

Type: Boolean

DepthWFormat

The FourCC format of the depth texture created if MakeWTexture=true?

Type: Integer

DepthGetDepthResFrom

Somehow related to MakeWTexture. At least 0, 1 and 2 appear to be valid values, possibly others.

Type: Integer

DeptIsNilReg

Unknown. Seems to define a constant register which can be used to query if the depth render target has been used (?). Appears to be related to MakeWTexture and DepthWRT. The x component is initially set to 1 and will be set to 0 when the depth texture created with MakeWTexture is first set as a render target. The register is never set back to 1.

Note the misspelling of Depth as Dept.

Type: Integer (-1 is disabled, valid values are unknown)

ClearShaders

Appears to change what Helix mod does on device reset.

Type: Integer (1 to enable, "true" will not work)

ForceRefRate

Type: Boolean

ResetCRCatReload

Type: Boolean

ReloadTexturesListKey

Default Value: F8

[KEY*]

Replace * with a number. These sections are used to activate presets when pressing or holding various keys or mouse buttons.

Note that you must include all of these sections in the PresetsKeysList under [General] otherwise they will be ignored by HelixMod. For instance, if you have defined sections for [KEY1], [KEY3] and [KEY7], then you must set PresetsKeysList = 1;3;7;

Key

This specifies the keycode in decimal.

Microsoft virtual keycodes for Key= use. Especially helpful for those odd keys like Insert, or Pause or F-Keys or Numpad. Must be converted from Hexadecimal to Decimal: http://msdn.microsoft.com/en-us/library/ms927178.aspx

ASCII table for normal keyboard keys. Use the Dec column: http://www.asciitable.com/

501 is the right mouse button, which is useful to switch presets while holding aim in some games.

Type

Type=1 will activate when the key is pressed down.

Type=2 is momentary - it will activate the first preset when the key is pressed down, and the second preset when the key is released.

Presets

This specifies which PRES* sections are activated by this key.

Each number in this list should end with a semicolon, including the last one.

Note that the order in this list is unimportant, however the numerical value of each of the presets does!

For type 2 keys, there should be exactly two entries in the list - the lower numbered entry will be activated while the button is held and the higher numbered entry will be activated when the button is released.

For type 1 keys you can have one or more entries in this list. If you have more than one entry it will cycle through each of them in numerical order when the key is pressed, wrapping back to the first after the last one. A list of two presets would toggle between each of them.

Delay

Defines an optional delay in milliseconds before the next preset will be activated.

Only seems to affect the 'to' and not the 'from' when using Type=2

[PRES*]

Replace * with a number. These sections define various presets that can be activated with key presses.

These sections should be referenced from the Presets list in at least one KEY* section.

Const1, Const2, Const3, Const4, Const5, Const6, Const7, & Const8

Each of these can be used to set a value that can be accessed from shaders through the c register defined by DefVSConst1 and DefPSConst1 (or DefVSConst2/DefPSConst2). The first four of these make up the x, y, z and w values of a single c register. The notation is confusing, as Const2 will be the y value of DefVSConst1.

As an example: 

DefVSConst1 = 240
Const1 = 240.x
Const2 = 240.y
Const3 = 240.z
Const4 = 240.w
DefVSConst2 = 241
Const5 = 241.x
Const6 = 241.y
Const7 = 241.z
Const8 = 241.w

These must be specified in hex (see below).

UseByDef

If true, this preset will be activated when the game is started.

If this preset can also be activated via a key press, it is recommended to make the numerically highest preset associated with that key the default. Otherwise the first time the key is pressed it may not appear to do anything as it activated the already active preset.

UseByDef can be set on multiple presets. This is useful if you have several independent preset groups - e.g. one group to control the convergence settings, and another to select different UI depths.

UseSepSettings

Set to true to allow this preset to change the separation and/or convergence settings.

SaveSepSettings

Set to true to allow custom separation & convergence settings to be saved in this preset.

To use it the preset must be activated in the game (UseByDef=true does not seem to be sufficient) while the user adjusts their settings via the normal keybindings for the driver. With the preset still active they then press F7 (not to be confused with Ctrl+F7) which will cause HelixMod to write the new settings to DX9Settings.ini

CAUTION: Pressing F7 will strip all comments from DX9Settings.ini!

Separation

Set a custom separation value between 0.0 and 100.0 when this preset is activated. You must also set UseSepSettings=true for this to work. The value must be specified in hex (see below).

Convergence

Set a custom convergence value when this preset is activated. You must also set UseSepSettings=true for this to work. The value must be specified in hex (see below).

[VSnnnnnnnn]

These sections define custom settings for specific vertex shaders. Replace nnnnnnnn with the 8 digit CRC32 of the vertex shader.

CheckTexCRC

Set to true to enable filtering by the textures in the DefinedTexturesVS list of this shader.

DefinedTexturesVS

Requires CheckTexCRC = true

List the texture CRCs to filter on in this shader. Note that there are several ways you can filter, refer to UseDefinedOnly and TexCounterReg for more details.

UseDefinedOnly

If this is true (default), the shader will only have a valid stereo sampler when a texture in DefinedTexturesVS is in use, otherwise the stereo texture won't exist, effectively setting separation & convergence to 0 in the shader.

Set this to false to always use the stereo sampler, to allow for more advanced filtering in the shader.

TexCounterReg

This defines a constant register with an X component that can be tested in the shader to determine whether a texure in DefinedTexturesVS is in use, and possibly which one. If using this you will almost certainly want to set UseDefinedOnly = false as well.

e.g. TexCounterReg = 251 will allow you to test c251.x in the shader.

Set ValForDefined and ValNotDefined to distinct values for simple cases where you need to filter based on the texture being in the list, or not in the list.

If you need to know precisely which texture is in use, add [TEXnnnnnnnn] sections for the relevant texture CRCs and set index to a value in those sections. That index value will be accessible through TexCounterReg. You can use this in conjunction with ValForDefined/ValNotDefined to set a default value, and have specific textures override this with a different value.

ValForDefined

This will set the default value of the constant defined by TexCounterReg when the texture is in the DefinedTexturesVS list.

May be overridden by the index setting in a [TEXnnnnnnnn] section for a specific texture.

ValNotDefined

This will set the value of the constant defined by TexCounterReg when the texture is NOT in the DefinedTexturesVS list.

UseMatrix, UseMatrix1

Either "true" or "False".

Specifies whether this VS will re-use a matrix from another shader.

MatrixReg, MatrixReg1

Usage MatrixReg = nnn

where nnn is the register for a matrix that was specified in another shader subsection using the "GetMatrixFromReg" field. Note that this "get" statement can be in the same shader, it does not have to be a different shader - this is required if you want the inverse of a matrix.

GetMatrixFromReg, GetMatrixFromReg1

Usage: GetMatrixFromReg = nnn

Sets the matrix with register nnn in *this* shader to be a re-usable constant register in all other shaders (including itself).

InverseMatrix, InverseMatrix1

This is either true or false.

If true then the matrix specified in "MatrixReg" will actually be the inverse of the matrix that was re-used.

DoubleInverseMatrix, DoubleInverseMatrix1

This is either true or false.

If true then a *Second* register is created 4 values higher than the first one defined in "MatrixReg" which stores the Inverse of the Inverse i.e. gets back to the original matrix that was shared in the first place. This might seem odd but it provides significantly better numerical stability. An example would be that a shader "shares' its matrix that was in register 8. This is then set to register 200 in the shader that is reusing it. If both matrix inverse settings are true, the registers will be as follows: 200, 201, 202, 203 will have the inverse matrix; 204, 205, 206, 207 will have the original matrix.

GetSampler1FromReg, GetSampler2FromReg, GetSampler3FromReg

This allows a sampler from this shader to be reused in a different shader.

SetSampler1ToReg, SetSampler2ToReg, SetSampler3ToReg

This allows a sampler that has been shared in another shader to be reused in this shader.

Usage: SetSampler1ToReg = 10

This will mean that in this shader, there will be accessible a sampler "s10" that can be used as if it was defined in the shader itself.

SetConst1ToReg, SetConst2ToReg, SetConst3ToReg

This allows a Constant (4-component) register that has been shared in another shader via GetConstNFromReg to be reused in this shader.

Usage: SetConst1ToReg = 10

This will mean that in this shader, there will be accessible a constant "c10" that can be used as if it was defined in the shader itself.

GetConst1FromReg, GetConst2FromReg, GetConst3FromReg

These allow up to three constant registers defined in this shader to be re-used in other shaders.

Usage: GetConst1FromReg = 123

This means that the register c123 will be made available to other shaders, and identified as accessed using the "SetConst1ToReg" field.

ResetConst1AfterSet, ResetConst2AfterSet, ResetConst3AfterSet

WARNING: Setting these may cause the relevant constant to always be 0 (possibly dependent on the scene draw order), as the reset flag doesn't get cleared after the first successful SetConstNToReg (confirmed in World of Diving).

After a constant copied from another shader has been set, this will clear it (set to 0) on the next DirectX Present call, effectively making them only have a non-zero value while the shader they were copied from is active in the scene.

An alternative method to determine if a constant is currently valid, is to use PresIndex in the shader(s) it was taken from to set a ConstN register to 1.0 which can be tested in the destination shader(s). This has been used in the World of Diving fix to determine if the projection matrix is available, or must be calculated from the inverse model-view and model-view-projection matrices.

MousePosReg

Specifies a constant register to store the X and Y coordinates of the mouse.

The coordinates are scaled too high and need to be divided by 1000, e.g: 

[VS12345678]
MousePosReg = 210

ShaderOverride\VertexShaders\12345678.txt:
def c220, 0, 0, 0.0625, 0.001
...
mov r13.xy, c210.xy
mul r13.xy, r13.xy, c220.ww

InitMouse must be true (or not specified) for this to work.

NOTE: It may not work when the game is first launched - if it doesn't work alt+tab out of the game and back in.

NOTE: This will only work in games that do not grab the mouse.

NOTE: This only works in vertex shaders. If you need it in a pixel shader, you will have to pass it from the vertex shader as an additional output.

WARNING: It appears that in some games this can get out of sync with the real mouse position by moving it to the edge of the screen.

DefVSSampler

Used to override the global DefVSSampler in this vertex shader. Add 257 to the sampler number - e.g. DefVSSampler = 260 will use s3 in this shader.

DefVSViewSizeConst

Used to override the global DefVSViewSizeConst in this vertex shader.

DefVSIdxConst

Used to override the global DefVSIdxConst in this shader.

PresetConst1

Used to override DefVSConst1 in this shader (unconfirmed)

PresetConst2

Used to override DefVSConst2 in this shader (unconfirmed)

PresIndex

Used to activate a preset while this shader is active in the scene (unconfirmed). Note that this is in *DECIMAL*, but the [PRES%X] sections are in *HEXADECIMAL*, so these will need to be converted for values above 9.

DepthWReg

Defines the sampler register to inject the depth texture created with MakeWTexture = true. Add 257 to the sampler number.

Note: I have only managed to inject a blank texture with this so far, it is unknown how to get this to work. Further analysis suggests that DepthWRT must be set for this to work.

DepthWRT

Unknown. Possibly related to MakeWTexture and DepthWReg? Appears to set a render target index to be used for the depth texture, and likely necessary to make it work.

Sampler1RTType, Sampler2RTType, Sampler3RTType

Unknown. Presumably related to GetSamplerNFromReg

S1TexW, S1TexH, S2TexW, S2TexH, S3TexW, S3TexH

Unknown. Presumably related to the width & height of the textures copied with GetSamplerNFromReg

DefStage

Appears to affect which surface level (mip-map?) of a texture is used for the CRC calculation (unconfirmed).

VBOffsetList

Exact meaning uncertain, but necessary to use the [VBnnnnnnnn.m] sections to work with vertex buffers (inputs to vertex shaders) - Fill this list out with all values of m you need.

Usage: VBOffsetList = 0;1;

FirstVertexPosReg

Unconfirmed: Stores the contents of the first entry of the vertex buffer in this constant register. Probably needs a VBOffsetList = 0; and a (possibly empty) [VBnnnnnnnn.0] to work.

FirstTexVertexPosReg

GetVertex

UseAsm

GetMatrixTexFromReg

MatrixTexReg

[VBnnnnnnnn.m]

This is of the form [VBnnnnnnnn.m], where the "m" relates to the value set in the "VBOffsetList" field of the related [VSnnnnnnnn] section. The way textures are stored and accessed is through Vertex Buffers, which are lists. No one really knows how this works, but it is the syntax that is necessary for it to work.

PointsList

Set to a numeric value. Currently believed only to be a way to identify this override operation in the LOG and/or textures.log files.

Usage: "PointsList = 554" OR "PointsList = 3E8B0000"

GroupsList

It is unknown what this does, but it appears to be related to the [GPnnnnnnnn] sections.

Offset

IsDisabledList

StartResW

StartResH

EndResW

EndResH

GetVertex

CompareType

[TEXnnnnnnnn]

Used to identify one of the textures by the 8-digit CRC specified in the "DefinedTexturesVS" list for a vertex shader.

PresIndex

Usage: PresIndex = 8

Used to specify a particular preset index that is to be activated when the given texture is active. Its used for things like setting automatic convergence in different games scenes.

NOTE: PresIndex is in *DECIMAL*, but the [PRES%X] sections are in *HEXADECIMAL*, so if you are using a preset number above 9 you will need to convert them. e.g. PresIndex = 512 will match [PRES200].

Index

This replaces the value of the register defined by TexCounterReg in a [VSnnnnnnnn] section. It is used when a shader needs to know when a specific texture is in use.

Usage: Index = n

VBOffsetList

Usage: VBOffsetList = 0;

[PTnnnnnnnn]

Used to identify one of the points lists (?) by the 8-digit CRC. It is unknown where this information comes from.

PresIndex

Usage: PresIndex = 8

Used to specify a particular preset index that is to be activated when the given point list is active. Its used for things like setting automatic convergence in different games scenes.

NOTE: PresIndex is in *DECIMAL*, but the [PRES%X] sections are in *HEXADECIMAL*, so if you are using a preset number above 9 you will need to convert them. e.g. PresIndex = 512 will match [PRES200].

AddOffset

AddPoint

GetVertex

Unknown, but as a side effect it looks like the LOG.txt may print out a 'SecName4: PTnnnnnnn' for this section if this is true.

[GPnnnnnnnn]

Appears to be related to group lists. It is unknown how this works. Appears to support the following options, which seem to be similar to the standard ConstN options supported by Helix Mod, but are completely independent. Possibly provides a means for a shader to distinguish between different objects being drawn?

  • Def1Val
  • Def2Val
  • Const1Reg
  • Const2Reg
  • Const1X
  • Const1Y
  • Const1Z
  • Const1W
  • Const2X
  • Const2Y
  • Const2Z
  • Const2W

[PSnnnnnnnn]

These sections define custom settings for specific pixel shaders. Replace nnnnnnnn with the 8 digit CRC32 of the pixel shader.

UseMatrix

Either "true" or "False".

Specifies whether this VS will re-use a matrix from another shader.

MatrixReg

Usage MatrixReg = nnn

where nnn is the register for a matrix that was specified in another shader subsection using the "GetMatrixFromReg" field. Note that this "get" statement can be in the same shader, it does not have to be a different shader - this is required if you want the inverse of a matrix.

GetMatrixFromReg

Usage: GetMatrixFromReg = nnn

Sets the matrix with register nnn in *this* shader to be a re-usable constant register in all other shaders (including itself).

InverseMatrix

This is either true or false.

If true then the matrix specified in "MatrixReg" will actually be the inverse of the matrix that was re-used.

DoubleInverseMatrix

This is either true or false.

If true then a *Second* register is created 4 values higher than the first one defined in "MatrixReg" which stores the Inverse of the Inverse i.e. gets back to the original matrix that was shared in the first place. This might seem odd but it provides significantly better numerical stability. An example would be that a shader "shares' its matrix that was in register 8. This is then set to register 200 in the shader that is reusing it. If both matrix inverse settings are true, the registers will be as follows: 200, 201, 202, 203 will have the inverse matrix; 204, 205, 206, 207 will have the original matrix.

GetSampler1FromReg, GetSampler2FromReg, GetSampler3FromReg

This allows a sampler register defined in this shader to be re-used in other shaders.

Usage: GetSampler1FromReg = 12

This means that the sampler s12 will be made available to other shaders, and identified as accessed using the "SetSampler1ToReg" field.

The texture on these captured samplers can be dumped out by pressing the key assigned to SaveTextureLogKey (default F12) as Tex1.dds, Tex2.dds and Tex3.dds.

SetSampler1ToReg, SetSampler2ToReg, SetSampler3ToReg

This allows a sampler that has been shared in another shader to be reused in this shader.

Usage: SetSampler1ToReg = 10

This will mean that in this shader, there will be accessible a sampler "s10" that can be used as if it was defined in the shader itself.

SetConst1ToReg, SetConst2ToReg, SetConst3ToReg

This allows a Constant (4-component) register that has been shared in another shader to be reused in this shader.

Usage: SetConst1ToReg = 10

This will mean that in this shader, there will be accessible a constant "c10" that can be used as if it was defined in the shader itself.

GetConst1FromReg, GetConst2FromReg, GetConst3FromReg

This allows a constant register defined in this shader to be re-used in other shaders.

Usage: GetConst1FromReg = 123

This means that the register c123 will be made available to other shaders, and identified as accessed using the "SetConst1ToReg" field.

[SFn]

These are individual sections that define a set of characteristics for different surfaces (except non-texture render targets) which thus specifies a subset of all of the currently created surfaces, and then defines the stereo render mode for this subset of surfaces. There are a number of fields that can be set, and the more that are set, the more tightly defined and specific (and smaller) the subset of surfaces will be that are affected by the stereo setting. The information for these surfaces comes from the LOG.txt file - look for lines starting with D3DUSAGE_RENDERTARGET/D3DUSAGE_DEPTHSTENCIL. The value of "n" is an integer from 0 - 9. The question immediately arises as to how on earth you know what surfaces are doing what. Bascially you don't, so you usually just need to systematically go through all (unique) surfaces listed in the LOG.txt file, setting the DefMode parameter to 0 and 1 and see what happens. That being said, if you read up on MSDN, the "Format" field can be used to work out what type of effect/operation is being done i.e. some formats are used for depth surfaces, some for lights, some for water etc. There is also information on the resolutions that are common for different effects (though games with multiple quality levels may have different resolutions, and also if you change the game resolution you may need to cover more etc). On the whole though this is a bit of a grind with some guesswork.

These sections must be referred to from the SurfaceCreationModeList or they will not be processed.

DefMode

This is the stereoization mode to apply to all surfaces that meet the criteria specified for this surface:

0 = render according to Nvidia automatic

1 = render forcing this surface to be stereoized

2 = render forcing this surface to be monoscopic

Format

This refers to the format of the surface and how the different components are encoded. You don't need to know this, the LOG.txt file will specify what the format is for each surface created. You can find out what the different codes mean by looking on MSDN. Usege: "Format = 21"

Usage

This parameter is also identified for a given surface in the LOG.txt file. It refers to whether a given surface is used as a depth buffer or not.

Height

The height of the particular surface in pixels.

Width

The width of the particular surface in pixels.

UseBackBufRes

This is either true or false and refers to setting the width and height to be that of the current back buffer.

Levels

Usage: Levels = 1

This parameter is also identified for a given surface in the LOG.txt file.

Pool

Usage: Pool = 0

This parameter is also identified for a given surface in the LOG.txt file.

UNKNOWN FEATURES

These features have been discovered, but need testing to determine how/if they work.

IndexList
ResStartWidth
ResStartHeight
ResEndWidth
ResEndHeight
ExceptSquare
ForceWidth
ForceHeight
IsDisabled

[RTn]

This is similar to [SFn], but for render targets rather than surfaces. These are individual sections that define a set of characteristics for different render targets which thus specifies a subset of all of the currently created render targets, and then defines the stereo render mode for this subset of render targets. There are a number of fields that can be set, and the more that are set, the more tightly defined and specific (and smaller) the subset of render targets will be that are affected by the stereo setting. The information for these surfaces comes from the LOG.txt file in lines starting with CreateRenderTarget. The value of "n" is an integer from 0 - 9. All fields are the same as for [SFn].

These sections must be referred to in the RTCreationModeList to be processed.

[DSn]

Similar to [SFn] and [RTn], but for depth stencil surfaces.

These sections must be referred to in the DepthStencilSurfaceModeList to be processed.

Hex to Float conversion

Several values in the ini file are floating point values that must be specified in hex. These include Separation, Convergence, Const1, Const2, Const3 and Const4.

You can use this online converter to convert between float and hex: http://gregstoll.dyndns.org/~gregstoll/floattohex/

Alternatively, if you prefer working in a command line environment, you might considder this Python script: https://raw.githubusercontent.com/DarkStarSword/3d-fixes/master/float_to_hex.py

List of features supported by HelixMod, and all versions available.

Horizontally across the top, we've got versions of the DLL, based on the mod-date found in the zip file. We are using the YYMMDD format.

Going down vertically, we have the different features that are available. Not all features are available or work in all DLLs.


Entries in the table are:

  • blank if untested or unknown to work.
  • OK if tested and known to work.
  • X if tested and known to fail.



140302 130906 130305 120401 120304
[General]
DumpAll OK OK OK OK X
UseRenderedShaders OK OK X X X
DefVSConst1 OK OK
DefPSConst1 OK OK
UseEndScene OK OK OK OK OK
DefPSSampler OK OK OK OK OK
DefVSSampler OK OK OK OK OK
bCalcTexCRCatStart OK OK OK X X
PresetsKeysList OK OK
Preset1Key X X OK OK
DefPSViewSizeConst OK
DefSquareSurfaceMode OK
DefDepthStencilSurfaceMode
DefSurfaceCreationMode OK
SkipSetScissorRect OK
DefRtCreationMode OK
RtCreationModeList
SurfaceCreationModeList OK
OverrideMethod OK
UseAlternateCRC
DefModuleName
InitMouse
ProxyLib
GetCurDirAtLoad
UseExtInterfaceOnly
[Preset1]
Convergence X X X OK OK
Separation X X X OK OK
UseSepSettings X X X OK OK
[KEY*]
Key OK OK
Presets OK OK
Type OK OK
Delay OK OK
[PRES*]
Const1 OK OK
UseByDef OK
Convergence OK
Separation OK
UseSepSettings OK
SaveSepSettings OK
[VSnnnnnnnn]
CheckTexCRC OK
VBOffsetList
ValForDefined OK
ValNotDefined OK
TexCounterReg OK
UseDefinedOnly OK
DefinedTexturesVS OK
SetSampler1ToReg
SetConst1ToReg
GetConst1FromReg
ResetConst1AfterSet
DefStage
FirstVertexPosReg
GetVertex
UseMatrix
MatrixReg
GetMatrixFromReg
InverseMatrix
DoubleInverseMatrix
MousePosReg OK
[VBnnnnnnnn.m]
PointsList
Offset
IsDisabledList
StartResW
StartResH
EndResW
EndResH
[TEXnnnnnnnn]
PresIndex
Index
VBOffsetList
[PSnnnnnnnn]
UseMatrix
MatrixReg
GetMatrixFromReg
InverseMatrix
DoubleInverseMatrix
GetSampler1FromReg
SetSampler1ToReg
GetConst1FromReg
[SFn]
DefMode
Format
Usage
Height
Width
UseBackBufRes
Levels
Pool
[RTn]
DefMode
Format
Usage
Height
Width
UseBackBufRes
Levels
Pool




Retrieved from "https://wiki.bo3b.net/index.php?title=HelixMod_Feature_List&oldid=536"