Skip to content

Commit 1dde1e3

Browse files
authored
This is the November 2021 Update (v2.10.0) (#671)
* Packaging improvements, NuGet readmes, and 2.10 release notes * Fix GitHub README rendering issues * Attempt to fix whitespace * push push push push push push push * Actually fix whitespace * Update common.props * Update Directory.Build.props
1 parent b7732ad commit 1dde1e3

20 files changed

+295
-51
lines changed

README.md

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
<!-- Begin exclude from NuGet readme. -->
12
<h1 align="center">
2-
<a href="#"><img align="center" src="documentation/readme/wordmark480.png" height="96"></a>
3+
<a href="#"><img align="center" src="documentation/readme/silkdotnet_v3_horizontal_96.svg"></a>
34
<br />
45
</h1>
56
<div align="center">
@@ -12,6 +13,10 @@
1213
</div>
1314

1415
<div>
16+
<!-- End exclude from NuGet readme. -->
17+
<!-- Begin include in NuGet readme.
18+
![Silk.NET Logo](https://raw.githubusercontent.com/dotnet/Silk.NET/main/documentation/readme/silkdotnet_v3_horizontal_96.svg)
19+
End include in NuGet readme. -->
1520

1621
Silk.NET is your one-stop-shop for high-speed .NET multimedia, graphics, and compute; providing bindings to popular low-level APIs such as OpenGL, OpenCL, OpenAL, OpenXR, GLFW, SDL, Vulkan, Assimp, and DirectX.
1722

@@ -22,12 +27,20 @@ Silk.NET works on any .NET Standard 2.0 compliant platform, including .NET 5.0,
2227
</div>
2328
<br />
2429
<div>
25-
<a href="https://dotnetfoundation.org" align="right"><img src="https://dotnetfoundation.org/img/logo_v4.svg" alt=".NET Foundation" class="logo-footer" width="72" align="left">
26-
<a><br/>
27-
Proud to be an official project under the benevolent <a href="https://dotnetfoundation.org">.NET Foundation</a> umbrella. </a>
30+
<!-- Begin exclude from NuGet readme. -->
31+
<a href="https://dotnetfoundation.org" align="right"><img src="https://dotnetfoundation.org/img/logo_v4.svg" alt=".NET Foundation" class="logo-footer" width="72" align="left">
32+
<!-- End exclude from NuGet readme. -->
33+
<!-- Begin include in NuGet readme.
34+
![.NET Foundation](https://raw.githubusercontent.com/dotnet/Silk.NET/main/documentation/readme/dotnetfoundation_v4_horizontal_64.svg)
35+
End include in NuGet readme. -->
36+
</a>
37+
<br />
38+
39+
Proud to be an official project under the benevolent [.NET Foundation](https://dotnetfoundation.org) umbrella.
40+
2841
</div>
2942

30-
<br />
43+
<!-- Package description inserted here automatically. -->
3144

3245
<h1 align="center">Features</h1>
3346

@@ -43,6 +56,8 @@ In addition to providing high-speed, direct, and transparent bindings, we provid
4356
### Good-to-go
4457
Silk.NET caters for anything you could need in swift development of multimedia, graphics, compute applications. Silk.NET is an all-in-one solution, complete with Graphics, Compute, Audio, Input, and Windowing.
4558

59+
<!-- Begin exclude from NuGet readme. -->
60+
4661
<h1 align="center">The team</h1>
4762

4863
We currently have the following maintainers:
@@ -79,7 +94,9 @@ Silk.NET uses and encourages [Early Pull Requests](https://medium.com/practical-
7994
3. Once you've pushed a commit, open a [**draft pull request**](https://github.blog/2019-02-14-introducing-draft-pull-requests/). Do this **before** you actually start working.
8095
4. Make your commits in small, incremental steps with clear descriptions.
8196
5. Tag a maintainer when you're done and ask for a review!
82-
97+
98+
<!-- End exclude from NuGet readme. -->
99+
83100
<h2 align="center">Funding</h2>
84101
Silk.NET requires significant effort to maintain, as such we greatly appreciate any financial support you are able to provide!
85102

@@ -96,11 +113,16 @@ Silk.NET is distributed under the very permissive MIT/X11 license and all depend
96113

97114
Silk.NET is a [.NET Foundation](https://www.dotnetfoundation.org/projects) project, and has adopted the code of conduct defined by the [Contributor Covenant](http://contributor-covenant.org/) to clarify expected behavior in our community. For more information, see the [.NET Foundation Code of Conduct](http://www.dotnetfoundation.org/code-of-conduct).
98115

116+
<!-- Begin exclude from NuGet readme. -->
117+
99118
---
100119

101120
<div>
102-
<a href="https://www.jetbrains.com/?from=Silk.NET" align="right"><img src="documentation/readme/jetbrains.svg" alt="JetBrains" class="logo-footer" width="72" align="left">
121+
<a href="https://www.jetbrains.com/?from=Silk.NET" align="right"><img src="https://raw.githubusercontent.com/dotnet/Silk.NET/main/documentation/readme/jetbrains.svg" alt="JetBrains" class="logo-footer" width="72" align="left">
103122
<a><br/>
104123
105124
Special thanks to [JetBrains](https://www.jetbrains.com/?from=Silk.NET) for supporting us with open-source licenses for their IDEs. </a>
106125
</div>
126+
127+
<!-- End exclude from NuGet readme. -->
128+

Silk.NET.sln

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Build Properties", "Build P
3333
ProjectSection(SolutionItems) = preProject
3434
build\props\bindings.props = build\props\bindings.props
3535
build\props\common.props = build\props\common.props
36-
build\props\common.targets = build\props\common.targets
3736
build\csharp_typemap.json = build\csharp_typemap.json
3837
build\dx_typemap.json = build\dx_typemap.json
3938
generator.json = generator.json

build/props/common.props

Lines changed: 74 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,95 @@
11
<!--suppress CheckTagEmptyBody -->
2-
<Project>
2+
<Project InitialTargets="SilkAddIcon;SilkGenerateNuGetReadme">
33
<PropertyGroup>
4-
<PackageIconUrl>https://static.ultz.co.uk/img/SilkDotNet.png</PackageIconUrl>
54
<PackageLicenseExpression>MIT</PackageLicenseExpression>
65
<LangVersion>preview</LangVersion>
76
<Authors>.NET Foundation and Contributors</Authors>
87
<PackageReleaseNotes>
9-
Silk.NET October 2021 Update
10-
11-
- Add bindings for DirectX Video Acceleration (DXVA)
12-
- Add bindings for D3D9Ex
13-
- Add bindings for extra core Win32 APIs (as required by DXVA)
14-
- Add a .NET 6 code path for GlobalMemory using NativeMemory
15-
- Add more TFMs in addition to .NET Standard 2.0 for DirectX bindings
16-
- Add enhanced anonymous struct support with ref-returning properties on .NET Standard 2.1 and up
17-
- Update to Vulkan 1.2.194
18-
- Update to latest OpenCL specifications
19-
- Fix MarshalDirectiveException when a struct containing a char passes across a native boundary
20-
- Fix Vulkan out parameters not having their structure type set before passing across the native boundary
21-
- Fix native libraries not being found in some cases for self-contained executables
8+
Silk.NET November 2021 Update
9+
10+
- Added support for BigInteger and Complex in the Silk.NET.Maths.Scalar APIs. (thanks @WhiteBlackGoose)
11+
- Added helper constructors for maths types (Rectangle, Box2D, Box3D, etc). (thanks @nathan-alden-sr)
12+
- Added bitwise APIs to Silk.NET.Maths.Scalar. (thanks @WhiteBlackGoose)
13+
- Added support for configuring OpenGL multisamping.
14+
- Updated to Vulkan 1.2.197.
15+
- Updated to latest OpenCL specifications.
16+
- Updated to latest OpenGL specifications.
17+
- Updated DirectX and Win32 bindings to Windows 11 SDK.
18+
- Removed redundant references with no DLLs (i.e. BCL/legacy packages not needed on newer platforms, thanks @nathan-alden-sr @WhiteBlackGoose)
19+
- Removed problematic implicit-in OpenGL overloads (fixes the infamous VertexAttribPointer bug)
20+
- Fixed incorrect character encoding of keyboard (text) input on the SDL backend. (thanks @roeyskoe)
21+
- Fixed native libraries not being resolved despite being present in the "runtimes" folder.
22+
- Miscellaneous documentation fixes and improvements.
2223
</PackageReleaseNotes>
2324
<PackageTags Condition="'$(PackageTags)' == ''">OpenCL;OpenGL;OpenAL;OpenGLES;GLES;Vulkan;Assimp;DirectX;GLFW;SDL;Windowing;Input;Gamepad;Joystick;Keyboard;Mouse;SilkTouch;Source;Generator;C#;F#;.NET;DotNet;Mono;Vector;Math;Maths;Numerics;Game;Graphics;Compute;Audio;Sound;Engine;Silk;Silk.NET;Slim.NET;ElgarTK;GPU;Sharp;Science;Scientific;Visualization;Visual;Audiovisual;Windows;macOS;Linux;Android;Bindings;OSX;Wrapper;Native</PackageTags>
2425
<GenerateDocumentationFile>true</GenerateDocumentationFile>
2526
<PackageOutputPath>$(MSBuildThisFileDirectory)/../output_packages</PackageOutputPath>
2627
<RepositoryUrl>https://github.com/dotnet/Silk.NET</RepositoryUrl>
2728
<RepositoryType>Git</RepositoryType>
28-
<VersionPrefix>2.9.0</VersionPrefix>
29+
<VersionPrefix>2.10.0</VersionPrefix>
2930
<VersionSuffix Condition="'$(VersionSuffix)' == ''"></VersionSuffix>
3031
<Description Condition="'$(Description)' == ''">
3132
Silk.NET is a high-speed, advanced library, providing bindings to popular low-level APIs such as OpenGL, OpenCL, OpenAL, OpenXR, GLFW, SDL, Vulkan, Assimp, and DirectX.
3233
</Description>
3334
</PropertyGroup>
3435
<!-- SourceLink -->
35-
<PropertyGroup Condition="'$(SilkEnableSourceLink)' != '' And '$(SilkSourceLinkExempt)' == ''">
36-
<PublishRepositoryUrl>true</PublishRepositoryUrl>
37-
<EmbedUntrackedSources>true</EmbedUntrackedSources>
38-
<IncludeSymbols>true</IncludeSymbols>
39-
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
40-
<IncludePackageReferencesDuringMarkupCompilation>true</IncludePackageReferencesDuringMarkupCompilation>
41-
<Deterministic>true</Deterministic>
36+
<PropertyGroup Condition="'$(SilkSourceLinkExempt)' == ''">
37+
<DebugType>portable</DebugType>
4238
</PropertyGroup>
43-
<ItemGroup Condition="'$(SilkEnableSourceLink)' != '' And '$(SilkSourceLinkExempt)' == ''">
44-
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All"/>
39+
<ItemGroup Condition="'$(SilkSourceLinkExempt)' == ''">
40+
<PackageReference Include="DotNet.ReproducibleBuilds" Version="0.1.66" PrivateAssets="All"/>
41+
<PackageReference Include="DotNet.ReproducibleBuilds.Isolated" Version="0.1.66" PrivateAssets="All"/>
4542
</ItemGroup>
46-
<PropertyGroup Condition="'$(SilkSourceLinkExempt)' != ''">
47-
<IncludeSymbols>false</IncludeSymbols>
48-
<SymbolPackageFormat></SymbolPackageFormat>
49-
</PropertyGroup>
43+
<!-- Nuget Icon - done as a target so it doesn't appear in the IDE -->
44+
<Target Name="SilkAddIcon" Condition="'$(SilkIconExempt)' == ''">
45+
<ItemGroup>
46+
<None Include="$(MSBuildThisFileDirectory)../../documentation/readme/silkdotnet_v3.png"
47+
Pack="true"
48+
PackagePath="\" />
49+
</ItemGroup>
50+
<PropertyGroup>
51+
<PackageIcon>silkdotnet_v3.png</PackageIcon>
52+
</PropertyGroup>
53+
</Target>
54+
<!-- NuGet README -->
55+
<Target Name="SilkGenerateNuGetReadme" Condition="'$(SilkReadmeExempt)' == ''">
56+
<PropertyGroup>
57+
<SilkReadme>$([System.IO.File]::ReadAllText("$(MSBuildThisFileDirectory)../../README.md"))</SilkReadme>
58+
<SilkReadme>$([System.String]::Copy($(SilkReadme))
59+
.Replace('&lt;!-- Begin exclude from NuGet readme. --&gt;','&lt;!--')
60+
.Replace('&lt;!-- End exclude from NuGet readme. --&gt;','--&gt;')
61+
.Replace('&lt;!-- Begin include in NuGet readme.','')
62+
.Replace('End include in NuGet readme. --&gt;','')
63+
.Replace('&lt;h1 align=&quot;center&quot;&gt;', '# ')
64+
.Replace('&lt;h2 align=&quot;center&quot;&gt;', '# ')
65+
.Replace('&lt;/h1&gt;', '').Replace('&lt;/h2&gt;', '')
66+
.Replace('&lt;br /&gt;', '%0a%0a').Replace('&lt;br/&gt;', '%0a%0a')
67+
.Replace('&lt;div&gt;', '').Replace('&lt;/div&gt;', '')
68+
.Replace('&lt;a&gt;', '').Replace('&lt;/a&gt;', ''))
69+
</SilkReadme>
70+
<SilkReadmePath>$(IntermediateOutputPath)README.md</SilkReadmePath>
71+
</PropertyGroup>
72+
<PropertyGroup Condition="'$(SilkDescription)' != ''">
73+
<Description>$(SilkDescription) $(Description)</Description>
74+
<SilkExtendedDescription>$(SilkDescription) $(SilkExtendedDescription)%0a%0a</SilkExtendedDescription>
75+
<SilkReadme>$([System.String]::Copy($(SilkReadme))
76+
.Replace('&lt;!-- Package description inserted here automatically. --&gt;',
77+
'# About This Package%0a%0a$(SilkExtendedDescription)'))
78+
</SilkReadme>
79+
</PropertyGroup>
80+
<ItemGroup>
81+
<SilkReadmeLines Include="$(SilkReadme)" />
82+
<SilkReadmeGenerated Include="$(SilkReadmePath)" />
83+
</ItemGroup>
84+
<WriteLinesToFile File="@(SilkReadmeGenerated)"
85+
Lines="@(SilkReadmeLines)"
86+
Overwrite="true"
87+
Encoding="UTF-8" />
88+
<PropertyGroup>
89+
<PackageReadmeFile>README.md</PackageReadmeFile>
90+
</PropertyGroup>
91+
<ItemGroup>
92+
<None Include="$(SilkReadmePath)" Pack="true" PackagePath="\" />
93+
</ItemGroup>
94+
</Target>
5095
</Project>

build/props/common.targets

Lines changed: 0 additions & 14 deletions
This file was deleted.

0 commit comments

Comments
 (0)