Personal tools

OpenGL

From HaskellWiki

(Difference between revisions)
Jump to: navigation, search
(Getting Started: Added a link to "Haskell OpenGL Tutorial")
(Updated links)
Line 8: Line 8:
 
** [http://hackage.haskell.org/package/GLURaw GLURaw] is similar to OpenGLRaw, just for the GLU part of OpenGL.
 
** [http://hackage.haskell.org/package/GLURaw GLURaw] is similar to OpenGLRaw, just for the GLU part of OpenGL.
 
** [http://hackage.haskell.org/package/OpenGL OpenGL] is the high-level view on OpenGL, wrapping OpenGLRaw into something more Haskell-like.
 
** [http://hackage.haskell.org/package/OpenGL OpenGL] is the high-level view on OpenGL, wrapping OpenGLRaw into something more Haskell-like.
** [http://hackage.haskell.org/package/GLUT GLUT] is a binding for the [http://www.opengl.org/resources/libraries/glut/ OpenGL Utility Toolkit].
+
** [http://hackage.haskell.org/package/GLUT GLUT] is a binding for the [https://www.opengl.org/resources/libraries/glut/ OpenGL Utility Toolkit].
  
 
* The [http://www.haskell.org/mailman/listinfo/hopengl HOpenGL mailing list] can be used for all discussions regarding the use of OpenGL from Haskell.
 
* The [http://www.haskell.org/mailman/listinfo/hopengl HOpenGL mailing list] can be used for all discussions regarding the use of OpenGL from Haskell.
Line 14: Line 14:
 
* [https://github.com/ GitHub] hosts the [https://github.com/haskell-opengl/  haskell-opengl] organization for Haskell OpenGL development.
 
* [https://github.com/ GitHub] hosts the [https://github.com/haskell-opengl/  haskell-opengl] organization for Haskell OpenGL development.
  
The [https://github.com/haskell-opengl/GLUT/tree/master/examples examples] directory in the GLUT package contains lots of examples, including translations of the [http://www.opengl.org/documentation/books/#the_opengl_programming_guide_the_official_guide_to_learning_opengl_version Red Book] examples. Both the API documentation and theses examples are best studied with the [http://www.opengl.org/documentation/specs/ original specs] and the original Red Book examples at hand. An index of examples can be found at the OpenGL wiki page [http://www.opengl.org/wiki/Code_Resources Code Resources].
+
The [https://github.com/haskell-opengl/GLUT/tree/master/examples examples] directory in the GLUT package contains lots of examples, including translations of the [https://www.opengl.org/documentation/books/#the_opengl_programming_guide_the_official_guide_to_learning_opengl_version Red Book] examples. Both the API documentation and theses examples are best studied with the [https://www.opengl.org/documentation/specs/ original specs] and the original Red Book examples at hand. An index of examples can be found at the OpenGL wiki page [https://www.opengl.org/wiki/Code_Resources Code Resources].
  
  
Line 25: Line 25:
 
* [http://www.geocities.jp/takascience/haskell/monadius_en.html Monadius], a 2D scrolling arcade game.
 
* [http://www.geocities.jp/takascience/haskell/monadius_en.html Monadius], a 2D scrolling arcade game.
 
* [http://roguestar.downstairspeople.org/ Roguestar], a roguelike adventure game using 3D graphics.
 
* [http://roguestar.downstairspeople.org/ Roguestar], a roguelike adventure game using 3D graphics.
* [http://hackage.haskell.org/cgi-bin/hackage-scripts/package/Shu-thing Shu-thing], a 2D scrolling arcade game.
+
* [http://hackage.haskell.org/package/Shu-thing Shu-thing], a 2D scrolling arcade game.
 
* [http://home.arcor.de/chr_bauer/topkata.html Topkata], a jumping ball puzzle game.
 
* [http://home.arcor.de/chr_bauer/topkata.html Topkata], a jumping ball puzzle game.
 
* [http://www.comp.leeds.ac.uk/funvis/ PolyFunViz], a toolkit for scientific visualization (e.g. surfaces, flows, contours, volumes)
 
* [http://www.comp.leeds.ac.uk/funvis/ PolyFunViz], a toolkit for scientific visualization (e.g. surfaces, flows, contours, volumes)
* [http://raincat.bysusanlin.com Raincat], a 2d puzzle game
+
* [http://bysusanlin.com/raincat/ Raincat], a 2d puzzle game
 
* [http://trac.ouroborus.net/gloss Gloss], hides the pain of drawing simple vector graphics behind a nice data type and a few display functions
 
* [http://trac.ouroborus.net/gloss Gloss], hides the pain of drawing simple vector graphics behind a nice data type and a few display functions
  
Line 43: Line 43:
 
== OpenGL Resources ==
 
== OpenGL Resources ==
  
* [http://www.opengl.org/archives/resources/faq/technical/ OpenGL FAQ and Troubleshooting Guide] Assumes some knowledge of OpenGL. Good for those who have written something but want to avoid common pitfalls.
+
* [https://www.opengl.org/archives/resources/faq/technical/ogl_faq.pdf OpenGL FAQ and Troubleshooting Guide] (PDF) Assumes some knowledge of OpenGL. Good for those who have written something but want to avoid common pitfalls.
** [http://www.opengl.org/archives/resources/faq/technical/gettingstarted.htm#0050 2.100: What is the general form of an OpenGL program?]
+
** [https://www.opengl.org/archives/resources/faq/technical/gettingstarted.htm#0050 2.100: What is the general form of an OpenGL program?]
  
  
Line 52: Line 52:
 
* read the [https://github.com/madjestic/Haskell-OpenGL-Tutorial Haskell OpenGL Tutorial] on GitHub
 
* read the [https://github.com/madjestic/Haskell-OpenGL-Tutorial Haskell OpenGL Tutorial] on GitHub
 
* use the (in progress) [https://github.com/bergey/haskell-OpenGL-examples Haskell port] of the [https://en.wikibooks.org/wiki/OpenGL_Programming OpenGL Wikibook], using the modern programmable pipeline
 
* use the (in progress) [https://github.com/bergey/haskell-OpenGL-examples Haskell port] of the [https://en.wikibooks.org/wiki/OpenGL_Programming OpenGL Wikibook], using the modern programmable pipeline
* assuming you know Haskell, any OpenGL tutorial of your choice should get you going (browsing the [http://www.opengl.org OpenGL] site is also a good idea)
+
* assuming you know Haskell, any OpenGL tutorial of your choice should get you going (browsing the [https://www.opengl.org OpenGL] site is also a good idea)
* use the [http://www.opengl.org/documentation/books/#the_opengl_programming_guide_the_official_guide_to_learning_opengl_version Red Book], and its example code translations, to understand the small differences between OpenGL and HOpenGL
+
* use the [https://www.opengl.org/documentation/books/#the_opengl_programming_guide_the_official_guide_to_learning_opengl_version Red Book], and its example code translations, to understand the small differences between OpenGL and HOpenGL
* use the [http://www.opengl.org/documentation/specs/ OpenGL and GLUT specs] to find your way around the [http://hackage.haskell.org/packages/archive/OpenGL/latest/doc/html/ HOpenGL Haddock documentation]
+
* use the [https://www.opengl.org/documentation/specs/ OpenGL and GLUT specs] to find your way around the [http://hackage.haskell.org/packages/archive/OpenGL/latest/doc/html/ HOpenGL Haddock documentation]
 
* use the [http://www.haskell.org/mailman/listinfo/hopengl HOpenGL list] for questions and success stories
 
* use the [http://www.haskell.org/mailman/listinfo/hopengl HOpenGL list] for questions and success stories
  
Line 63: Line 63:
 
* [http://hackage.haskell.org/package/GLUtil GLUtil]: Miscellaneous OpenGL utilities
 
* [http://hackage.haskell.org/package/GLUtil GLUtil]: Miscellaneous OpenGL utilities
 
* [http://hackage.haskell.org/package/vinyl-gl vinyl-gl]: Utilities for working with OpenGL's GLSL shading language and vinyl records
 
* [http://hackage.haskell.org/package/vinyl-gl vinyl-gl]: Utilities for working with OpenGL's GLSL shading language and vinyl records
* [http://hackage.haskell.org/cgi-bin/hackage-scripts/package/graphics-drawingcombinators graphics-drawingcombinators]: A functional interface to 2D drawing in OpenGL
+
* [http://hackage.haskell.org/package/graphics-drawingcombinators graphics-drawingcombinators]: A functional interface to 2D drawing in OpenGL
 
* [http://hackage.haskell.org/package/GPipe GPipe]: A functional graphics API for programmable GPUs
 
* [http://hackage.haskell.org/package/GPipe GPipe]: A functional graphics API for programmable GPUs
* [http://lambdacube3d.wordpress.com LambdaCube 3D]: domain specific language and library that makes it possible to program GPUs in a purely functional style
+
* [https://lambdacube3d.wordpress.com LambdaCube 3D]: domain specific language and library that makes it possible to program GPUs in a purely functional style
* [http://hackage.haskell.org/package/freetype2 The freetype2 package]; bindings to [http://www.freetype.org/freetype2/index.html FreeType], a software font engine
+
* [http://hackage.haskell.org/package/freetype2 The freetype2 package]; bindings to [http://freetype.org/ FreeType], a software font engine
  
 
Somewhat related is [http://www.libsdl.org/ SDL], which is based on OpenGL:
 
Somewhat related is [http://www.libsdl.org/ SDL], which is based on OpenGL:
* [http://hackage.haskell.org/cgi-bin/hackage-scripts/package/SDL SDL]: Binding to libSDL
+
* [http://hackage.haskell.org/package/SDL SDL]: Binding to libSDL
* [http://hackage.haskell.org/cgi-bin/hackage-scripts/package/SDL-gfx SDL-gfx]: Binding to libSDL_gfx
+
* [http://hackage.haskell.org/package/SDL-gfx SDL-gfx]: Binding to libSDL_gfx
* [http://hackage.haskell.org/cgi-bin/hackage-scripts/package/SDL-image SDL-image]: Binding to libSDL_image
+
* [http://hackage.haskell.org/package/SDL-image SDL-image]: Binding to libSDL_image
* [http://hackage.haskell.org/cgi-bin/hackage-scripts/package/SDL-mixer SDL-mixer]: Binding to libSDL_mixer
+
* [http://hackage.haskell.org/package/SDL-mixer SDL-mixer]: Binding to libSDL_mixer
* [http://hackage.haskell.org/cgi-bin/hackage-scripts/package/SDL-mpeg SDL-mpeg]: Binding to the SMPEG library  
+
* [http://hackage.haskell.org/package/SDL-mpeg SDL-mpeg]: Binding to the SMPEG library  
* [http://hackage.haskell.org/cgi-bin/hackage-scripts/package/SDL-ttf SDL-ttf]: Binding to libSDL_ttf
+
* [http://hackage.haskell.org/package/SDL-ttf SDL-ttf]: Binding to libSDL_ttf
  
 
To add sound to OpenGL applications:
 
To add sound to OpenGL applications:
* [http://hackage.haskell.org/cgi-bin/hackage-scripts/package/OpenAL OpenAL]: A binding to the [[OpenAL]] cross-platform 3D audio API
+
* [http://hackage.haskell.org/package/OpenAL OpenAL]: A binding to the [[OpenAL]] cross-platform 3D audio API
* [http://hackage.haskell.org/cgi-bin/hackage-scripts/package/ALUT ALUT]: A binding for the OpenAL Utility Toolkit
+
* [http://hackage.haskell.org/package/ALUT ALUT]: A binding for the OpenAL Utility Toolkit
  
 
A fork of HOpenGL:
 
A fork of HOpenGL:
Line 126: Line 126:
 
<haskell>clear [ColorBuffer, DepthBuffer]</haskell>
 
<haskell>clear [ColorBuffer, DepthBuffer]</haskell>
  
See also: [http://www.opengl.org/archives/resources/faq/technical/depthbuffer.htm#0010 The OpenGL FAQ: 12.010 How do I make depth buffering work?]
+
See also: [https://www.opengl.org/archives/resources/faq/technical/depthbuffer.htm#0010 The OpenGL FAQ: 12.010 How do I make depth buffering work?]
  
  

Revision as of 13:02, 8 November 2015

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

Contents

1 References

  • Starting with 2013.2.0.0, the OpenGL packages are part of the Haskell platform, so you can find the API documentation there.
  • Hackage hosts the individual OpenGL binding packages, including their latest API documentation:
    • OpenGLRaw contains a low-level wrapper around OpenGL, which is basically a 1:1 mapping of the C API.
    • GLURaw is similar to OpenGLRaw, just for the GLU part of OpenGL.
    • OpenGL is the high-level view on OpenGL, wrapping OpenGLRaw into something more Haskell-like.
    • GLUT is a binding for the OpenGL Utility Toolkit.
  • The HOpenGL mailing list can be used for all discussions regarding the use of OpenGL from Haskell.

The examples directory in the GLUT package contains lots of examples, including translations of the Red Book examples. Both the API documentation and theses examples are best studied with the original specs and the original Red Book examples at hand. An index of examples can be found at the OpenGL wiki page Code Resources.


2 Projects using the OpenGL bindings

  • Haskell-GLSL-eDSL, A GLSL code generating DSL embedded in Haskell
  • plissken, a 3D version of snake
  • Endless Cavern, a 2D procedurally-generated exploration game.
  • Frag, a 3D first-person shooter game.
  • Monadius, a 2D scrolling arcade game.
  • Roguestar, a roguelike adventure game using 3D graphics.
  • Shu-thing, a 2D scrolling arcade game.
  • Topkata, a jumping ball puzzle game.
  • PolyFunViz, a toolkit for scientific visualization (e.g. surfaces, flows, contours, volumes)
  • Raincat, a 2d puzzle game
  • Gloss, hides the pain of drawing simple vector graphics behind a nice data type and a few display functions

See also the reverse dependencies list on haskellers.com


3 HOpenGL Resources


4 OpenGL Resources


5 Getting Started

6 Additional software

  • FTGL: Portable TrueType font rendering for OpenGL using the Freetype2 library
  • GLFW: A binding for GLFW, An OpenGL Framework
  • GLUtil: Miscellaneous OpenGL utilities
  • vinyl-gl: Utilities for working with OpenGL's GLSL shading language and vinyl records
  • graphics-drawingcombinators: A functional interface to 2D drawing in OpenGL
  • GPipe: A functional graphics API for programmable GPUs
  • LambdaCube 3D: domain specific language and library that makes it possible to program GPUs in a purely functional style
  • The freetype2 package; bindings to FreeType, a software font engine

Somewhat related is SDL, which is based on OpenGL:

To add sound to OpenGL applications:

  • OpenAL: A binding to the OpenAL cross-platform 3D audio API
  • ALUT: A binding for the OpenAL Utility Toolkit

A fork of HOpenGL:

Experiments with raw bindings to GLFW/OpenGL produced with HSFFIG


7 Troubleshooting

7.1 I can't display text with renderString

It's probably because the text is displayed too big. Setting a much smaller scale factor before calling renderString should solve the problem.

scale 0.001 0.001 (0.001∷GLfloat)
renderString Roman "Test string"


7.2 Animations flicker

If you're not using DoubleBuffered display mode, turn that on. Also, you must set the display mode before creating the window you're going to be drawing in. To check if you've enabled double buffering use something like:

db <- get doubleBuffered

and set DoubleBuffered mode (before creating your windows!) like this:

initialDisplayMode $= [DoubleBuffered]
createWindow "My Window"
You will also need to call
 swapBuffers
at the end of your draw function (Read more about swapBuffers).


7.3 The depth buffer doesn't work (things that are closer to the camera are occluded by things that are farther from the camera)

Make sure that depthFunc is set:

depthFunc $= Just Less

Furthermore, if you're using GLFW, the following var has to be greater than zero:

get (windowParam DepthBits)

If DepthBits is 0, you probably forgot set it before the call to createWindow, like so:

windowHint WindowHint'DepthBits 16

Once you enable the depth buffer, you will need to clear it before each cycle of your drawing method:

clear [ColorBuffer, DepthBuffer]

See also: The OpenGL FAQ: 12.010 How do I make depth buffering work?


8 Blog articles