Skip to content

Commit 23e93db

Browse files
committed
[Build] Update release notes for final 3.0.0
1 parent 816bcc6 commit 23e93db

File tree

2 files changed

+10
-27
lines changed

2 files changed

+10
-27
lines changed

Readme.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,23 @@ Official web site: [sharpdx.org](http://sharpdx.org)
44

55
SharpDX is an open-source project delivering the **full DirectX API for .Net on all Windows platforms**, allowing the development of high performance game, 2D and 3D graphics rendering as well as realtime sound application.
66

7-
> # Warning
8-
> After the official version [2.6.3](https://github.com/sharpdx/SharpDX/releases/tag/2.6.3), the repository is now split between this core repository (containing only the DirectX API) and the [Toolkit](https://github.com/sharpdx/Toolkit) repository that is deprecated. This is a work in progress so the latest version of this repository is unstable
9-
107
## Installation
118

129
- **auto**: easy install of all [SharpDX components with nuget](http://nuget.org/packages?q=sharpdx) into your project, detecting platforms automatically, also fully integrated with the SharpDX Toolkit
13-
- **manual**: download the zip from [sharpdx.org](http://sharpdx.org), add references to the dlls
10+
- **manual**: download the latest and stable SDK from the [releases](https://github.com/sharpdx/SharpDX/releases), add references to the dlls
1411

1512
See the [Installation][Installation] wiki page for more information.
1613

1714
## Build
1815

19-
In order to compile SharpDX, you need to install the [Windows 10 SDK 10.0.240.0](https://dev.windows.com/en-us/downloads/windows-10-sdk)
20-
21-
## Licensing
22-
23-
MIT
16+
In order to compile SharpDX, you need to install the [Windows 10 SDK 10.0.10586.0](https://dev.windows.com/en-us/downloads/windows-10-sdk)
2417

2518
## Samples
2619

2720
A collection of [Samples](https://github.com/sharpdx/SharpDX-Samples) using SharpDX exists as a separate github project.
2821

2922
[Installation]: https://github.com/sharpdx/SharpDX/wiki/Installation
23+
24+
## Licensing
25+
26+
MIT

ReleaseNotes.md

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
## SharpDX 3.0.0 (alpha01)
1+
## SharpDX 3.0.0
22

3-
This is the first alpha release of the 3.0.0 branch bringing some major new features and changes:
3+
This is the final release for the 3.0.0 version bringing some major new features and changes:
44

55
- Add support for **Direct3D12** to get the best of your graphics card (only compatible with Windows 10 10041)
66
- Thanks to the work from the [diet branch](https://github.com/sharpdx/SharpDX/issues/398), SharpDX main assembly is a bit more lightweight.
77
- We have simplified the distribution and packaging by supporting only 2 platforms and .NET versions:
88
- **Desktop** with `.NET 4.5`
99
- **StoreApp** with `PCL .NET 4.5` valid for Windows 8.1+ and Windows Phone 8.1+ development
10-
- All Mathematics (`Vector3`, `Vector4`...) have been moved to a dedicated assembly. The reason behind this change is to put SharpDX on a diet, where higher level API (like Paradox, MonoGame...) are no longer forced to include this API. In order to support this, all SharpDX assemblies are now using interop types (`RawVector3`, `RawVector4` from `SharpDX.Mathematics.Interop` namespace)
10+
- All Mathematics (`Vector3`, `Vector4`...) have been moved to a dedicated assembly. The reason behind this change is to put SharpDX on a diet, where higher level API (like Xenko, MonoGame...) are no longer forced to include this API. In order to support this, all SharpDX assemblies are now using interop types (`RawVector3`, `RawVector4` from `SharpDX.Mathematics.Interop` namespace)
1111
- A new assembly `SharpDX.Desktop` that contains `RenderForm`, `RenderLoop` previously in `SharpDX` assembly
12+
- XInput and XAudio are now providing a backward compatible interface between the various versions. For Desktop, it means that the runtime will try to detect the correct versions for XInput (9.10, 1.3, 1.4) or XAudio (2.7 or 2.8). For Store Apps, the latest one will be used.
1213

1314
Assemblies are both available from a **zip** and from **NuGet**.
1415
Note that distribution from NuGet should be now more stable and usable than previous versions due to the diet work.
@@ -33,21 +34,6 @@ The [samples](https://github.com/sharpdx/SharpDX-Samples) are now part of a subm
3334

3435
Some scripts will be added later to simplify the setup of the samples.
3536

36-
### About Direct3D12
37-
38-
This release includes a preview of the `Direct3D12` API along a very basic sample `HelloWorld` available from the [SharpDX Samples](https://github.com/sharpdx/SharpDX-Samples) repository.
39-
40-
Compare to previous Direct3D API in SharpDX, the API is now closer to the C++ API (e.g keep methods like `Device.CreateXXX(...)` instead of `new XXX(device, ...)`)
41-
42-
In order to use this API, make sure that you have **Windows 10 10041 and the latest graphics drivers installed**
43-
44-
Due to NDA, I'm not yet allowed to publish ported samples from Direct3D12 Early Access Program, sorry for that!
45-
46-
### Known issues
47-
48-
- The `Direct3D12` API is still a work in progress. Some structures are not yet usable or not correctly marshalled. Most of the work done so far was to get the `HelloTriangle` working, which is using a very small part of the `Direct3D12` API.
49-
- `XInput` 1.4 and `XAudio2` 2.8 are only generated for the Windows 8 versions (for both desktop and stores). We will restore previous versions in a later alpha release (`XInput 9.1.0`, `XAudio 2.7`)
50-
5137
### Feedback
5238

5339
As this is a major release, if you have any questions or remarks concerning this release, join the discussion on github: [Feedback from 3.0.0 alpha01](https://github.com/sharpdx/SharpDX/issues/567)

0 commit comments

Comments
 (0)