Updated assembly information and documentation for the 0.9.7 release.
This commit is contained in:
the_fiddler
parent
3f41f1eaf5
commit
54f1dfc26c
5 changed files with 25 additions and 67 deletions
|
|
@ -1,5 +1,18 @@
|
|||
[Legend: complete('+') | WIP('*') | missing('-')]
|
||||
|
||||
---------------------
|
||||
OpenTK 0.9.6 -> 0.9.7
|
||||
---------------------
|
||||
+ Bind
|
||||
+ Fixed several suffixes that were incorrectly trimmed ("Instanced", "Indexed", "Varyings").
|
||||
+ CLS-compliant overloads now contain debugging stubs.
|
||||
|
||||
+ OpenTK
|
||||
+ Graphics
|
||||
* Initial support for OpenGL 3.1. Some functions and tokens aren't yet available in the specs - these will be added in due time.
|
||||
* Improved type-safety in the OpenGL 3.0 bindings.
|
||||
+ Automatic error checks now display stacktraces.
|
||||
|
||||
---------------------
|
||||
OpenTK 0.9.5 -> 0.9.6
|
||||
---------------------
|
||||
|
|
|
|||
|
|
@ -1,78 +1,24 @@
|
|||
The Open Toolkit 0.9.6 Beta -- Release notes
|
||||
The Open Toolkit 0.9.7 Beta -- Release notes
|
||||
|
||||
[ Overview]
|
||||
|
||||
This release introduces:
|
||||
* automatic OpenGL error checking;
|
||||
* generics for improved type-safety in the OpenGL bindings
|
||||
* bug fixes related to OpenGL 3.0 contexts on Linux
|
||||
* improved documentation in OpenTK.Graphics
|
||||
* a new EFX example ("EFX: Reverb").
|
||||
* OpenGL 3.1 support
|
||||
* improved OpenGL 3.0 bindings (type-safety)
|
||||
* improved automatic error checking (stack traces, better coverage)
|
||||
|
||||
Please report any issues you may encounter at http://www.opentk.com.
|
||||
|
||||
|
||||
[Known issues]
|
||||
|
||||
This release cannot be compiled on Mono due to a compiler bug
|
||||
(https://bugzilla.novell.com/show_bug.cgi?id=488960). Please
|
||||
use the precompiled binaries included in the release package.
|
||||
This release cannot be compiled on Mono due to a compiler bug (https://bugzilla.novell.com/show_bug.cgi?id=488960). Please use the precompiled binaries included in the release package.
|
||||
|
||||
|
||||
[API changes]
|
||||
|
||||
Please note that binary compatibility is not preserved between
|
||||
beta releases.
|
||||
Please note that binary compatibility is not preserved between beta releases.
|
||||
|
||||
OpenTK 0.9.6 replaces object overloads in OpenTK.Graphics
|
||||
with generics. For example GL.CallLists changes from:
|
||||
OpenTK 0.9.7 replaces several instances of the "All" and "Version30" enums with strongly-typed equivalents. This is a breaking change that potentially affects programs using OpenGL 3.0 functionality. If you are affected by this change, please replace the relevant instances of "All" or "Version30" with the correct enum, as reported by your IDE.
|
||||
|
||||
void CallLists(int n, object data)
|
||||
|
||||
to:
|
||||
|
||||
void CallLists<T>(int n, ref T data) where T : struct
|
||||
void CallLists<T>(int n, T[] data) where T : struct
|
||||
void CallLists<T>(int n, T[,] data) where T : struct
|
||||
void CallLists<T>(int n, T[,,] data) where T : struct
|
||||
|
||||
This change is intended to improve performance (no boxing)
|
||||
and type-safety in the OpenGL bindings.
|
||||
|
||||
This is a breaking change in the following cases:
|
||||
|
||||
Case: You pass parameters to the relevant function by value.
|
||||
Solution: Please pass the parameters by reference.
|
||||
|
||||
Case: You use 4d or higher-dimension arrays.
|
||||
Solution: Consider reducing the dimension of the array. If
|
||||
this is not possible, please pin the array and pass a pointer
|
||||
instead.
|
||||
|
||||
Case: You use jagged arrays.
|
||||
Solution: Jagged arrays are not safe for use with OpenGL.
|
||||
Please change to multi-dimension arrays.
|
||||
|
||||
Case: You use objects that do not satisfy the struct constraint.
|
||||
Solution: Reference types are not safe for use with OpenGL.
|
||||
Please use pure value types instead.
|
||||
|
||||
Pure value types are value types that recursively reference other
|
||||
value types only. For example, the following are pure value types:
|
||||
|
||||
struct Vector3 { public float X, Y, Z; }
|
||||
struct Color4 { public float R, G, B, A; }
|
||||
struct Vertex {
|
||||
public Vector3 Position;
|
||||
public Color4 Color;
|
||||
}
|
||||
|
||||
while the following are not:
|
||||
// reference type
|
||||
class Player { public Vector3 Position; }
|
||||
// value type that contains reference type
|
||||
struct Item { public Player Player; }
|
||||
|
||||
Only pure value types are safe for use with OpenGL. Future OpenTK
|
||||
releases will contain additional runtime checks to enforce this
|
||||
constraint.
|
||||
OpenTK 0.9.7 also fixes the naming of several core and extension functions ending in "Instanced", "Indexed" or "Varyings". If you are affected by this change, please add the missing 'd' or 's' to the relevant functions.
|
||||
|
|
@ -8,7 +8,6 @@
|
|||
+ Enforce PureValue constraint in generic classes.
|
||||
+ Improve performance for functions that take generic arrays.
|
||||
+ Fix documentation - parameter mismatches.
|
||||
+ Add GL3.1 support.
|
||||
|
||||
[OpenTK.Graphics.GraphicsContext]
|
||||
+ FSAA support (very simple, now that GL3 support has been added.)
|
||||
|
|
|
|||
|
|
@ -29,5 +29,5 @@ using System.Runtime.InteropServices;
|
|||
// Build Number
|
||||
// Revision
|
||||
//
|
||||
[assembly: AssemblyVersion("0.9.9.7")]
|
||||
[assembly: AssemblyFileVersion("0.9.9.7")]
|
||||
[assembly: AssemblyVersion("0.9.9.8")]
|
||||
[assembly: AssemblyFileVersion("0.9.9.8")]
|
||||
|
|
|
|||
|
|
@ -31,5 +31,5 @@ using System.Runtime.InteropServices;
|
|||
//
|
||||
// You can specify all the values or you can default the Revision and Build Numbers
|
||||
// by using the '*' as shown below:
|
||||
[assembly: AssemblyVersion("0.9.6.0")]
|
||||
[assembly: AssemblyFileVersion("0.9.6.0")]
|
||||
[assembly: AssemblyVersion("0.9.7.0")]
|
||||
[assembly: AssemblyFileVersion("0.9.7.0")]
|
||||
|
|
|
|||
Loading…
Reference in a new issue