"""Build nx2navi_dlssg.dll (runtime/dlssg/nx2_sl.cpp, DLSS Frame Generation through NVIDIA Streamline) with MSVC.
python tools/build_dlssg.py --sl [--out build/dlssg]
python tools/build_dlssg.py --check
Streamline's C++ types have MSVC's ABI, so this one DLL is built with Visual Studio's compiler (the Build Tools are
enough; vswhere finds them), against the SDK's headers, which stay where they are. The Vulkan headers are MSYS2's.
A launcher release and the build kit ship the DLL ready-made beside Streamline's own runtime DLLs
(tools/make_launcher.py and tools/make_kit.py --dlssg, with the Streamline files tools/streamline_pin.py pins), and
tools/make_game.py place_dlssg puts them beside the game.
The built DLL must export every function runtime/dlssg/nx2_sl.h declares (each PFN_nx2sl_ is the export
nx2sl_), or the build fails naming the ones it lacks: the runtime takes a missing optional export for an older
DLL and leaves its feature out without an error. --check makes the same check of a DLL built before, such as the one
a release is about to ship.
"""
import argparse
import os
import re
import shutil
import struct
import subprocess
import sys
import tempfile
from pathlib import Path
ROOT = Path(__file__).resolve().parents[1]
HEADER = ROOT / 'runtime' / 'dlssg' / 'nx2_sl.h'
VSWHERE = Path(os.environ.get('ProgramFiles(x86)', r'C:\Program Files (x86)')) / 'Microsoft Visual Studio' / 'Installer' / 'vswhere.exe'
def vcvars():
if not VSWHERE.is_file():
sys.exit('Visual Studio (or its Build Tools) is not installed: vswhere.exe is missing')
path = subprocess.run([str(VSWHERE), '-latest', '-products', '*', '-requires',
'Microsoft.VisualStudio.Component.VC.Tools.x86.x64', '-property', 'installationPath'],
capture_output=True, text=True).stdout.strip()
bat = Path(path) / 'VC' / 'Auxiliary' / 'Build' / 'vcvars64.bat'
if not bat.is_file():
sys.exit(f'no vcvars64.bat under {path or "(no Visual Studio with the C++ tools)"}')
return bat
def declared_exports(header=HEADER):
"""The exports nx2_sl.h declares: nx2sl_ for each function pointer type PFN_nx2sl_."""
text = Path(header).read_text(encoding='utf-8')
return {'nx2sl_' + name for name in re.findall(r'\(\s*\*\s*PFN_nx2sl_(\w+)\s*\)', text)}
def pe_exports(path):
"""The names a PE file (PE32 or PE32+) exports: its export directory's name table. Empty without one."""
d = Path(path).read_bytes()
pe = struct.unpack_from('nul && cl /nologo /LD /O2 /EHsc /std:c++17 /W3 /DNOMINMAX /DWIN32_LEAN_AND_MEAN '
f'/I"{a.sl / "include"}" /I"{inc}" /I"{src.parent}" "{src}" /Fo"{a.out}\\\\" '
f'/Fe"{a.out / "nx2navi_dlssg.dll"}" /link /NOLOGO')
with tempfile.NamedTemporaryFile('w', suffix='.cmd', delete=False) as f:
# vcvars64.bat runs vswhere itself and needs it on PATH
f.write('@echo off\r\nset "PATH=%PATH%;' + str(VSWHERE.parent) + '"\r\n' + cmd + '\r\n')
script = f.name
try:
r = subprocess.run(['cmd', '/c', script])
finally:
os.unlink(script)
if r.returncode or not (a.out / 'nx2navi_dlssg.dll').is_file():
sys.exit(f'the build failed ({r.returncode})')
check(a.out / 'nx2navi_dlssg.dll')
print(a.out / 'nx2navi_dlssg.dll')
if __name__ == '__main__':
main()