diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +### 0.11.0.1 + +- Fixed documentation broken links. + # 0.11 - Removed `Region`s. Now using commands (`FrameCmd`, `ShadingCmd`, `DrawCmd` and `RenderCmd`). Safer diff --git a/luminance.cabal b/luminance.cabal --- a/luminance.cabal +++ b/luminance.cabal @@ -1,5 +1,5 @@ name: luminance -version: 0.11 +version: 0.11.0.1 synopsis: Type-safe, type-level and stateless graphics framework description: This package exposes several modules to work with /GPUs/ in a stateless and type-safe way. Currently, it uses OpenGL as backend hardware technology but diff --git a/src/Graphics/Luminance.hs b/src/Graphics/Luminance.hs --- a/src/Graphics/Luminance.hs +++ b/src/Graphics/Luminance.hs @@ -25,21 +25,22 @@ -- -- The drawback is about safety. If you screw up setting up the OpenGL context, there’s no way -- luminance will work. A few dedicated packages will be uploaded, like __luminance-glfw__ to add --- "GLFW-b" support for instance. +-- support for instance. -- -- = Getting started -- -- == Setting up the window and OpenGL context -- --- The first thing to do is to create a window. Here’s a typical "GLFW-b" snippet to create such --- a window. +-- The first thing to do is to create a window. Here’s a typical +-- snippet to create such a window. -- -- @ -- initialized <- init -- when initialized $ do -- @ -- --- In the first place, we initialize the "GLFW-b" library and make sure everything ran smoothly. +-- In the first place, we initialize the library +-- and make sure everything ran smoothly. -- -- @ -- windowHint (WindowHint'Resizable False) @@ -76,7 +77,7 @@ -- terminate -- @ -- --- We finally close the "GLFW-b" context to cleanup everything. +-- We finally close the context to cleanup everything. -- -- == Preparing the environment for luminance -- @@ -103,10 +104,11 @@ -- == About the screen -- -- luminance generalizes OpenGL concepts so that they’re made safer. In order to render something --- onto the screen, you have to understand what the screen truly is. It’s actually… a back buffer – --- assuming we have double buffering enabled, which is the case with "GLFW-b" by default. So --- rendering to the screen is the same thing than rendering to the back buffer and ask "GLFW-b" to --- swap the back buffer with the front buffer. +-- onto the screen, you have to understand what the screen truly is. It’s actually… a +-- back buffer – assuming we have double buffering enabled, which is the case with +-- by default. So rendering to the screen is +-- the same thing than rendering to the back buffer and asking +-- to swap the back buffer with the front buffer. -- -- And guess what. luminance wraps the back buffer into a 'Framebuffer' object. You can access it -- through 'defaultFramebuffer'. That value will always represent the back buffer. @@ -286,8 +288,8 @@ -- We don’t need the result of 'runCmd' in our case so we discard it with 'void'. 'runCmd' runs in -- 'MonadIO'. -- --- We just need to swap the buffers with @swapBuffers window@ – see "GLFW-b" for further details – --- and we’re good! +-- We just need to swap the buffers with @swapBuffers window@ – see +-- for further details – and we’re good! -- -- = Dealing with 'Texture2D' --