Update release notes

sharpdx · Oct 19, 2016 · f6adee8 · f6adee8
1 parent fa18794
commit f6adee8
Showing 1 changed file with 91 additions and 29 deletions.
diff --git a/ReleaseNotes.md b/ReleaseNotes.md
@@ -1,42 +1,104 @@
-## SharpDX 3.0.0
+Changelog between 3.0.2 and 3.1.0 version
 
-This is the final release for the 3.0.0 version bringing some major new features and changes:
+## Build
 
-- Add support for **Direct3D12** to get the best of your graphics card (only compatible with Windows 10 10041)
-- Thanks to the work from the [diet branch](https://github.com/sharpdx/SharpDX/issues/398), SharpDX main assembly is a bit more lightweight. 
-- We have simplified the distribution and packaging by supporting only 2 platforms and .NET versions:
-	- **Desktop** with `.NET 4.5`
-	- **StoreApp** with `PCL .NET 4.5` valid for Windows 8.1+ and Windows Phone 8.1+ development
-- 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) 
-- A new assembly `SharpDX.Desktop` that contains `RenderForm`, `RenderLoop` previously in `SharpDX` assembly
-- 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.   
+  - Add info for building on VS 2015 to readme.md ([changes](https://github.com/sharpdx/SharpDX/commit/09a8c014ec96ede88b304807f428654dd1a6dc46))
+  - Add info for building on VS 2015 Update 3 ([changes](https://github.com/sharpdx/SharpDX/commit/8dc1f64a9424c6b0dc8b9009f70e144ded03f1d7))
+  - Update MSDNDoc.zip ([changes](https://github.com/sharpdx/SharpDX/commit/b61b86aa256ad7d7b0f0e828e8039c0dbb8af53a))
+  - Update solution version to VS2015 ([changes](https://github.com/sharpdx/SharpDX/commit/8a2aab284b1b0ca5c656758fb93a197fdca8cb9d))
 
-Assemblies are both available from a **zip** and from **NuGet**. 
-Note that distribution from NuGet should be now more stable and usable than previous versions due to the diet work.
+## Desktop
 
-We have also clean-up the API: 
-- The DirectX June 2010 SDK is no longer supported. For example, methods like DX11 are no longer supported (e.g. `Texture.FromFile`...)
-- `Direct3D10` API has been removed
-- The Toolkit is no longer supported and distributed
-- `Direct3D9`, `DirectSound`, `DirectInput`, `RawInput` have been frozen so that the code generated from SharpGen codegen from C++ is no longer running. It means that these APIs will no longer receive major changes and should be considered as deprecated.
+  - add lost CodeComments.xml file ([changes](https://github.com/sharpdx/SharpDX/commit/3457396042ce6b20927bd8ba8ce43cbd865964bf))
+  - fix OnMonitorChanged ([changes](https://github.com/sharpdx/SharpDX/commit/ea09f039e5ac009175db4ae6965f64068a5d57ab))
 
-Projects that are still requiring to use `.NET 2.0` or `.NET 4.0`, or API like `Direct3D10` will have to continue using `SharpDX 2.6.3`.
+## Direct2D
 
-### Building from the sources
+  - update mapping for Direct2D ([changes](https://github.com/sharpdx/SharpDX/commit/0566aab258e811f705e70b869e1ee55ea7059c53))
+  - update mapping for DirectWrite ([changes](https://github.com/sharpdx/SharpDX/commit/6fcbe0b4ee2fe4f11ec0e1a31f16853de9eb5ebe))
 
-In order to compile SharpDX from the sources, It requires to install the [Windows SDK for Windows 10](https://dev.windows.com/en-us/featured/hardware/windows-10-hardware-preview-tools)
+## Direct3D10
 
-### How to use the samples
+  - Adaptation mapping ([changes](https://github.com/sharpdx/SharpDX/commit/c240803c181564c3cc8f4ef32af90cfa82326f40))
+  - freeze sources ([changes](https://github.com/sharpdx/SharpDX/commit/2d97c1857e6bd2f5c741f50fb6e2d98cab536552))
+  - remove Debug.Assert ([changes](https://github.com/sharpdx/SharpDX/commit/95f1a07e8805c30ab3d7a8fd022f6179814ec10f))
+  - remove from StoreApp ([changes](https://github.com/sharpdx/SharpDX/commit/5b5db254b15cccb202dc936f256a8b4429d33842))
+  - return source from [c6d8e45] ([changes](https://github.com/sharpdx/SharpDX/commit/07b60f2afda6236546caa8f111344bdc3892eb50))
 
-The [samples](https://github.com/sharpdx/SharpDX-Samples) are now part of a submodule of the SharpDX repository. In order to use the sample, you can download the SharpDX zip binaries and unzip the `Bin` directory so that it is at the same level than the `Samples` directory:
-- `Bin\DesktopApp\SharpDX.dll`...etc.
-- `Samples\Desktop\...`... etc.
+## Direct3D11
 
-Some scripts will be added later to simplify the setup of the samples.
+  - add support Device4 ([changes](https://github.com/sharpdx/SharpDX/commit/97c2e07546a8ef21a7869e48fadbf5712d8a126d))
+  - Improve support Direct3D 11.3 ([changes](https://github.com/sharpdx/SharpDX/commit/4a066d75d9c421283bf99976883e8bca817728da))
+  - remove nameof operator ([changes](https://github.com/sharpdx/SharpDX/commit/12669e5ea956a2dcab00a27c8bdeff5a8932fb96))
+  - rename RaterizerState.cs =&gt; RasterizerState.cs. ([changes](https://github.com/sharpdx/SharpDX/commit/7f61b6be89c64a4dcf8b1b5bebd57836872c481b))
+  - Fix for null reference exception in DeviceContext.RasterizerStage ([changes](https://github.com/sharpdx/SharpDX/commit/a3fb181103f0beda50b8bf355e89a664f340a61c))
 
-### Feedback
+## Direct3D12
 
-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)
+  - Simplify marshaling for PR #773 ([issue #667](http://code.google.com/p/sharpdx/issues/detail?id=667)) ([changes](https://github.com/sharpdx/SharpDX/commit/9d7b926e248326971d7fc9b79184158e2a4ceafb))
+  - Disable code generation for ID3D12RootSignatureDeserializer and RootSignatureDescription. Rely on manual marshaling instead. ([changes](https://github.com/sharpdx/SharpDX/commit/db3fba1c7d172344bd58bb43d723f62fff325137))
+
+## DirectManipulation
+
+  - change assembly description ([changes](https://github.com/sharpdx/SharpDX/commit/695fbedcf110315a408f4e1535be84f1f0f6fcf2))
+
+## DXGI
+
+  - add mapping DXGI_OVERLAY_SUPPORT_FLAG ([changes](https://github.com/sharpdx/SharpDX/commit/b4d2f1cb4aec8e4b6db3b64c5f33f879d83c2ebc))
+  - fix mapping for StoreApp ([changes](https://github.com/sharpdx/SharpDX/commit/cce5abe3cf5a2625321dc05a84b375881880af9a))
+  - FormatHelper public static method&apos;s convert to extensons ([changes](https://github.com/sharpdx/SharpDX/commit/a1ad26a77bc9af3220bd2764559729fb5b06ee02))
+  - Improve to DXGI 1.5 ([changes](https://github.com/sharpdx/SharpDX/commit/6b09ebb4a8d291b52940e0e3c0472250735882e2))
+
+## General
+
+  - change copyright date ([changes](https://github.com/sharpdx/SharpDX/commit/6828f82decc7f55f53e7c2e76bff706cca229638))
+
+## Mathematics
+
+  - fix bug in Collision.ClosestPointPointTriangle() ([changes](https://github.com/sharpdx/SharpDX/commit/9f847c5de9c3e22619c315b877f399c0e11788c5))
+
+## MediaFoundation
+
+  - Revert &quot;remove&quot; to keep around mapping.xml for MediaFoundation/DirectX ([changes](https://github.com/sharpdx/SharpDX/commit/4ea05cedf7a077dd8917165f9f2c309402d5f6c4))
+  - changes to add support for the SharpDX.MediaFoundation/DirectX code ([changes](https://github.com/sharpdx/SharpDX/commit/4c91323561984e839a23b7e4f25a4876d4e0958f))
+
+## DirectComposition
+
+  - Add missing method to create Target from `Device` ([changes](https://github.com/sharpdx/SharpDX/commit/6221710c7e6f91caa72b67bb45481948b8d53082))
+
+## Misc
+
+  - Add .editorconfig file. ([changes](https://github.com/sharpdx/SharpDX/commit/24b9fdac861def0f8db2fbd8a64084165c9db7d1))
+  - Fix bug in #785 in DataStream ([changes](https://github.com/sharpdx/SharpDX/commit/b9f7519cf66dcf5df96a6c1cd67d97ec3c79828f))
+  - fix initialization of local blockAlign with default values. ([changes](https://github.com/sharpdx/SharpDX/commit/bc90539040015fe8014a469f2c10b79378f68bd7))
+  - Fix issue with signing assemblies from PR. Remove SharpDXSign config from SharpDX.build and setup this from AppVeyor ([changes](https://github.com/sharpdx/SharpDX/commit/a39f95fcf8cd2793c6f901629987af7533de3234))
+  - Fix the missing arguments and broken test ([changes](https://github.com/sharpdx/SharpDX/commit/64189c21bab97518b1bf2a03b0da6b357958b84c))
+  - Fix: Memory leak for D3D11 device when `CreateWithSwapChain` is used ([changes](https://github.com/sharpdx/SharpDX/commit/2253901c3aa80872f67b57f0d236dff60b0bb0f9))
+  - Fixed #744 DeviceContext1.ClearView()&apos;s &apos;color&apos; parameter is of type &apos;float&apos; when it should be a &apos;RawColor4&apos;. ([changes](https://github.com/sharpdx/SharpDX/commit/d3c3608eeed7a3c2e873705991fdee445e57e682))
+  - fixup locations of DirectX support inside SharpDX.MediaFoundation ([changes](https://github.com/sharpdx/SharpDX/commit/8490061ec8659f2cd9921f7a47bea42b6a08fa2d))
+  - GraphicsCommandList improvements and add better BeginEvent and SetMarker methods. ([changes](https://github.com/sharpdx/SharpDX/commit/1b22d9e9cf06b0b8034b5af34ada64b17a3d69d4))
+  - Improve Equals Size2, SizeF ([changes](https://github.com/sharpdx/SharpDX/commit/0fe131515c9956c594c44fe418ba95e3ad89854c))
+  - Leak Device ([changes](https://github.com/sharpdx/SharpDX/commit/d0cba377c147abb9fa2874257ff0cf9c12376ad9))
+  - Mapping improvements for ID3D11On12Device and Direct3D12 ResourceStates. ([changes](https://github.com/sharpdx/SharpDX/commit/9a0b5e93e0df6527a1758dccc217be57a3bc6841))
+  - Modification of ReadFromSubresource API / ReadFromSubresourceの修正 ([changes](https://github.com/sharpdx/SharpDX/commit/bf29cfd0494f509994b5ad0de9e0562dfbfe112a))
+  - move to correct location ([changes](https://github.com/sharpdx/SharpDX/commit/488f0b5860c394a3ad578cf1846fe6e5a0155fde))
+  - Moved the re-added DirectX source code, and the generated under 2.6.3 files into a Desktop only conditional, along with references to SharpDX.Mathematics and SharpDX.Direct3D9 ([changes](https://github.com/sharpdx/SharpDX/commit/829e3aa1dda104f3e31c354617536a71cb66206f))
+  - Output a markdown file for the git log ([changes](https://github.com/sharpdx/SharpDX/commit/fa18794e6f10f8c0dea4c3f8c455d5ab2487fab0))
+  - RawInputEventArgs (and thus also HidInputEventArgs, KeyboardInputEventArgs, and MouseInputEventArgs) now has a WindowHandle property that can be used to retrieve the handle of the window that received the raw input event. ([changes](https://github.com/sharpdx/SharpDX/commit/7a1149c6fbde7328410738d454edd60a2ec4f3c6))
+  - remove ([changes](https://github.com/sharpdx/SharpDX/commit/e1fe8a6758b55651b6636b393046a8f075fae94d))
+  - Replaced perspective view matrix calculation ([changes](https://github.com/sharpdx/SharpDX/commit/707244f67b915e0e955310a82939a190a0ebfeae))
+  - ReSharper settings upgrade ([changes](https://github.com/sharpdx/SharpDX/commit/b0336475b6b5338157024582358f3083c4a97640))
+  - SwapChain.Present and SwapChain1.Present now return their result codes so that the application can check whether the window is occluded. This should resolve #746. ([changes](https://github.com/sharpdx/SharpDX/commit/2bce60c5892141a214fda9c98d418d59aac56c64))
+  - The SharpDX commit b9f7519 causes the .NET Native compiler to crash. ([changes](https://github.com/sharpdx/SharpDX/commit/e520e1005b51f99836f186f6fb3c61aebaf8cac8))
+  - Update CustomDevice.cs ([changes](https://github.com/sharpdx/SharpDX/commit/41138962217493662ebbc76d1635febc15e53d7d))
+  - Update MouseState.cs ([changes](https://github.com/sharpdx/SharpDX/commit/5c513e7d85f9fda5ad3b39a6cb86cb0989955cce))
+  - Validate blockAlign can be cast to short ([changes](https://github.com/sharpdx/SharpDX/commit/1e41b3fbd42f5f6dc2f70ef6755dbd869521a554))
+
+## Samples
+
+  - Bump to latest samples ([changes](https://github.com/sharpdx/SharpDX/commit/e4e820ea5d1fcd98fe4199be299b5de4831d6758))
+
+## SharpGen
+
+  - StringToHGlobalUni is not necessary since it is already the same layout as .NET strings, use &quot;fixed&quot; instead ([changes](https://github.com/sharpdx/SharpDX/commit/b448930e70db16405f1d6963e402c24176161123))
 
-Best,
-xoofx