README.ds
changeset 5423 b69fa50e80d7
parent 5289 1916a9e9714d
child 5430 1b318d81c85f
     1.1 --- a/README.ds	Sat Mar 05 10:03:57 2011 -0800
     1.2 +++ b/README.ds	Sun Mar 06 21:12:19 2011 -0800
     1.3 @@ -3,17 +3,37 @@
     1.4  ================================================================================
     1.5  
     1.6  -Requirements-
     1.7 -The devkitpro SDK available at http://devkitpro.org.
     1.8 -Read the information at http://devkitpro.org/wiki/Getting_Started/devkitARM
     1.9 -The necessary packages are devkitARM, libnds and default arm7.
    1.10 +* The devkitpro SDK available at http://devkitpro.org.
    1.11 +  Read the information at http://devkitpro.org/wiki/Getting_Started/devkitARM
    1.12 +  The necessary packages are devkitARM, libnds and default arm7.
    1.13 +* The hardware renderer is using the libgl2d abstraction library that can be found at:
    1.14 +    http://rel.phatcode.net/junk.php?id=117
    1.15 +  Build it, and install the library and the header where SDL can find them (ie. in
    1.16 +  the libnds/lib and libnds/include directories).
    1.17 +
    1.18  
    1.19  -Building SDL-
    1.20 -After setting the devkitpro environment, type:
    1.21 +
    1.22 +After setting the devkitpro environment, cd into your SDL directory and type:
    1.23    make -f Makefile.ds
    1.24  
    1.25 -This will compile and install the library and headers into the proper libnds directories.
    1.26 -Additionnaly it will compile the general test, that you can run either on the DS or with desmume:
    1.27 +This will compile and install the library and headers into the proper libnds
    1.28 +directories. Additionnaly it will compile several tests that you can run
    1.29 +either on the DS or with desmume. For instance:
    1.30    desmume test/nds-test-progs/general/general.nds
    1.31  
    1.32 +-Notes-
    1.33 +* The renderer code is based on the gl like engine. It's not using the sprite engine.
    1.34 +* The port is very basic and incomplete:
    1.35 +  - SDL currently has to be compiled for either framebuffer mode or render mode.
    1.36 +     See USE_HW_RENDERER in Makefile.ds.
    1.37 +  - some optionnal renderer functions are not implemented.
    1.38  
    1.39 -Note that the port is very basic and incomplete.
    1.40 +-Limitations-
    1.41 +* in hardware renderer mode, don't load too many textures. The internal format is
    1.42 +  2 bytes per pixel. And there is only 256KB reserved for the textures. For instance,
    1.43 +  testscale won't display sample.bmp, unless it's resized to a smaller picture.
    1.44 +* the screen size is 256 x 384. Anything else won't work.
    1.45 +* there is no 8 bits/pixel mode because SDL 1.3 doesn't support palettes.
    1.46 +
    1.47 +