Update docs for release.

This commit is contained in:
the_fiddler 2008-01-15 16:39:32 +00:00
parent b3ab36eb44
commit a9223830c8
5 changed files with 127 additions and 36 deletions

View file

@ -1,5 +1,42 @@
[Legend: complete('+') | WIP('*') | missing('-')]
-----------------------
OpenTK 0.3.13 -> 0.9.0
-----------------------
Minor version changed to reflect current progress.
+ Bind
+ Improved token matching rule. More tokens will reference actual enums now, instead of referencing Enums.All.
+ Initial work on duplicate enum removal (still disabled).
+ 'Public' specifier not specified on the generated classes anymore. This is now controlled in the *Helper.cs files.
+ Fixed a couple of possible NRE exceptions.
+ Build
+ Now generates xml documentation on release builds.
+ OpenTK
+ Fonts
+ Fixed a bug in the VboTextPrinter implementation (still disabled).
+ OpenAL
+ AL, Alc, Alu and Alut bindings.
+ Inline documentation.
+ OpenGL
+ Version12-Version21 enums removed in favour of specific tokens.
+ A few new function overloads.
+ Platform
+ Added several new functions to the Windows and X11 namespaces (mouse handling, coordinate transformations, current context query)
+ Initial support for garbage collection of OpenGL resources (disabled).
+ Support for Win 9x and 2000 platforms through new WMInput InputDriver implementation.
+ Fixes to WinRawInput driver (disabled due to memory leaks).
+ GameWindow
+ Now uses GLContext instead of Win/X11GLContext.
+ Math
+ Fix to Vector4.Perspective()
+ Examples
+ Hidden examples now displayed on Ctrl+F1.
+ Bugfixes to GLSL and VBO examples.
+ Input logger works again (hidden example).
-----------------------
OpenTK 0.3.12 -> 0.3.13

View file

@ -1,15 +1,31 @@
Many thanks to the people who have contributed to OpenTK:
The following people have contributed towards making OpenTK what it is. Thank you!
* Andy Gill (andyggill@gmail.com)
Math toolkit: Vector2/3/4, Matrix4, Quaternions
* Beau Gunderson
Windows FSAA patch.
* Christoph Brandtner
OpenAL bindings
Updated OpenGL tokens
* Erik Ylvisaker
Linux support (GLContext on linux)
Glx bindings.
* James Talton
GTK GLWidget
* Per
Fix for flickering GLControl
* Beau Gunderson
Windows FSAA patch.
Double precision math toolkit
* Kostas Soulakellis
OpenTK logo
* Andy Gill (andyggill@gmail.com)
Math toolkit: Vector2/3/4, Matrix4, Quaternions
* Per
Fix for flickering GLControl

View file

@ -1,6 +1,10 @@
The MIT License
Copyright (c) 2006, 2007 Stefanos Apostolopoulos except where noted.
Copyright (c) 2006, 2007 the OpenTK team, except where noted.
The OpenTK team consists of:
Stefanos Apostolopoulos
Christoph Brandtner
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

View file

@ -1,45 +1,81 @@
================================================================================
=================================================================================
OpenTK 0.3.13.3 Alpha Release notes
OpenTK 0.9.0 Alpha Release notes
IMPORTANT: This release is intended for testing and experimentation only. Use at your own risk!
--------------------------------------------------------------------------------
---------------------------------------------------------------------------------
0.3.13 Highlights:
0.9.0 marks the second important milestone in OpenTK development: OpenAL support.
Inertia, now member of the development team, had made this possible. He has also
worked on improving the OpenGL interface by revising the specs. We think the new
OpenTK.OpenGL interface is *much* more elegant and safe than vanilla C/OpenGL.
* 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.
On another note, Mono 1.2.6 has been released, which fixes almost all runtime
problems encountered by OpenTK. Updating is strongly recommended!
* 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.
Last, but not least, http://www.opentk.com now marks the new homepage for OpenTK.
The new site is much more usable (and faster!)
* 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).
Once again, thanks to everyone who made this release possible. If you find OpenTK
useful, please say so in the forums.
* Feature: OpenTK logo by Kostas Soulakellis.
Till next time!
- Stephen A.
* 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.
---------------------------------------------------------------------------------
Release highlights
* Feature: OpenAL support (AL, ALC, ALU, ALUT)
* Feature: OpenGL Version12-Version21 enums removed. Specific tokens used now.
* Feature: Windows 9x and 2000 support.
* Feature: GLContext, GLControl and GameWindow are completely modular now.
* Feature: GameWindow.Exit() now is thread-safe.
* Feature: Internal work on Garbage Collection of OpenGL resources.
* Feature: Redesigned homepage.
* Bugfix: New InputDriver for Windows takes care of memory leaks.
* Bugfix: Mouse now works the same under Windows and Linux/X11.
* Known issue (Linux): OpenTK programs may exhibit instability under Mesa3d 6.5.x and/or Mono 1.2.4. Please update to Mesa3d 7.0.x and Mono 1.2.6.
* 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): "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 (Linux): "Extensions" example only works on Mono 1.2.6.
* Known issue (Linux): "Textures" example does not work on Mono 1.2.5.
* Known issue (All): Only a limited number of font glyphs are supported.
* Known issue (All): Some commandline arguments in "Bind" do not work.
--------------------------------------------------------------------------------
OpenTK homepage: http://opentk.sourceforge.net/
---------------------------------------------------------------------------------
Porting notes
#################################################################################
# #
# Updating to Mono 1.2.6 is strongly recommended #
# #
#################################################################################
0.9.0 contains a few breaking changes, compared to 0.3.13 and previous releases.
These include:
1) Version12-Version21 enums no longer exist. This affects many OpenGL functions,
including VBO- and GLSL-related ones. The necessary enum is shown in the function
signature. In the unlikely case that a token is missing from the new enums,
please report a bug at http://www.opentk.com/forum/1
2) Updates to internal GLControl and GLContext interfaces may have side-effects.
Please report anything strange you encounter at http://www.opentk.com/forum/1
---------------------------------------------------------------------------------
OpenTK homepage: http://www.opentk.com
The latest version is always available at http://sourceforge.net/projects/opentk
Living on the edge? 'svn co https://opentk.svn.sourceforge.net/svnroot/opentk/trunk opentk'
================================================================================
=================================================================================

View file

@ -47,7 +47,6 @@ OpenTK.Input todos:
+ Implement Joystick input.
Examples:
+ Add more Tutorials and WinForms examples.
@ -57,5 +56,4 @@ OpenTK.Math todos:
OpenTK.OpenAL todos:
+ Start researching the OpenAL module.
+ Take a look at the OpenALDotNet wrapper.
+ Audio format loaders.