Nuke.Unreal.BoilerplateGenerators.XRepo.XRepoLibrary Class Reference

Utility classes for working with XRepo (or XMake) packages. More...

Static Public Member Functions
static LibrarySpec	ParseSpec (string spec)
	Parses an input library spec string as a record.
static void	InstallXRepoLibrary (this IUnrealBuild build, string specIn, string options, AbsolutePath targetPath, List< UnrealPlatform >? supportedPlatforms=null, string? suffix=null, string releaseRuntime="MD", string debugRuntime="MD")
	Prepare a third-party library from an XRepo library spec for Unreal engine's consumption. Each platforms will be considered which is listed under SupportedTargetPlatforms of the owning UPlugin. If it's empty only consider the host platform.

Static Package Functions
static IEnumerable< XRepoLibraryRecord >	InstallXRepoLibrary (IUnrealBuild build, UnrealPlatform platform, LibrarySpec spec, string options, AbsolutePath targetPath, bool debug, string runtime="MD")

Static Private Member Functions
static partial Regex	SpecRegex ()

Detailed Description

Utility classes for working with XRepo (or XMake) packages.

Definition at line 22 of file XRepoLibrary.cs.

Member Function Documentation

InstallXRepoLibrary() [1/2]

static IEnumerable< XRepoLibraryRecord > Nuke.Unreal.BoilerplateGenerators.XRepo.XRepoLibrary.InstallXRepoLibrary ( IUnrealBuild build, UnrealPlatform platform, LibrarySpec spec, string options, AbsolutePath targetPath, bool debug, string runtime = "MD" )

staticpackage

Definition at line 60 of file XRepoLibrary.cs.

InstallXRepoLibrary() [2/2]

static void Nuke.Unreal.BoilerplateGenerators.XRepo.XRepoLibrary.InstallXRepoLibrary ( this IUnrealBuild build, string specIn, string options, AbsolutePath targetPath, List< UnrealPlatform >? supportedPlatforms = null, string? suffix = null, string releaseRuntime = "MD", string debugRuntime = "MD" )

static

Prepare a third-party library from an XRepo library spec for Unreal engine's consumption. Each platforms will be considered which is listed under SupportedTargetPlatforms of the owning UPlugin. If it's empty only consider the host platform.

Parameters

build	The build context
specIn	The library spec specified here (without the options) https://mcro.de/Nuke.Unreal/d2/d84/CppLibraries.html
options	Comma separated '=' delimited key-value pairs. Space is not allowed around commas
targetPath	Where library files should be organized
supportedPlatforms	Optionally limit the platforms considered for this library, if it shouldn't be compiled with all what's listed in its UPlugin.
suffix	Optional addition to the name of library name exposed to Unreal
releaseRuntime	Windows CRT linkage for release versions (default is MD)
debugRuntime	Windows CRT linkage for debug versions (default is MD)

Definition at line 162 of file XRepoLibrary.cs.

ParseSpec()

static LibrarySpec Nuke.Unreal.BoilerplateGenerators.XRepo.XRepoLibrary.ParseSpec ( string spec )

static

Parses an input library spec string as a record.

Definition at line 47 of file XRepoLibrary.cs.

---

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

• /home/runner/work/Nuke.Unreal/Nuke.Unreal/src/Nuke.Unreal/BoilerplateGenerators/XRepo/XRepoLibrary.cs