Nuke.Unreal
Build Unreal apps in Style.
Loading...
Searching...
No Matches
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 UnrealBuild self, string specIn, string options, AbsolutePath targetPath, string? suffix=null, string releaseRuntime="MD", string debugRuntime="MD")
 Prepare a third-party library from an XRepo library spec for Unreal engine's consumption.
 

Static Package Functions

static IEnumerable< XRepoLibraryRecord > InstallXRepoLibrary (UnrealBuild self, 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 18 of file XRepoLibrary.cs.

Member Function Documentation

◆ InstallXRepoLibrary() [1/2]

static void Nuke.Unreal.BoilerplateGenerators.XRepo.XRepoLibrary.InstallXRepoLibrary ( this UnrealBuild self,
string specIn,
string options,
AbsolutePath targetPath,
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.

Parameters
selfThe build context
specInThe library spec specified here (without the options) https://mcro.de/Nuke.Unreal/d2/d84/CppLibraries.html
optionsComma separated '=' delimited key-value pairs. Space is not allowed around commas
targetPathWhere library files should be organized
suffixOptional addition to the name of library name exposed to Unreal
releaseRuntimeWindows CRT linkage for release versions (default is MD)
debugRuntimeWindows CRT linkage for debug versions (default is MD)

Definition at line 152 of file XRepoLibrary.cs.

◆ InstallXRepoLibrary() [2/2]

static IEnumerable< XRepoLibraryRecord > Nuke.Unreal.BoilerplateGenerators.XRepo.XRepoLibrary.InstallXRepoLibrary ( UnrealBuild self,
LibrarySpec spec,
string options,
AbsolutePath targetPath,
bool debug,
string runtime = "MD" )
staticpackage

Definition at line 56 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 43 of file XRepoLibrary.cs.


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