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

Updated OOVPA sorting (markdown)

PatrickvL 2017-02-04 14:47:00 +01:00
parent 17874dc225
commit c0b43187c7
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
OOVPA-sorting.md

@ -17,30 +17,30 @@ The version argument must indicate the exact XDK version the OOVPA is based upon
The type argument forwards the declaration to type-specific macros, currently the possible types are: The type argument forwards the declaration to type-specific macros, currently the possible types are:
PATCH, for registering an OOVPA with a patch. `PATCH`, for registering an OOVPA with a patch.
LTCG, for registering a patch that originates from a (D3D) LTCG database. `LTCG`, for registering a patch that originates from a (D3D) LTCG database.
XREF, for registering an OOVPA without a patch. XREF, for registering an OOVPA without a patch.
DISABLED, used for experimentally disabling OOVPA xrefs or patches `DISABLED`, used for experimentally disabling OOVPA xrefs or patches
ALIAS, for using an alternative OOVPA definition, while keeping the same patch for the mentioned symbol. `ALIAS`, for using an alternative OOVPA definition, while keeping the same patch for the mentioned symbol.
(Registrations of type ALIAS require a fourth argument, being the name of the alternative OOVPA which must have an appendage to the base function name, like FunctionB) (Registrations of type ALIAS require a fourth argument, being the name of the alternative OOVPA which must have an appendage to the base function name, like FunctionB)
An alias OOVPA registration type is not the same as an OOVPA alias declaration. An alias OOVPA registration type is not the same as an OOVPA alias declaration.
An OOVPA alias declaration is simply one line, formed like this: An OOVPA alias declaration is simply one line, formed like this:
`
#define name_3 name_1 #define name_3 name_1
`
Where name is the OOVPA name, like D3D_CreateDevice Where name is the OOVPA name, like D3D_CreateDevice
Where 3 represents the new version for which the OOVPA must be used. Where 3 represents the new version for which the OOVPA must be used.
Where 1 represents the old OOVPA version to reuse. Where 1 represents the old OOVPA version to reuse.
An example: An example:
`
#define OOVPA_D3D_CreateDevice_5788 OOVPA_D3D_CreateDevice_4344 #define OOVPA_D3D_CreateDevice_5788 OOVPA_D3D_CreateDevice_4344
`
This introduces a new version 5788 OOVPA for D3D_CreateDevice, based on the 4344 version OOVPA for that same function. This introduces a new version 5788 OOVPA for D3D_CreateDevice, based on the 4344 version OOVPA for that same function.
Summarizing: Summarizing: