Personal tools

ALUT

From HaskellWiki

(Difference between revisions)
Jump to: navigation, search
(Windows specific actions: Removed instructions with the precompiled ALUT lib)
(Windows specific actions: Added instructions, using the freealut source code)
Line 11: Line 11:
 
== Windows specific actions ==
 
== Windows specific actions ==
  
'''N.B. This is work in progress'''
+
The following must be installed first:
 
+
* MSYS2 or MinGW/MSYS
Before installing the Haskell package, you need to install the C++ package of ALUT:
+
* [[OpenAL]]
 +
* The C++ package of ALUT, freealut
  
 +
To install freealut:
 +
* Start a shell
 +
* Go to the directory where you want the freealut source code, for example <code>C:\Temp</code>
 +
* Fetch the source code with [[Git]]:
 +
: <code>git clone https://github.com/vancegroup/freealut.git</code>
 +
* Install [https://cmake.org/ CMake]
 +
* Start cmake-gui
 +
* Enter the directory of the freealut source code (<code>C:\Temp\freealut</code>) and the directory where you want the compile result, for example <code>C:\Temp\freealut\build</code>
 +
* Add the entries in the table below, by pressing "Add Entry" for each entry
 +
{|
 +
| Name
 +
| Type
 +
| Value
 +
|-
 +
| <code>CMAKE_GENERATOR</code>
 +
| <code>String</code>
 +
| <code>MinGW Makefiles</code>
 +
|-
 +
| <code>OPENAL_INCLUDE_DIR</code>
 +
| <code>Filepath</code>
 +
| the directory containing the OpenAL header file
 +
|-
 +
| <code>CMAKE_INSTALL_PREFIX</code>
 +
| <code>Filepath</code>
 +
| <code>C:\Libraries\ALUT</code>
 +
|}
 +
* Press "Configure"
 +
* Press "Generate"; this will generate a makefile
 +
* In the shell, go to the directory where you want the compile result, for example <code>C:\Temp\freealut\build</code>
 +
* Start the MSYS shell:
 +
: <code>sh</code>
 +
* Run the make utility:
 +
: <code>sh</code>
 
* Set environment variables as follows:
 
* Set environment variables as follows:
 
<pre>
 
<pre>
 
Set LIBRARY_DIR=C:\Libraries
 
Set LIBRARY_DIR=C:\Libraries
Set C_INCLUDE_PATH=%LIBRARY_DIR%\freealut-1.1.0-bin\include;%C_INCLUDE_PATH%
+
Set C_INCLUDE_PATH=%LIBRARY_DIR%\ALUT\include;%C_INCLUDE_PATH%
Set LIBRARY_PATH=%LIBRARY_DIR%\freealut-1.1.0-bin\lib;%LIBRARY_PATH%
+
Set LIBRARY_PATH=%LIBRARY_DIR%\ALUT\lib;%LIBRARY_PATH%
Set PATH=%LIBRARY_DIR%\freealut-1.1.0-bin\lib;%PATH%
+
Set PATH=%LIBRARY_DIR%\ALUT\bin;%PATH%
 
</pre>
 
</pre>
 
:If you need these variables more often, set them [http://www.computerhope.com/issues/ch000549.htm permanently].
 
:If you need these variables more often, set them [http://www.computerhope.com/issues/ch000549.htm permanently].
 
+
:The directory <code>%LIBRARY_DIR%\ALUT\bin</code> contains libalut.dll; this DLL must always be in the search path when you run an ALUT-using application.
'''This is not sufficient to install the Haskell package ALUT; there will be linker errors'''
+
 
+
Maybe the C++ ALUT must be compiled from [https://github.com/vancegroup/freealut source]; this requires [https://cmake.org/ CMake] knowledge.
+
  
 
== Additional software ==
 
== Additional software ==

Revision as of 10:24, 15 October 2015

This article is a stub. You can help by expanding it.

A binding for the OpenAL Utility Toolkit


1 Downloads

2 Windows specific actions

The following must be installed first:

  • MSYS2 or MinGW/MSYS
  • OpenAL
  • The C++ package of ALUT, freealut

To install freealut:

  • Start a shell
  • Go to the directory where you want the freealut source code, for example C:\Temp
  • Fetch the source code with Git:
git clone https://github.com/vancegroup/freealut.git
  • Install CMake
  • Start cmake-gui
  • Enter the directory of the freealut source code (C:\Temp\freealut) and the directory where you want the compile result, for example C:\Temp\freealut\build
  • Add the entries in the table below, by pressing "Add Entry" for each entry
Name Type Value
CMAKE_GENERATOR String MinGW Makefiles
OPENAL_INCLUDE_DIR Filepath the directory containing the OpenAL header file
CMAKE_INSTALL_PREFIX Filepath C:\Libraries\ALUT
  • Press "Configure"
  • Press "Generate"; this will generate a makefile
  • In the shell, go to the directory where you want the compile result, for example C:\Temp\freealut\build
  • Start the MSYS shell:
sh
  • Run the make utility:
sh
  • Set environment variables as follows:
Set LIBRARY_DIR=C:\Libraries
Set C_INCLUDE_PATH=%LIBRARY_DIR%\ALUT\include;%C_INCLUDE_PATH%
Set LIBRARY_PATH=%LIBRARY_DIR%\ALUT\lib;%LIBRARY_PATH%
Set PATH=%LIBRARY_DIR%\ALUT\bin;%PATH%
If you need these variables more often, set them permanently.
The directory %LIBRARY_DIR%\ALUT\bin contains libalut.dll; this DLL must always be in the search path when you run an ALUT-using application.

3 Additional software

  • StateVar: This package contains state variables, which are references in the IO monad, like IORefs or parts of the OpenGL state
  • OpenAL 3D sound software
  • OpenGL 3D graphics software

An alternative to ALUT might be OALWrapper