From 74ffc720846f556d631b2d174389c0787e3d2839 Mon Sep 17 00:00:00 2001 From: DeaDDooMER Date: Wed, 7 Feb 2018 02:31:09 +0300 Subject: [PATCH] add readme --- README | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..fa26dc5 --- /dev/null +++ b/README @@ -0,0 +1,44 @@ +This repo contains bindings to SDL2, SDL2_image and modern OpenGL for BlackBox. +Windows version and Linux version switched using selectors OS:Win32 and +OS:Linux32. + + + +SDL2 and SDL2_image bindings hand writed and not fully, but most functions +implemented. +About implementation: +- Prefixes SDL_ and IMG_ removed, prefix SDLK_ renamed to K_. +- Structures that can only be pointers(like struct Window) already binded as +pointers to limited records. +- C types binded as Int, Long, SizeT, Uint, Enum, STR and PtrSTR. +- SDL_bool renamed to Bool. +- Procedure GetClosestDisplayMode returns Int instead pointer(possibly to local +variable). +- Everywhere used IN-params, VAR-params when possibly and read-only fields in +accordance with documentation. + +Module SDL2Lib / SDL2Image binds functions, types and consants. +Module SDL2Macro implements inline functions and macroses. +Module SDL2Test just a sample how to use SDL2 in BlackBox. + + + +OpenGL bindings generated from gl.xml (fresh version can be founded there +https://github.com/KhronosGroup/OpenGL-Registry). +About implementation: +- Prefixes not removed. +- Call procedure SDL2GL.Init after context creation. +- Pointer prameters binded as VAR-params. + +Module SDL2GL contains all constants, types and procedures. +Module SDL2GLGen is utility for binding generation. It contains shitcode +depends on subsystem Xmlcore(http://www.zinnamturm.eu/downloadsTZ.htm#Xmlcore). + + + +Todo: +- Some c headers and macroses (see sources). +- Cpu-dependent procedures using [code]. +- Test everything. +- Documentation. +- Samples. -- 2.29.2