Changeset 103

Show
Ignore:
Timestamp:
04/17/05 11:48:06 (4 years ago)
Author:
aldacron
Message:

* added missing Linux build instructions to DerelictAL/GL/GLU READMEs
* cut the USING sections from the DerelictAL/GL READMEs and added them to the new al.html and gl.html in the docs folder
* updated docs/index.html with links to the new documentation
* touched up some formatting in the DerelictSDL README

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/DerelictAL/README

    r74 r103  
    1 ================================================================================ 
    2 DerelictAL 
    3 ================================================================================ 
    4 DerelictAL is a D package which allows you to use OpenAL in your D programs 
    5 without the need to link to an import library. This gives you control over how 
    6 to handle the case where the OpenAL shared library is not available on the 
    7 user's machine. 
    8  
    9 It should be noted that some functions have been omitted from the DerlictAL 
    10 binding. This was done either because they are marked as unused or are marked to 
    11 be removed in the future. Also, no bindings for the alut* were included at this 
    12 time. The alu* functions are included, but they are only compiled into the 
    13 Windows version of the OpenAL so will not be available on other platforms when 
    14 DerelictAL is ported (unless newer versions of OpenAL are released which include 
    15 said functions). 
    16  
    17 Please note that the Linux version is not yet implemented. Anyone who would like 
    18 to do so please let me know in the forum! 
    19  
    20 -------------------------------------------------------------------------------- 
    21 USING 
    22 -------------------------------------------------------------------------------- 
    23 You can use DerelictAL in your project by first adding the Derelict source path 
    24 to your compile command line with the -I switch (-I<derelict_dir>/DerelictAL) and 
    25 either by adding all the source/obj files to your makefile, or by building and 
    26 linking with DerelictAL.lib (see the section entitled 'BUILDING' below for build 
    27 instructions). 
    28  
    29 In your code, you need to import the derelict.openal.al module. 
    30  
    31 ++++++++++++++++++++++++++   CODE  +++++++++++++++++++++++++++++++++++++++++++++ 
    32  
    33 import derelict.openal.al; 
    34  
    35 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 
    36  
    37 Before calling any OpenAL functions, you need to make a call to DerelictAL_Load.  
    38 This will load the shared library. 
    39  
    40 ++++++++++++++++++++++++++   CODE  +++++++++++++++++++++++++++++++++++++++++++++ 
    41  
    42 // load the shared library and all standard OpenAL functions via DerelictAL 
    43 DerelictAL_Load(); 
    44  
    45 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 
    46  
    47 Because not all applications may wish to use the alu* functions, the loading 
    48 of these functions has been separated from the rest of the OpenAL functions. This 
    49 is so that DerelictAL_Load will not fail if any alu* functions are missing when 
    50 you don't need them anyway. As such, you must make a call to DerelictAL_LoadALU 
    51 in order to load the alu* functions. 
    52  
    53 NOTE: This is available on Windows only until the alu* functions are implemented 
    54 on other platforms by the OpenAL folks. 
    55  
    56 ++++++++++++++++++++++++++   CODE  +++++++++++++++++++++++++++++++++++++++++++++ 
    57  
    58 // load the alu functions via DerelictAL_LoadALU 
    59 DerelictAL_LoadALU(); 
    60  
    61 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 
    62  
    631-------------------------------------------------------------------------------- 
    642BUILDING 
    653-------------------------------------------------------------------------------- 
    664 
     5-------------------------------------------------------------------------------- 
    676To build DerelictAL on Windows: 
    687 
    …… 
    72114) optionally type 'make clean' to delete all object files OR 
    7312   optionally type 'make cleanall' to delete all object and lib files 
     13 
     14-------------------------------------------------------------------------------- 
     15To build DerelictAL on Linux: 
     16 
     171) ensure that both dmd and gcc are on your path 
     182) from a command prompt, cd to <derelict_dir>/DerelictAL 
     193) type 'make -fMakefule.linux' or 'make -fMakefule.linux all' to build libderelictAL.a 
     204) optionally type 'make -fMakefule.linux clean' to delete all object files OR 
     21   optionally type 'make -fMakefule.linux cleanall' to delete all object and lib files 
     22 
     23-------------------------------------------------------------------------------- 
     24USING 
     25--------------------------------------------------------------------------------    
     26To learn how to use DerelictAL, please see the documentaion in derelict/docs/al.html. 

  • trunk/DerelictGL/README

    r74 r103  
    1 ================================================================================ 
    2 DerelictGL 
    3 ================================================================================ 
    4 DerelictGL is a D package which allows you to use OpenGL in your D programs 
    5 without the need to link to an import library. This gives you control over how 
    6 to handle the case where the OpenGL shared library is not available on the 
    7 user's machine. 
    8  
    9 Please note that the Linux version is not yet implemented. Anyone who would like 
    10 to do so please let me know in the forum! 
    11  
    12 -------------------------------------------------------------------------------- 
    13 USING 
    14 -------------------------------------------------------------------------------- 
    15 You can use DerelictGL in your project by first adding the Derelict source path 
    16 to your compile command line with the -I switch (-I<derelict_dir>/DerelictGL) and 
    17 either by adding all the source/obj files to your makefile, or by building and 
    18 linking with derelictGL.lib (see the section entitled 'BUILDING' below for build 
    19 instructions). 
    20  
    21 In your code, you need to import the derelict.opengl.gl module. 
    22  
    23 ++++++++++++++++++++++++++   CODE  +++++++++++++++++++++++++++++++++++++++++++++ 
    24  
    25 import derelict.opengl.gl;      // core GL 1.1 functions 
    26  
    27 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 
    28  
    29 Before calling any OpenGL functions, you need to make a call to DerelictGL_Load.  
    30 This will load the shared library, platform-specific core gl functions 
    31 (such as the wgl* functions on Windows), and all core GL 1.1 functions. If 
    32 you only require OpenGL 1.1, then you are finished initializing DerelictGL and 
    33 can go on about your business. 
    34  
    35  
    36 ++++++++++++++++++++++++++   CODE  +++++++++++++++++++++++++++++++++++++++++++++ 
    37  
    38 // load the shared library and Core 1.1 functions via DerelictGL 
    39 DerelictGL_Load(); 
    40  
    41 // app-specific code to init an OpenGL context goes here 
    42 ... 
    43  
    44  
    45 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 
    46  
    47  
    481-------------------------------------------------------------------------------- 
    492BUILDING 
    503-------------------------------------------------------------------------------- 
    514 
     5-------------------------------------------------------------------------------- 
    526To build DerelictGL on Windows: 
    537 
    …… 
    57114) optionally type 'make clean' to delete all object files OR 
    5812   optionally type 'make cleanall' to delete all object and lib files 
     13    
     14-------------------------------------------------------------------------------- 
     15To build DerelictGL on Linux: 
    5916 
     171) ensure that both dmd and gcc are on your path 
     182) from a command prompt, cd to <derelict_dir>/DerelictFL 
     193) type 'make -fMakefule.linux' or 'make -fMakefule.linux all' to build libderelictGL.a 
     204) optionally type 'make -fMakefule.linux clean' to delete all object files OR 
     21   optionally type 'make -fMakefule.linux cleanall' to delete all object and lib files 
     22 
     23-------------------------------------------------------------------------------- 
     24USING 
     25--------------------------------------------------------------------------------    
     26To learn how to use DerelictGL, please see the documentaion in derelict/docs/gl.html. 

  • trunk/DerelictGLU/README

    r74 r103  
    5151-------------------------------------------------------------------------------- 
    5252 
     53-------------------------------------------------------------------------------- 
    5354To build DerelictGLU on Windows: 
    5455 
    …… 
    58594) optionally type 'make clean' to delete all object files OR 
    5960   optionally type 'make cleanall' to delete all object, and lib files 
     61    
     62-------------------------------------------------------------------------------- 
     63To build DerelictGLU on Linux: 
     64 
     651) ensure that both dmd and gcc are on your path 
     662) from a command prompt, cd to <derelict_dir>/DerelictGLU 
     673) type 'make -fMakefule.linux' or 'make -fMakefule.linux all' to build libderelictGLU.a 
     684) optionally type 'make -fMakefule.linux clean' to delete all object files OR 
     69   optionally type 'make -fMakefule.linux cleanall' to delete all object and lib files 

  • trunk/DerelictSDL/README

    r72 r103  
    6666   optionally type 'make cleanall' to delete all object and lib files 
    6767    
    68    -------------------------------------------------------------------------------- 
     68-------------------------------------------------------------------------------- 
    6969To build DerelictSDL on Linux: 
    7070 

  • trunk/docs/index.html

    r102 r103  
    9393<h3>Package Documentation</h3> 
    9494<ul> 
    95 <li>DerelictAL</li> 
    96 <li>DerelictGL</li> 
     95<li><a href="al.html">DerelictAL</a></li> 
     96<li><a href="gl.html">DerelictGL</a></li> 
    9797<li>DerelictGLFW</li> 
    9898<li>DerelictGLU</li>