cave-story-solaris/external/SDL2/docs/README-porting.md
Clownacy ac465d29b4 Mean CMake dependency overhaul
I'm taking a page from Dolphin's book, and including copies of each
dependency's source code. This combines the ease of use of including
pre-built libraries instead of needing to navigate a package manager
 - as is (or was) the case for MSVC - with the portability of using
packages. Granted, this method's more of a jack of all trades,
master of none, since it's *less* user-friendly than prebuilt
packages (compilation times), and you don't get the per-distro
compatibility fixes you'd get from a package manager.

You can still use system libs if you want. In fact, it's still the
default behaviour: compiling the libs manually is just a fallback.
I'll add an option to force-enable this soon, however, since it's a
nicer way to produce static MSYS2 builds than the hackish nightmare
that I was using before. Not to mention, having my own copy of the
sources means I can provide my own fixes and tweaks your package
manager may not. For example, I can combine MSYS2's FreeType
subpixel rendering with vcpkg's fix for SDL2 exporting its symbols
in static builds.
2019-04-26 01:52:02 +01:00

2 KiB

Porting

  • Porting To A New Platform

    The first thing you have to do when porting to a new platform, is look at include/SDL_platform.h and create an entry there for your operating system. The standard format is "PLATFORM", where PLATFORM is the name of the OS. Ideally SDL_platform.h will be able to auto-detect the system it's building on based on C preprocessor symbols.

There are two basic ways of building SDL at the moment:

  1. The "UNIX" way: ./configure; make; make install

    If you have a GNUish system, then you might try this. Edit configure.in, take a look at the large section labelled:

    "Set up the configuration based on the host platform!"

    Add a section for your platform, and then re-run autogen.sh and build!

  2. Using an IDE:

    If you're using an IDE or other non-configure build system, you'll probably want to create a custom SDL_config.h for your platform. Edit SDL_config.h, add a section for your platform, and create a custom SDL_config_{platform}.h, based on SDL_config_minimal.h and SDL_config.h.in

    Add the top level include directory to the header search path, and then add the following sources to the project:

    src/.c src/atomic/.c src/audio/.c src/cpuinfo/.c src/events/.c src/file/.c src/haptic/.c src/joystick/.c src/power/.c src/render/.c src/render/software/.c src/stdlib/.c src/thread/.c src/timer/.c src/video/.c src/audio/disk/.c src/audio/dummy/.c src/filesystem/dummy/.c src/video/dummy/.c src/haptic/dummy/.c src/joystick/dummy/.c src/main/dummy/.c src/thread/generic/.c src/timer/dummy/.c src/loadso/dummy/*.c

Once you have a working library without any drivers, you can go back to each of the major subsystems and start implementing drivers for your platform.

If you have any questions, don't hesitate to ask on the SDL mailing list: http://www.libsdl.org/mailing-list.php

Enjoy! Sam Lantinga (slouken@libsdl.org)