Skip to content

Latest commit

 

History

History
64 lines (49 loc) · 2.93 KB

msbuild-sdk.md

File metadata and controls

64 lines (49 loc) · 2.93 KB
Raw

Cesium MSBuild Project SDK

Cesium provides it's own project SDK that could be used to simplify building of Cesium programs and libraries.

Cesium MSBuild SDK inherits default behavior from a Microsoft.NET.Sdk SDK and tries to integrate with it the same way as C# does.

Cesium MSBuild SDK only supports SDK-style projects.

Note: Some of the common MSBuild properties and items those are not stated in this document could be also used in Cesium project files. Not all of them are tested so something may not work as expected.

Source files

Source files are defined with <Compile> items, very similar to other .NET languages:

<ItemGroup>
    <Compile Include="hello.c" />
    <Compile Include="folder/*.c" />
</ItemGroup>

Note: In the current SDK implementation, source files will not be included into compilation implicitly. They should be defined in <Compile> items, in opposite to SDK-style C# projects, where all C# source files are implicitly added to the compilation.

References

Packages

Not supported yet.

Projects

Not supported yet.

Assemblies

Not supported yet.

Preprocessor directives

<DefineConstants> property is directly mapped to a list of preprocessor items. So, you could define such constants in .ceproj:

<PropertyGroup>
    <DefineConstants>$(DefineConstants);FOO;BAR</DefineConstants>
</PropertyGroup>

And then use it in your .c code:

#ifdef FOO
int foo() { return 0; }
#endif

#ifdef BAR
int bar() { return 1; }
#endif

Output files

Output assembly and additional artifacts will be placed in bin folder. Depending on the target framework, output type and a platform you're compiling on, .runtimeconfig.json and .deps.json files will also be generated.

Properties

  • SkipCesiumCompilerInstallation: if set to true, doesn't automatically install a compiler bundle package. In that case it should be explicitly provided by CesiumCompilerPackageName and CesiumCompilerPackageVersion properties. Default: false
  • SkipCesiumRuntimeInstallation: if set to true, doesn't automatically install a Cesium.Runtime package. In that case it should be explicitly installed. Default: false
  • CesiumCompilerPackageName: an optional platform-specific compiler bundle package name. Should be specified if SkipCesiumCompilerInstallation set to true. Default: Cesium.Compiler.Pack.{RID}
  • CesiumCompilerPackageName: an optional platform-specific compiler bundle package version. Should be specified if SkipCesiumCompilerInstallation set to true. Default: Cesium SDK version
  • CesiumCompilerPath: an optional path to compiler executable. Use this property to specify a path to the compiler not coming from a compiler package.
  • CesiumCoreLibAssemblyPath: an optional path to .NET runtime assembly: System.Runtime or mscorlib, depending on the target framework.

Items

  • Compile: a C source file to be included into compiler execution command