sdl2

Both high- and low-level bindings to the SDL library (version 2.0.2+).

Version on this page:2.1.3.1
LTS Haskell 21.22:2.5.5.0
Stackage Nightly 2023-11-29:2.5.5.0
Latest on Hackage:2.5.5.0

See all snapshots sdl2 appears in

BSD-3-Clause licensed by Gabríel Arthúr Pétursson, Oliver Charles
Maintained by gabriel@system.is, ollie@ocharles.org.uk
This version can be pinned in stack with:sdl2-2.1.3.1@sha256:13f4bbee291193e48d33888ee6fba3696fe04b464157fca3a9e7fc443bba4dc1,9466

Module documentation for 2.1.3.1

This package contains bindings to the SDL 2 library, in both high- and low-level forms:

The SDL namespace contains high-level bindings, where enumerations are split into sum types, and we perform automatic error-checking.

The SDL.Raw namespace contains an almost 1-1 translation of the C API into Haskell FFI calls. As such, this does not contain sum types nor error checking. Thus this namespace is suitable for building your own abstraction over SDL, but is not recommended for day-to-day programming.

Changes

2.1.3.1

  • Raise upper bounds for vector to <0.13

2.1.3

  • Cabal flag no-linear removes dependency on linear (and thus, transiently, lens). See SDL.Vect for details.
  • Remove ‘lens’ dependency from all examples.
  • Add Cabal flag opengl-example to separate that target from examples, because it is now the only example with an extra dependency (OpenGL).
  • Make hlint happy with examples.
  • Add updateTexture wrapper for native SDL_UpdateTexture.
  • Expose glGetDrawableSize (can differ from window size in some environments).
  • Correct hintToString output to match SDL hint tokens, rather than the names of the CPP macros defining them.
  • Removed ghc-options: -Wall until we drop support for GHC 7.8. (>1300 warnings!)
  • Various documentation updates.

2.1.2.1

  • Raise upper bounds for lens to <4.15 (affects examples only)

2.1.2

  • Revise some documentation examples to be more idomatic
  • Update .gitignore to cover stack and other tools
  • Raise upper bounds for transformers to <0.6
  • Lower required SDL2 version to 2.0.2.
  • Fix decoding of TextEditingEvent where the Raw bindings failed to stop reading character data past the null terminator.

2.1.1

  • SDL.Input.Mouse new has a new API for fetching the location of the mouse. This API gives you greater control over finding the mouse position with respect to the various “modes” a mouse can be in. The old API still exists, but will be removed at some point in the future.
  • SDL.Raw now has a binding to SDL_free.

2.1.0

  • Introduce initializeAll and deprecate InitEverything. To fix this deprecation warning, change initialize [InitEverything] to initializeAll.
  • surfaceColorKey, surfaceFillRect and surfaceFillRects now all operate on on RGBA V4 Word8 values. They all implicitly map and unmap (using SDL_MapRGBA and SDL_GetRGBA respectively).
  • SDL.mapRGB is now deprecated, as this conversion is always done for you. If you still need this routine, use SDL.Raw.mapRGB.
  • Fix a runtime crash when reading the current BlendMode of a texture. Thanks to @seppeljordan for discovering and fixing this bug.

2.0.0

  • Introduce a set of comprehensive high-level bindings to SDL. These bindings should allow users to work with SDL while writing idiomatic Haskell code. They take care of pointer manipulation, and wrap up values in much more “natural” data types. The high-level bindings live in the SDL namespace, and have been extensively documented.
  • Raw bindings have been moved from Graphics.UI.SDL to SDL.Raw.

1.3.1

  • Correct type signature of getSurfaceBlendMode

1.3.0

  • Use pattern synonyms exclusively
    • Graphics.UI.SDL.Enum.Pattern overrides Graphics.UI.SDL.Enum
  • Generalize all IO functions over MonadIO
  • Add convenience wrapper functions for constructing FunPtr callbacks
  • Add Typeable instances to all type classes
  • Add strictness annotations to all data structure fields
  • Add missing SDLK_AUDIOPREV enumeration
  • Correct deserialization of SDL_TEXTINPUT event
    • Data beyond the null terminator was returned previously

1.2.0

  • Add support for pattern synonyms as an alternative for SDL enumerations
    • Only present when compiling with GHC 7.8 or newer
  • Add missing enumerations:
    • keymodShift, keymodCtrl, keymodAlt, keymodGUI
    • keyPressend, keyReleased
    • toucheMouseID
  • Specialize init flags over InitFlag, a Word32
  • Generalize keymod* enumerations over Num
    • The C API is inconsistent on their types
  • Fix foreign imports on Graphics.UI.SDL.Thread
  • Correct type signature of getRenderDrawBlendMode
  • Correct type signature of queryTexture
  • Remove export of Keycode from Graphics.UI.SDL.Types
    • Graphics.UI.SDL.Enum already exports Keycode

1.1.3

  • Add missing Keycode enumerations
  • Add missing enumerations:
    • audioAllowFrequencyChange, audioAllowFormatChange
    • audioAllowChannelsChange, audioAllowAnyChange

1.1.2

  • Add ClipboardUpdateEvent to Event data structure
  • Add UnknownEvent to Event data structure

1.1.1

  • Add Graphics.UI.SDL.Platform module
  • Add Graphics.UI.SDL.Thread module and associated types and enumerations
  • Add getWindowWMInfo
  • Add setError
  • Add additional logging functions

1.1.0

  • Require SDL 2.0.3
    • Add gameControllerAddMappingsFromFile
    • Add gameControllerAddMappingsFromRW
    • Add glResetAttributes
    • Add mouseButtonEventClicks field to WindowEvent
  • Add missing mouse button enumerations

1.0.2

  • Correct type signature of getNumTouchFingers

1.0.1

  • Factor type of addHintCallback and delHintCallback into HintCallback
  • Add Version data structure
A service provided by FP Complete