mirror of
https://github.com/Ryujinx/SDL2-CS.git
synced 2024-09-28 19:51:03 +00:00
58 lines
1.9 KiB
Plaintext
58 lines
1.9 KiB
Plaintext
This is SDL2#, a C# wrapper for SDL2.
|
|
|
|
Project Website: https://github.com/flibitijibibo/SDL2-CS
|
|
|
|
License
|
|
-------
|
|
SDL2 and SDL2# are released under the zlib license. See LICENSE for details.
|
|
|
|
SDL2# currently uses parts of OpenTK, which is released under the MIT license.
|
|
See opentk.LICENSE for details.
|
|
|
|
About SDL2
|
|
----------
|
|
For more information about SDL2, visit the SDL wiki:
|
|
|
|
http://wiki.libsdl.org/moin.fcg/FrontPage
|
|
|
|
About the C# Wrapper
|
|
--------------------
|
|
The C# wrapper was written to be used for FNA's platform support. However, this
|
|
is written in a way that can be used for any general C# application.
|
|
|
|
The wrapper provides bindings for the following libraries:
|
|
- SDL2
|
|
- SDL2_image
|
|
- SDL2_mixer
|
|
- SDL2_ttf
|
|
|
|
We also provide bindings for OpenGL and OpenAL, taken from OpenTK.
|
|
|
|
Note that SDL2# will not provide every single SDL2 function. This is due to
|
|
limitations in the C# language that would cause major conflicts with the native
|
|
SDL2 library and its extensions.
|
|
|
|
SDL2# is a pure port of the C headers. The naming schemes for this library will
|
|
be exactly as they are done in the C library, with little-to-no concern for
|
|
"appropriate" C# style. The namespace indicates that this is SDL2, the class
|
|
names will indicate which library file the function/type/value exists in, and
|
|
everything else will be as close to the C version as technically possible.
|
|
|
|
Using MiniTK
|
|
------------
|
|
To use the OpenGL/OpenAL bindings, simply use them as you were with OpenTK,
|
|
but after calling SDL_GL_CreateContext, add the following lines:
|
|
|
|
OpenTK.Graphics.GraphicsContext.CurrentContext = yourContextIntPtr;
|
|
GL.LoadAll();
|
|
|
|
This will load the OpenTK entry points. It is strongly recommended that you
|
|
load your own entry points using SDL_GL_GetProcAddress and delegates, but
|
|
this has been provided for OpenTK compatibility.
|
|
|
|
Roadmap
|
|
-------
|
|
To see the current roadmap for SDL2#, visit the GitHub issues page:
|
|
|
|
https://github.com/flibitijibibo/SDL2-CS/issues
|