ryujinx/Opentk
1
0
Fork 0
mirror of https://github.com/Ryujinx/Opentk.git synced 2024-12-23 07:55:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

[Docs] Updated documentation for July 2014 release

Browse source
This commit is contained in:
thefiddler 2014-07-21 14:28:24 +02:00
parent 358b4ddf35
commit 3961b1ffcc
2 changed files with 43 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
Documentation/Todo.txt
View file

@ -7,6 +7,11 @@
- Implement touch input API. - Implement touch input API.
- Implement force feedback API. - Implement force feedback API.
- Add Portable Class Library (PCL) target. - Add Portable Class Library (PCL) target.
- Add OpenCL support.
- Add OpenGL ES 3.1 support.
- Port to Linux/Wayland.
- Port to Blackberry (WIP at https://github.com/rcmaniac25/opentk).
- Port to Tizen.
[Hard] [Hard]
- Merge with mono/opentk. - Merge with mono/opentk.

65
README.md
View file

@ -1,7 +1,9 @@
OpenTK OpenTK
====== ======
The Open Toolkit is an advanced, low-level C# library that wraps OpenGL, OpenGL ES and OpenAL. It is suitable for games, scientific applications and any other project that requires 3d graphics, audio or compute functionality. The Open Toolkit library is a fast, low-level C# binding for OpenGL, OpenGL ES and OpenAL. It runs on all major platforms and powers hundreds of apps, games and scientific research.
Use OpenTK to add cross-platform 3d graphics, audio, compute and haptics to your C# application. Integrate it into your existing user interface or use it standalone without any external dependencies.
Project website: http://www.opentk.com/ Project website: http://www.opentk.com/
@ -12,7 +14,7 @@ Features
======== ========
- Create cutting-edge graphics with OpenGL 4.4 and OpenGL ES 3.0 - Create cutting-edge graphics with OpenGL 4.4 and OpenGL ES 3.0
- Spice up your GUI with 3d graphics - Spice up your GUI with 3d acceleration
- Improve your code flow with strong types and inline documentation - Improve your code flow with strong types and inline documentation
- Write once run everywhere - Write once run everywhere
@ -32,47 +34,48 @@ Alternatively, download the [OpenTK binaries](http://www.opentk.com) and:
2. Use "Add reference" to add OpenTK.dll as a project reference 2. Use "Add reference" to add OpenTK.dll as a project reference
3. Use "Add files" to add OpenTK.dll.config to your project, and enable the "Copy to Output Directory" option. 3. Use "Add files" to add OpenTK.dll.config to your project, and enable the "Copy to Output Directory" option.
If you wish to build OpenTK from source, simply double-click OpenTK.sln and build through your IDE. Alternatively, open a command prompt and type: To build OpenTK from source, simply double-click OpenTK.sln and build through your IDE.
Alternatively, open a command prompt and type:
``` ```
msbuild /p:Configuration=Release OpenTK.sln # Windows git clone https://github.com/opentk/opentk # Download source code from git
xbuild /p:Configuration=Release OpenTK.sln # Linux and Mac OS X cd opentk # Enter the source directory
msbuild /p:Configuration=Release OpenTK.sln # Build on .Net (Windows)
xbuild /p:Configuration=Release OpenTK.sln # Build on Mono (Linux / Mac OS X)
``` ```
News News
==== ====
OpenTK 1.1.3 was released on 20 June 2014. OpenTK 1.1.4 was released on 21 July 2014.
This release resolves a number of identified issues and synchronizes the OpenGL and OpenGL ES bindings with the June 2014 Khronos specifications. This release resolves a number of identified issues, adds experimental support for Linux/KMS and synchronizes the OpenGL and OpenGL ES bindings with the July 2014 Khronos specifications.
**Changelog:** **Changelog:**
1. Fixed a potential crash in bindings accepting a string array. 1. Fixed a memory leak in OpenGL functions accepting a string array.
2. Fixed a marshalling issue where bindings might return an incorrect boolean value on some architectures. 2. Fixed an issue where `MakeCurrent()` might fail on Linux/X11 when using the Nvidia closed-source drivers.
3. Fixed a regression where mouse scrolling coordinates on Linux where flipped. Mouse scrolling now uses identical coordinate systems on Windows, Linux and Mac OS X: (+x, +y) = (right, up). 3. Fixed an issue where `GameWindow` might remain open on Linux/X11 after calling `Close()` or `Dispose()`.
4. Fixed a potential deadlock when exiting the X11/XInput2 subsystem. 4. Fixed a potential crash on Mac OS X systems without hardware acceleration (e.g. virtual machines).
5. Fixed an issue where single-to-half floating point conversions would return incorrect results for specific numbers. 5. Fixed function parameters for the `OES_byte_coordinates` extension.
6. Added an API compatibility test - backwards-incompatible changes will now cause a compilation failure in the continuous integration server. 6. Improved OpenGL and OpenGL ES documentation on 'count' parameters.
7. New platform: XQuartz (X11 over Mac OS X). 7. New platform: Linux/KMS. You can now run OpenTK applications on a Linux terminal without an X11 display server.
8. New platform: XWayland (X11 over Wayland). 8. New OpenGL ES extensions:
9. New OpenGL and OpenGL ES extensions: - ANDROID_extension_pack_es31a
- EXT_geometry_point_size
- EXT_primitive_bounding_box
- EXT_texture_array
- EXT_tessellation_point_size
OpenTK 1.1.3 is backwards compatible with 1.1.2. Users of previous versions are strongly encouraged to upgrade. OpenTK 1.1.4 is backwards compatible with 1.1.3. Users of previous versions are **strongly** encouraged to upgrade.
Known issues Known issues
============ ============
The SDL2 backend has a number of limitations compared to the native platform backends. In particular, SDL2 does not support: 1. The SDL2 backend has a number of limitations compared to the native platform backends. In particular, SDL2 does not support:
- `OpenTK.GLControl`. OpenTK will automatically use a native platform backend instead. - `OpenTK.GLControl`. OpenTK will automatically switch to a native platform backend instead.
- `DisplayDevice.ChangeResolution()` without a fullscreen `INativeWindow`. - `DisplayDevice.ChangeResolution()` without a fullscreen `INativeWindow`.
- changing `INativeWindow.WindowBorder` once a window is created. - Switching between `WindowBorder.Fixed` and `WindowBorder.Resizable`.
- high-resolution mouse input. Additionally, it is limited to a single keyboard and mouse device. - High-resolution mouse input. Additionally, it is limited to a single keyboard and mouse device.
2. OpenTK.Input.GamePad.SetVibration is currently not implemented. This API will be implemented in a future release.
Contributing Contributing
@ -90,13 +93,12 @@ Some areas we could really use your help:
- New platforms: - New platforms:
- Native Client (NaCL) - Native Client (NaCL)
- Blackberry - Blackberry
- Raspberry PI
- Wayland - Wayland
- Mir - Mir
- WinRT (via ANGLE) - WinRT (via ANGLE)
- Linux KMS (EGL without X11)
- New features: - New features:
- Multitouch - Multitouch
- Force feedback
- Improved joystick support (HID backend for Windows, Linux) - Improved joystick support (HID backend for Windows, Linux)
Further ideas for improvement are always welcome! Further ideas for improvement are always welcome!
@ -140,6 +142,8 @@ http://www.opentk.com/project/license
API compatibility API compatibility
================= =================
OpenTK 1.1.4 is backwards compatible with 1.1.3.
OpenTK 1.1.3 is backwards compatible with 1.1.2. OpenTK 1.1.3 is backwards compatible with 1.1.2.
OpenTK 1.1.2 is backwards compatible with 1.1.1. OpenTK 1.1.2 is backwards compatible with 1.1.1.
@ -228,3 +232,10 @@ Change namespace:
- GL.DisableDriverControlQCOM -> GL.Qcom.DisableDriverControl - GL.DisableDriverControlQCOM -> GL.Qcom.DisableDriverControl
- GL.GetDriverControlsQCOM -> GL.Qcom.GetDriverControls - GL.GetDriverControlsQCOM -> GL.Qcom.GetDriverControls
- GL.GetDriverControlStringQCOM -> GL.Qcom.GetDriverControlString - GL.GetDriverControlStringQCOM -> GL.Qcom.GetDriverControlString
See also
========
[Delta Engine](http://deltaengine.net/), a high-level, open-source game engine.
[MonoGame](https://github.com/mono/monogame), an open-source, cross-platform implementation of XNA.