Windows-specific target settings. More...

Inheritance diagram for Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig:

Public Member Functions
virtual WindowsTargetRulesConfig	_2015 (bool present=true)
	Version of the compiler toolchain to use on Windows platform. A value of "default" will be changed to a specific version at UBT start up.

virtual WindowsTargetRulesConfig	_2017 (bool present=true)
	Version of the compiler toolchain to use on Windows platform. A value of "default" will be changed to a specific version at UBT start up.

virtual WindowsTargetRulesConfig	_2019 (bool present=true)
	Version of the compiler toolchain to use on Windows platform. A value of "default" will be changed to a specific version at UBT start up.

virtual WindowsTargetRulesConfig	_2022 (WindowsCompiler? val=null)
	Version of the compiler toolchain to use on Windows platform. A value of "default" will be changed to a specific version at UBT start up.

virtual WindowsTargetRulesConfig	Compiler (WindowsCompiler? val=null)
	Version of the compiler toolchain to use on Windows platform. A value of "default" will be changed to a specific version at UBT start up.

virtual WindowsTargetRulesConfig	CompilerVersion (object val=null)
	The specific toolchain version to use. This may be a specific version number (for example, "14.13.26128"), the string "Latest" to select the newest available version, or the string "Preview" to select the newest available preview version. By default, and if it is available, we use the toolchain version indicated by WindowsPlatform.DefaultToolChainVersion (otherwise, we use the latest version). The specific compiler version to use. This may be a specific version number (for example, "14.13.26128"), the string "Latest" to select the newest available version, or the string "Preview" to select the newest available preview version. By default, and if it is available, we use the toolchain version indicated by WindowsPlatform.DefaultToolChainVersion (otherwise, we use the latest version).

virtual WindowsTargetRulesConfig	StaticAnalyzer (WindowsStaticAnalyzer? val=null)
	The static analyzer to use. Whether static code analysis should be enabled.

virtual WindowsTargetRulesConfig	ObjSrcMap (object val=null)
	Whether we should export a file containing .obj to source file mappings.

virtual WindowsTargetRulesConfig	Strict (bool? val=null)
	Enables strict standard conformance mode (/permissive-) in VS2017+. Enables strict standard conformance mode (/permissive-).

virtual WindowsTargetRulesConfig	ShowIncludes (bool? val=null)
	Print out files that are included by each source file.

virtual WindowsTargetRulesConfig	StaticAnalyzerOutputType (WindowsStaticAnalyzerOutputType? val=null)
	The output type to use for the static analyzer. The output type to use for the static analyzer. This is only supported for Clang.

virtual WindowsTargetRulesConfig	EnableASan (bool? val=null)
	Enables address sanitizer (ASan). Only supported for Visual Studio 2019 16.7.0 and up.

virtual WindowsTargetRulesConfig	Deterministic (bool? val=null)
	Set flags require for determinstic compiles (experimental) Force set flags require for determinstic compiling and linking (experimental, may not be fully supported). This setting is only recommended for testing, instead:

virtual WindowsTargetRulesConfig	UpdatedCPPMacro (bool? val=null)
	Enables updated __cplusplus macro (/Zc:__cplusplus).

virtual WindowsTargetRulesConfig	StrictInline (bool? val=null)
	Enables inline conformance (Remove unreferenced COMDAT) (/Zc:inline).

virtual WindowsTargetRulesConfig	StrictPreprocessor (bool? val=null)
	Enables new preprocessor conformance (/Zc:preprocessor). Enables new preprocessor conformance (/Zc:preprocessor). This is always enabled for C++20 modules.

virtual WindowsTargetRulesConfig	StrictEnumTypes (bool? val=null)
	Enables enum types conformance (/Zc:enumTypes) in VS2022 17.4 Preview 4.0+.

virtual WindowsTargetRulesConfig	ClangLinker (bool? val=null)
	True if we should use the Clang linker (LLD) when we are compiling with Clang, or Intel linker (xilink\xilib) when we are compiling with Intel oneAPI, otherwise we use the MSVC linker. True if we should use the Clang linker (LLD) when we are compiling with Clang or Intel oneAPI, otherwise we use the MSVC linker.

virtual WindowsTargetRulesConfig	PGOFastGen (bool? val=null)
	If specified along with -PGOProfile, then /FASTGENPROFILE will be used instead of /GENPROFILE. This usually means that the PGO data is generated faster, but the resulting data may not yield as efficient optimizations during -PGOOptimize If specified along with -PGOProfile, then /FASTGENPROFILE will be used instead of /GENPROFILE. This usually means that the PGO data is generated faster, but the resulting data may not yield as efficient optimizations during -PGOOptimize.

virtual WindowsTargetRulesConfig	VCToolchain (WindowsCompiler? val=null)
	Version of the toolchain to use on Windows platform when a non-msvc Compiler is in use, to locate include paths etc.

virtual WindowsTargetRulesConfig	IgnoreStalePGOData (bool? val=null)
	If -PGOOptimize is specified but the linker flags have changed since the last -PGOProfile, this will emit a warning and build without PGO instead of failing during link with LNK1268.

virtual WindowsTargetRulesConfig	PGONoExtraCounters (bool? val=null)
	If specified along with -PGOProfile, prevent the usage of extra counters. Please note that by default /FASTGENPROFILE doesnt use extra counters.

virtual WindowsTargetRulesConfig	VCToolchainVersion (object val=null)
	The specific msvc toolchain version to use if the compiler is not msvc. This may be a specific version number (for example, "14.13.26128"), the string "Latest" to select the newest available version, or the string "Preview" to select the newest available preview version. By default, and if it is available, we use the toolchain version indicated by WindowsPlatform.DefaultToolChainVersion (otherwise, we use the latest version).

virtual WindowsTargetRulesConfig	VCFastFail (bool? val=null)
	True if /fastfail should be passed to the msvc compiler and linker.

virtual WindowsTargetRulesConfig	WindowsSDKVersion (object val=null)
	The specific Windows SDK version to use. This may be a specific version number (for example, "8.1", "10.0" or "10.0.10150.0"), or the string "Latest", to select the newest available version. By default, and if it is available, we use the Windows SDK version indicated by WindowsPlatform.DefaultWindowsSdkVersion (otherwise, we use the latest version).

virtual WindowsTargetRulesConfig	EnableLibFuzzer (bool? val=null)
	Enables LibFuzzer. Only supported for Visual Studio 2022 17.0.0 and up.

virtual WindowsTargetRulesConfig	Sarif (bool? val=null)
	Whether .sarif files containing errors and warnings are written alongside each .obj, if supported.

virtual WindowsTargetRulesConfig	PdbAltPath (object val=null)
	Specify an alternate location for the PDB file. This option does not change the location of the generated PDB file, it changes the name that is embedded into the executable. Path can contain _PDB% which will be expanded to the original PDB file name of the target, without the directory. See https://learn.microsoft.com/en-us/cpp/build/reference/pdbaltpath-use-alternate-pdb-path.

virtual WindowsTargetRulesConfig	SetResourceVersions (bool? val=null)
	If enabled will set the ProductVersion embeded in windows executables and dlls to contain BUILT_FROM_CHANGELIST and BuildVersion Enabled by default for all precompiled and Shipping configurations. Regardless of this setting, the versions from Build.version will be available via the BuildSettings module Note: Embedding these versions will cause resource files to be recompiled whenever changelist is updated which will cause binaries to relink.

virtual WindowsTargetRulesConfig	NoSetResourceVersions (bool present=true)
	If enabled will set the ProductVersion embeded in windows executables and dlls to contain BUILT_FROM_CHANGELIST and BuildVersion Enabled by default for all precompiled and Shipping configurations. Regardless of this setting, the versions from Build.version will be available via the BuildSettings module Note: Embedding these versions will cause resource files to be recompiled whenever changelist is updated which will cause binaries to relink.

virtual WindowsTargetRulesConfig	ToolchainVersionWarningLevel (WarningLevel? val=null)
	Warning level when reporting toolchains that are not in the preferred version list.

virtual WindowsTargetRulesConfig	SampleBasedPGO (bool? val=null)
	If specified along with -PGOProfile, use sample-based PGO instead of instrumented. Currently Intel oneAPI 2024.0+ only.

virtual WindowsTargetRulesConfig	VCExtendedWarningInfo (bool? val=null)
	True if /d2ExtendedWarningInfo should be passed to the compiler and /d2:-ExtendedWarningInfo to the linker.

virtual WindowsTargetRulesConfig	VCDisableExtendedWarningInfo (bool present=true)
	True if /d2ExtendedWarningInfo should be passed to the compiler and /d2:-ExtendedWarningInfo to the linker.

virtual WindowsTargetRulesConfig	ClangStandaloneDebug (bool? val=null)
	True if optimizations to reduce the size of debug information should be disabled See https://clang.llvm.org/docs/UsersManual.html#cmdoption-fstandalone-debug for more information True if optimizations to reduce the size of debug information should be disabled. Disabling this option can decrease pdb size but may degrade the debugging experience. See https://clang.llvm.org/docs/UsersManual.html#cmdoption-fstandalone-debug for more information.

virtual WindowsTargetRulesConfig	LinkRepro (object val=null)
	Whether to have the linker or library tool to generate a link repro in the specified directory See https://learn.microsoft.com/en-us/cpp/build/reference/linkrepro for more information.

virtual WindowsTargetRulesConfig	StripPrivateSymbols (bool? val=null)
	Whether to request the linker create a stripped pdb file as part of the build. If enabled the full debug pdb will have the extension .full.pdb.

virtual WindowsTargetRulesConfig	UseXCurl (bool? val=null)
	Whether this build will use Microsoft's custom XCurl instead of libcurl Note that XCurl is not part of the normal Windows SDK and will require additional downloads.

virtual WindowsTargetRulesConfig	DisableVolatileMetadata (bool? val=null)
	Volatile Metadata is enabled by default and improves x64 emulation on arm64, but may come at a small perfomance cost (/volatileMetadata-).

virtual WindowsTargetRulesConfig	PGOMergedPGD (object val=null)
	If specified along with -PGOOptimize, will use the specified per-merged pgd file instead of the usual pgd file with loose pgc files.

virtual WindowsTargetRulesConfig	NoClangLinker (bool present=true)
	True if we should use the Clang linker (LLD) when we are compiling with Clang or Intel oneAPI, otherwise we use the MSVC linker.

virtual WindowsTargetRulesConfig	StrictODR (bool? val=null)
	Enables enforcing standard C++ ODR violations (/Zc:checkGwOdr) in VS2022 17.5 Preview 2.0+.

virtual WindowsTargetRulesConfig	NoLinkerDebugInfo (bool? val=null)
	If you supply -NoDebugInfo, windows platforms still create debug info while linking. Set this to true to not create debug info while linking in this circumstance.

virtual WindowsTargetRulesConfig	DynamicDebugging (bool? val=null)
	If specificed Visual Studio Dynamic Debugging support will be enabled, unless the compiler or linker is not MSVC or LTCG is enabled.

virtual WindowsTargetRulesConfig	RadLinker (bool? val=null)
	True if we should use the Rad linker.

virtual WindowsTargetRulesConfig	EnableUBSan (bool? val=null)
	Enables undefined behavior sanitizer (UBSan)

virtual WindowsTargetRulesConfig	EnableInstrumentation (bool? val=null)
	Enables instrumentation.

virtual WindowsTargetRulesConfig	_2026 (WindowsCompiler? val=null)
	Version of the compiler toolchain to use on Windows platform. A value of "default" will be changed to a specific version at UBT start up.

virtual WindowsTargetRulesConfig	NoClangStandaloneDebug (bool present=true)
	True if optimizations to reduce the size of debug information should be disabled. Disabling this option can decrease pdb size but may degrade the debugging experience. See https://clang.llvm.org/docs/UsersManual.html#cmdoption-fstandalone-debug for more information.

Public Member Functions inherited from Nuke.Unreal.Tools.ToolConfig
virtual void	AppendArgument (UnrealToolArgument arg)

virtual void	AppendArgument (string arg, UnrealToolArgumentMeta? meta=null)

virtual void	AppendSubtool (ToolConfig subtool)

virtual string	Gather (EngineVersion ueVersion)
	Gether the arguments and subtools and render a command line output.

Properties
override string	Name `[get]`

override string	CliName `[get]`

override UnrealCompatibility	Compatibility `[get]`

override ToolConfig[]	Configs `[get]`

Properties inherited from Nuke.Unreal.Tools.ToolConfig
string	Name `[get]`
	The C# friendly name of the tool which will be used inside configurators.

string	CliName `[get]`
	The name which will be rendered onto command line.

UnrealCompatibility	Compatibility `[get]`
	Compatibility with either Unreal Engine 4 or 5 or both. If tool is configured to run with an incompatible engine its entire configuration will be ignored.

virtual ToolConfig[]	Configs `[get]`

Private Attributes
ToolConfig[]	_configs = null

Additional Inherited Members
Protected Attributes inherited from Nuke.Unreal.Tools.ToolConfig
List< UnrealToolArgument >	UsingArguments = []

readonly Dictionary< string, ToolConfig >	UsingSubtools = []

Detailed Description

Windows-specific target settings.

Definition at line 16501 of file UbtConfigGenerated.cs.

Member Function Documentation

◆ _2015()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig._2015 ( bool present = true )

virtual

Version of the compiler toolchain to use on Windows platform. A value of "default" will be changed to a specific version at UBT start up.

Definition at line 16510 of file UbtConfigGenerated.cs.

◆ _2017()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig._2017 ( bool present = true )

virtual

Version of the compiler toolchain to use on Windows platform. A value of "default" will be changed to a specific version at UBT start up.

Definition at line 16531 of file UbtConfigGenerated.cs.

◆ _2019()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig._2019 ( bool present = true )

virtual

Version of the compiler toolchain to use on Windows platform. A value of "default" will be changed to a specific version at UBT start up.

Definition at line 16552 of file UbtConfigGenerated.cs.

◆ _2022()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig._2022 ( WindowsCompiler? val = null )

virtual

Version of the compiler toolchain to use on Windows platform. A value of "default" will be changed to a specific version at UBT start up.

Definition at line 16573 of file UbtConfigGenerated.cs.

◆ _2026()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig._2026 ( WindowsCompiler? val = null )

virtual

Version of the compiler toolchain to use on Windows platform. A value of "default" will be changed to a specific version at UBT start up.

Definition at line 17515 of file UbtConfigGenerated.cs.

◆ ClangLinker()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.ClangLinker ( bool? val = null )

virtual

True if we should use the Clang linker (LLD) when we are compiling with Clang, or Intel linker (xilink\xilib) when we are compiling with Intel oneAPI, otherwise we use the MSVC linker. True if we should use the Clang linker (LLD) when we are compiling with Clang or Intel oneAPI, otherwise we use the MSVC linker.

Definition at line 16869 of file UbtConfigGenerated.cs.

◆ ClangStandaloneDebug()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.ClangStandaloneDebug ( bool? val = null )

virtual

True if optimizations to reduce the size of debug information should be disabled See https://clang.llvm.org/docs/UsersManual.html#cmdoption-fstandalone-debug for more information True if optimizations to reduce the size of debug information should be disabled. Disabling this option can decrease pdb size but may degrade the debugging experience. See https://clang.llvm.org/docs/UsersManual.html#cmdoption-fstandalone-debug for more information.

Definition at line 17239 of file UbtConfigGenerated.cs.

◆ Compiler()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.Compiler ( WindowsCompiler? val = null )

virtual

Version of the compiler toolchain to use on Windows platform. A value of "default" will be changed to a specific version at UBT start up.

Definition at line 16594 of file UbtConfigGenerated.cs.

◆ CompilerVersion()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.CompilerVersion ( object val = null )

virtual

The specific toolchain version to use. This may be a specific version number (for example, "14.13.26128"), the string "Latest" to select the newest available version, or the string "Preview" to select the newest available preview version. By default, and if it is available, we use the toolchain version indicated by WindowsPlatform.DefaultToolChainVersion (otherwise, we use the latest version). The specific compiler version to use. This may be a specific version number (for example, "14.13.26128"), the string "Latest" to select the newest available version, or the string "Preview" to select the newest available preview version. By default, and if it is available, we use the toolchain version indicated by WindowsPlatform.DefaultToolChainVersion (otherwise, we use the latest version).

Definition at line 16618 of file UbtConfigGenerated.cs.

◆ Deterministic()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.Deterministic ( bool? val = null )

virtual

Set flags require for determinstic compiles (experimental) Force set flags require for determinstic compiling and linking (experimental, may not be fully supported). This setting is only recommended for testing, instead:

Set bDeterministic on a per module basis in ModuleRules to control deterministic compiling.
Set bDeterministic on a per target basis in TargetRules to control deterministic linking. Set flags require for deterministic compiling and linking. Enabling deterministic mode for msvc disables codegen multithreading so compiling will be slower

Definition at line 16766 of file UbtConfigGenerated.cs.

◆ DisableVolatileMetadata()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.DisableVolatileMetadata ( bool? val = null )

virtual

Volatile Metadata is enabled by default and improves x64 emulation on arm64, but may come at a small perfomance cost (/volatileMetadata-).

Definition at line 17326 of file UbtConfigGenerated.cs.

◆ DynamicDebugging()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.DynamicDebugging ( bool? val = null )

virtual

If specificed Visual Studio Dynamic Debugging support will be enabled, unless the compiler or linker is not MSVC or LTCG is enabled.

Definition at line 17431 of file UbtConfigGenerated.cs.

◆ EnableASan()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.EnableASan ( bool? val = null )

virtual

Enables address sanitizer (ASan). Only supported for Visual Studio 2019 16.7.0 and up.

Definition at line 16741 of file UbtConfigGenerated.cs.

◆ EnableInstrumentation()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.EnableInstrumentation ( bool? val = null )

virtual

Enables instrumentation.

Definition at line 17494 of file UbtConfigGenerated.cs.

◆ EnableLibFuzzer()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.EnableLibFuzzer ( bool? val = null )

virtual

Enables LibFuzzer. Only supported for Visual Studio 2022 17.0.0 and up.

Definition at line 17041 of file UbtConfigGenerated.cs.

◆ EnableUBSan()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.EnableUBSan ( bool? val = null )

virtual

Enables undefined behavior sanitizer (UBSan)

Definition at line 17473 of file UbtConfigGenerated.cs.

◆ IgnoreStalePGOData()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.IgnoreStalePGOData ( bool? val = null )

virtual

If -PGOOptimize is specified but the linker flags have changed since the last -PGOProfile, this will emit a warning and build without PGO instead of failing during link with LNK1268.

Definition at line 16932 of file UbtConfigGenerated.cs.

◆ LinkRepro()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.LinkRepro ( object val = null )

virtual

Whether to have the linker or library tool to generate a link repro in the specified directory See https://learn.microsoft.com/en-us/cpp/build/reference/linkrepro for more information.

Definition at line 17261 of file UbtConfigGenerated.cs.

◆ NoClangLinker()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.NoClangLinker ( bool present = true )

virtual

True if we should use the Clang linker (LLD) when we are compiling with Clang or Intel oneAPI, otherwise we use the MSVC linker.

Definition at line 17368 of file UbtConfigGenerated.cs.

◆ NoClangStandaloneDebug()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.NoClangStandaloneDebug ( bool present = true )

virtual

True if optimizations to reduce the size of debug information should be disabled. Disabling this option can decrease pdb size but may degrade the debugging experience. See https://clang.llvm.org/docs/UsersManual.html#cmdoption-fstandalone-debug for more information.

Definition at line 17537 of file UbtConfigGenerated.cs.

◆ NoLinkerDebugInfo()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.NoLinkerDebugInfo ( bool? val = null )

virtual

If you supply -NoDebugInfo, windows platforms still create debug info while linking. Set this to true to not create debug info while linking in this circumstance.

Definition at line 17410 of file UbtConfigGenerated.cs.

◆ NoSetResourceVersions()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.NoSetResourceVersions ( bool present = true )

virtual

If enabled will set the ProductVersion embeded in windows executables and dlls to contain BUILT_FROM_CHANGELIST and BuildVersion Enabled by default for all precompiled and Shipping configurations. Regardless of this setting, the versions from Build.version will be available via the BuildSettings module Note: Embedding these versions will cause resource files to be recompiled whenever changelist is updated which will cause binaries to relink.

Definition at line 17132 of file UbtConfigGenerated.cs.

◆ ObjSrcMap()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.ObjSrcMap ( object val = null )

virtual

Whether we should export a file containing .obj to source file mappings.

Definition at line 16659 of file UbtConfigGenerated.cs.

◆ PdbAltPath()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.PdbAltPath ( object val = null )

virtual

Specify an alternate location for the PDB file. This option does not change the location of the generated PDB file, it changes the name that is embedded into the executable. Path can contain _PDB% which will be expanded to the original PDB file name of the target, without the directory. See https://learn.microsoft.com/en-us/cpp/build/reference/pdbaltpath-use-alternate-pdb-path.

Definition at line 17086 of file UbtConfigGenerated.cs.

◆ PGOFastGen()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.PGOFastGen ( bool? val = null )

virtual

If specified along with -PGOProfile, then /FASTGENPROFILE will be used instead of /GENPROFILE. This usually means that the PGO data is generated faster, but the resulting data may not yield as efficient optimizations during -PGOOptimize If specified along with -PGOProfile, then /FASTGENPROFILE will be used instead of /GENPROFILE. This usually means that the PGO data is generated faster, but the resulting data may not yield as efficient optimizations during -PGOOptimize.

Definition at line 16890 of file UbtConfigGenerated.cs.

◆ PGOMergedPGD()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.PGOMergedPGD ( object val = null )

virtual

If specified along with -PGOOptimize, will use the specified per-merged pgd file instead of the usual pgd file with loose pgc files.

Definition at line 17347 of file UbtConfigGenerated.cs.

◆ PGONoExtraCounters()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.PGONoExtraCounters ( bool? val = null )

virtual

If specified along with -PGOProfile, prevent the usage of extra counters. Please note that by default /FASTGENPROFILE doesnt use extra counters.

https://learn.microsoft.com/en-us/cpp/build/reference/genprofile-fastgenprofile-generate-profiling-instrumented-build

Definition at line 16954 of file UbtConfigGenerated.cs.

◆ RadLinker()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.RadLinker ( bool? val = null )

virtual

True if we should use the Rad linker.

Definition at line 17452 of file UbtConfigGenerated.cs.

◆ SampleBasedPGO()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.SampleBasedPGO ( bool? val = null )

virtual

If specified along with -PGOProfile, use sample-based PGO instead of instrumented. Currently Intel oneAPI 2024.0+ only.

Definition at line 17175 of file UbtConfigGenerated.cs.

◆ Sarif()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.Sarif ( bool? val = null )

virtual

Whether .sarif files containing errors and warnings are written alongside each .obj, if supported.

Definition at line 17062 of file UbtConfigGenerated.cs.

◆ SetResourceVersions()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.SetResourceVersions ( bool? val = null )

virtual

If enabled will set the ProductVersion embeded in windows executables and dlls to contain BUILT_FROM_CHANGELIST and BuildVersion Enabled by default for all precompiled and Shipping configurations. Regardless of this setting, the versions from Build.version will be available via the BuildSettings module Note: Embedding these versions will cause resource files to be recompiled whenever changelist is updated which will cause binaries to relink.

Definition at line 17109 of file UbtConfigGenerated.cs.

◆ ShowIncludes()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.ShowIncludes ( bool? val = null )

virtual

Print out files that are included by each source file.

Definition at line 16700 of file UbtConfigGenerated.cs.

◆ StaticAnalyzer()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.StaticAnalyzer ( WindowsStaticAnalyzer? val = null )

virtual

The static analyzer to use. Whether static code analysis should be enabled.

Definition at line 16638 of file UbtConfigGenerated.cs.

◆ StaticAnalyzerOutputType()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.StaticAnalyzerOutputType ( WindowsStaticAnalyzerOutputType? val = null )

virtual

The output type to use for the static analyzer. The output type to use for the static analyzer. This is only supported for Clang.

Definition at line 16720 of file UbtConfigGenerated.cs.

◆ Strict()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.Strict ( bool? val = null )

virtual

Enables strict standard conformance mode (/permissive-) in VS2017+. Enables strict standard conformance mode (/permissive-).

Definition at line 16679 of file UbtConfigGenerated.cs.

◆ StrictEnumTypes()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.StrictEnumTypes ( bool? val = null )

virtual

Enables enum types conformance (/Zc:enumTypes) in VS2022 17.4 Preview 4.0+.

Definition at line 16849 of file UbtConfigGenerated.cs.

◆ StrictInline()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.StrictInline ( bool? val = null )

virtual

Enables inline conformance (Remove unreferenced COMDAT) (/Zc:inline).

Definition at line 16808 of file UbtConfigGenerated.cs.

◆ StrictODR()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.StrictODR ( bool? val = null )

virtual

Enables enforcing standard C++ ODR violations (/Zc:checkGwOdr) in VS2022 17.5 Preview 2.0+.

Definition at line 17389 of file UbtConfigGenerated.cs.

◆ StrictPreprocessor()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.StrictPreprocessor ( bool? val = null )

virtual

Enables new preprocessor conformance (/Zc:preprocessor). Enables new preprocessor conformance (/Zc:preprocessor). This is always enabled for C++20 modules.

Definition at line 16828 of file UbtConfigGenerated.cs.

◆ StripPrivateSymbols()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.StripPrivateSymbols ( bool? val = null )

virtual

Whether to request the linker create a stripped pdb file as part of the build. If enabled the full debug pdb will have the extension .full.pdb.

Definition at line 17283 of file UbtConfigGenerated.cs.

◆ ToolchainVersionWarningLevel()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.ToolchainVersionWarningLevel ( WarningLevel? val = null )

virtual

Warning level when reporting toolchains that are not in the preferred version list.

See also: MicrosoftPlatformSDK.PreferredVisualCppVersions

Definition at line 17154 of file UbtConfigGenerated.cs.

◆ UpdatedCPPMacro()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.UpdatedCPPMacro ( bool? val = null )

virtual

Enables updated __cplusplus macro (/Zc:__cplusplus).

Definition at line 16787 of file UbtConfigGenerated.cs.

◆ UseXCurl()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.UseXCurl ( bool? val = null )

virtual

Whether this build will use Microsoft's custom XCurl instead of libcurl Note that XCurl is not part of the normal Windows SDK and will require additional downloads.

Definition at line 17305 of file UbtConfigGenerated.cs.

◆ VCDisableExtendedWarningInfo()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.VCDisableExtendedWarningInfo ( bool present = true )

virtual

True if /d2ExtendedWarningInfo should be passed to the compiler and /d2:-ExtendedWarningInfo to the linker.

Definition at line 17217 of file UbtConfigGenerated.cs.

◆ VCExtendedWarningInfo()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.VCExtendedWarningInfo ( bool? val = null )

virtual

True if /d2ExtendedWarningInfo should be passed to the compiler and /d2:-ExtendedWarningInfo to the linker.

Definition at line 17196 of file UbtConfigGenerated.cs.

◆ VCFastFail()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.VCFastFail ( bool? val = null )

virtual

True if /fastfail should be passed to the msvc compiler and linker.

Definition at line 16998 of file UbtConfigGenerated.cs.

◆ VCToolchain()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.VCToolchain ( WindowsCompiler? val = null )

virtual

Version of the toolchain to use on Windows platform when a non-msvc Compiler is in use, to locate include paths etc.

Definition at line 16911 of file UbtConfigGenerated.cs.

◆ VCToolchainVersion()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.VCToolchainVersion ( object val = null )

virtual

The specific msvc toolchain version to use if the compiler is not msvc. This may be a specific version number (for example, "14.13.26128"), the string "Latest" to select the newest available version, or the string "Preview" to select the newest available preview version. By default, and if it is available, we use the toolchain version indicated by WindowsPlatform.DefaultToolChainVersion (otherwise, we use the latest version).

Definition at line 16977 of file UbtConfigGenerated.cs.

◆ WindowsSDKVersion()

virtual WindowsTargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.WindowsSDKVersion ( object val = null )

virtual

The specific Windows SDK version to use. This may be a specific version number (for example, "8.1", "10.0" or "10.0.10150.0"), or the string "Latest", to select the newest available version. By default, and if it is available, we use the Windows SDK version indicated by WindowsPlatform.DefaultWindowsSdkVersion (otherwise, we use the latest version).

Definition at line 17020 of file UbtConfigGenerated.cs.

Member Data Documentation

◆ _configs

ToolConfig [] Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig._configs = null

private

Definition at line 17555 of file UbtConfigGenerated.cs.

Property Documentation

◆ CliName

override string Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.CliName

get

Definition at line 16504 of file UbtConfigGenerated.cs.

◆ Compatibility

override UnrealCompatibility Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.Compatibility

get

Definition at line 16505 of file UbtConfigGenerated.cs.

◆ Configs

override ToolConfig [] Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.Configs

getprotected

Definition at line 17556 of file UbtConfigGenerated.cs.

◆ Name

override string Nuke.Unreal.Tools.UbtConfigGenerated.WindowsTargetRulesConfig.Name

get

Definition at line 16503 of file UbtConfigGenerated.cs.

The documentation for this class was generated from the following file:

/home/runner/work/Nuke.Unreal/Nuke.Unreal/src/Nuke.Unreal/Tools/UbtConfigGenerated.cs

Public Member Functions

Properties

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _2015()

◆ _2017()

◆ _2019()

◆ _2022()

◆ _2026()

◆ ClangLinker()

◆ ClangStandaloneDebug()

◆ Compiler()

◆ CompilerVersion()

◆ Deterministic()

◆ DisableVolatileMetadata()

◆ DynamicDebugging()

◆ EnableASan()

◆ EnableInstrumentation()

◆ EnableLibFuzzer()

◆ EnableUBSan()

◆ IgnoreStalePGOData()

◆ LinkRepro()

◆ NoClangLinker()

◆ NoClangStandaloneDebug()

◆ NoLinkerDebugInfo()

◆ NoSetResourceVersions()

◆ ObjSrcMap()

◆ PdbAltPath()

◆ PGOFastGen()

◆ PGOMergedPGD()

◆ PGONoExtraCounters()

◆ RadLinker()

◆ SampleBasedPGO()

◆ Sarif()

◆ SetResourceVersions()

◆ ShowIncludes()

◆ StaticAnalyzer()

◆ StaticAnalyzerOutputType()

◆ Strict()

◆ StrictEnumTypes()

◆ StrictInline()

◆ StrictODR()

◆ StrictPreprocessor()

◆ StripPrivateSymbols()

◆ ToolchainVersionWarningLevel()

◆ UpdatedCPPMacro()

◆ UseXCurl()

◆ VCDisableExtendedWarningInfo()

◆ VCExtendedWarningInfo()

◆ VCFastFail()

◆ VCToolchain()

◆ VCToolchainVersion()

◆ WindowsSDKVersion()

Member Data Documentation

◆ _configs

Property Documentation

◆ CliName

◆ Compatibility

◆ Configs

◆ Name