Documentation updates in preparation for release.

This commit is contained in:
the_fiddler 2007-11-12 08:34:27 +00:00
parent 088194bf1a
commit fcf6b86b20
4 changed files with 88 additions and 21 deletions

View file

@ -1,5 +1,54 @@
[Legend: complete('+') | WIP('*') | missing('-')]
-----------------------
OpenTK 0.3.12 -> 0.3.13
-----------------------
+ Bind
+ New transformation to OpenGL enums follows .Net naming conventions (PascalCase, no_underscores).
+ Void* parameters are turned to IntPtr, to improve interop with .Net BCL methods (e.g. BitmapData.Scan0).
+ Now generates only one ref/array/pointer overload for each function, not all possible permutations. Brings Glu down to ~40KB of code (was ~3MB before). Improves compilation times.
+ Improved layout of generated code. Removed some generated local variables (improves speed).
+ Build
+ Now copies example data to output directory.
+ OpenTK
+ Platform
+ Improved [..]GLNative shutdown sequence for all platforms. Fixes shutdown crash under Linux.
+ Removed X11GLControl, WinGLControl. The platform specific code is handled in the WindowInfo and GLContext classes.
+ Added VSync support to Windows. Linux will obtain this on next release.
+ GameWindow
+ Improved timing precision.
+ More detailed timing information available.
+ Can now set target UpdateFrame and RenderFrame periods during runtime.
+ VSync support.
+ Improved GameWindow.Exit() handling.
+ Removed obsolete GameWindow.Create and GameWindow.Destroy events.
+ Math
+ Andy Gill implemented Vector2/3/4, Matrix4 and Quaternion methods for OpenTK.Math.
+ Added Box2 struct which defines a rectangular region. Used in OpenTK.Fonts (see below).
- Removed (float*) and (IntPtr) cast operators from Vector234. Added this[] operator.
+ Fonts
+ High quality Texture fonts on all supported platforms (TextureFont class).
+ TextPrinter to draw text on all supported platform (TextPrinter class).
+ OpenGL
+ .Net naming conventions.
+ Many, many more function overloads.
+ Smaller and faster.
+ Examples
+ Improved example layout. Now every example contains a Main() method, exactly like it would be if it wasn't launched by the ExampleLauncher.
+ Added ExampleAttribute.
+ Added Fonts, Textures and Text examples.
+ Improved GLSL example (now loads the shader from disk, uses VBO).
- Disabled Vertex Array and Lighting examples, as they were seriously broken.
+ Background changed to Color.SteelBlue for all examples.
+ Kostas Soulakellis created a logo for the OpenTK library. A scaled-down image of the first version is used in the Textures example.
-----------------------
OpenTK 0.3.11 -> 0.3.12
-----------------------

View file

@ -0,0 +1,15 @@
Many thanks to the people who have contributed to OpenTK:
* Erik Ylvisaker
Linux support (GLContext on linux)
Glx bindings.
* James Talton
GTK GLWidget
* Per
Fix for flickering GLControl
* Beau Gunderson
Windows FSAA patch.
* Kostas Soulakellis
OpenTK logo
* Andy Gill (andyggill@gmail.com)
Math toolkit: Vector2/3/4, Matrix4, Quaternions

View file

@ -1,36 +1,42 @@
================================================================================
OpenTK 0.3.12.4 WIP Release notes
OpenTK 0.3.13.3 Alpha Release notes
IMPORTANT: This release is intended for testing and experimentation only. Use at your own risk!
--------------------------------------------------------------------------------
Highlights:
0.3.13 Highlights:
* Feature: Mouse input support.
* Feature: Two new tutorials (T02: Vertex Arrays) and (T04: Vertex Lighting) showcase the relevant OpenGL features.
* Feature: A new Test (S03: Extensions) uses reflection to obtain a list of extensions supported by your hardware. See known issues!
* Feature: GameWindow.Title property to retrieve or set the title of the GameWindow.
* Feature: GameWindow.Run() can now set a target update and render frequency.
* Feature: Improved GameWindow events. No need to call base functions on inheriting classes (i.e. base.OnRenderFrame inside the OnRenderFrame override).
* Feature: Optimized GL.LoadAll().
* Feature: Vector2, Vector3 and Vector4 structs, with associated math functions. NOT READY FOR USE YET, INTERFACE WILL CHANGE.
* Feature: Math toolkit (Vector2/3/4, Matrix4, Quaternion and Box2 structs). Implemented by Andy Gill.
* Feature: Texture font support. Cross-platform, high quality, high speed.
* Feature: Size of OpenTK.dll cut down by a factor of two. Build speed improved by a factor of ten.
* Bug fix: Missing Key mapping in Windows and Linux in Keyboard drivers.
* Bug fix: Resize event was raised twice during GameWindow startup.
* Feature: Two new examples show the use of fonts ("Fonts" and "Text" examples).
* Feature: "Textures" example shows how to load a texture with the System.Drawing.Bitmap class.
* Feature: Improved GameWindow.Run() timing. New timing-related properties.
* Known issue (Windows): GameWindow may become unstable after extended mouse movements on Windows. Probably due to an (unknown) OpenTK MouseDevice driver bug.
* Known issue (Linux): ExampleLauncher abruptly shuts down when closing a GameWindow through the 'X' (close) button.
* Feature: VSync support for GameWindow, GLControl, GLContext.
* Feature: Improved GameWindow.Exit() behavior. Now immediately starts the shutdown sequence (no need to return from OnUpdateFrame/OnRenderFrame/etc, first).
* Feature: OpenTK logo by Kostas Soulakellis.
* Bug fix (Linux): GameWindow no longer crashes on exit under Linux, when closed with the 'X' button.
* Bug fix (Linux): GLSL example no longer crashes with a glibc error when shutting down.
* Bug fix (all): IntPtr's passed to void* parameters called the object overload, not the void* one.
* Known issue (Windows): WinRawMouse MouseDriver generates garbage.
* Known issue (Windows): A first chance GameWindowExitException may be caught by the Visual Studio debugger. This is harmless and does not indicate an error - just continue the debugging session normally.
* Known issue (Linux): OpenTK programs may exhibit instability under Mesa3d 6.5.x and/or Mono 1.2.4. Update to Mesa3d 7.0.x and Mono 1.2.5 to resolve this.
* Known issue (Linux): DisplayModes with 32-bit bit-depths exhibit flashing under Mesa3d 6.5.x. Is a Mesa3d problem, update to Mesa3d 7.0.x or request a 24-bit depth.
* Known issue (Linux): Example T10: "GLSL Cube" may report a glibc error when shutting down.
* Known issue (Linux): Example S03: "Extensions" crashes under Mono 1.2.x
* Known issue (Linux): Example T04: "Vertex Lighting" may exhibit incorrect lighting under some circumstances (Mesa3d 7.0.x)
* Known issue (Linux): "Extensions" example crashes under Mono 1.2.x, where x < 6.
* Known issue (Linux): "Textures" example displays corrupt texture under linux. Investigating.
* Known issue (All): TextureFont's are currently limited to one font sheet and new glyphs will fail when the sheet becomes full. This limitation will be lifted in later versions. For now mitigate the issue by loading the largest-sized fonts first.
* Known issue (All): Some commandline arguments in "Bind" do not work.
--------------------------------------------------------------------------------
For support, bug reports, feature requests and flames, visit the OpenTK site: http://opentk.sourceforge.net/
OpenTK homepage: http://opentk.sourceforge.net/
The latest version is always available at http://sourceforge.net/projects/opentk

View file

@ -53,9 +53,6 @@ Examples:
OpenTK.Math todos:
* Test Vectors.
+ Add Matrices
+ Add Quaternions.
+ Add Noise module.