https://github.com/regb/scalanative-graphics-bindings

OpenGL and SDL2 bindings for Scala Native
https://github.com/regb/scalanative-graphics-bindings

graphics-bindings opengl scala scala-library scala-native sdl2-bindings

Last synced: 23 days ago
JSON representation

OpenGL and SDL2 bindings for Scala Native

• Host: GitHub
• URL: https://github.com/regb/scalanative-graphics-bindings
• Owner: regb
• License: mit
• Created: 2017-03-15T00:57:19.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-08-02T14:25:12.000Z (over 2 years ago)
• Last Synced: 2024-09-30T03:01:33.511Z (about 1 month ago)
• Topics: graphics-bindings, opengl, scala, scala-library, scala-native, sdl2-bindings
• Language: Scala
• Size: 468 KB
• Stars: 41
• Watchers: 1
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-scala-native - SDL2 and OpenGL - Bindings for the graphical frameworks [SDL2](https://www.libsdl.org/) and [OpenGL](https://www.opengl.org). (Bindings)

README

        
# Graphics Bindings for Scala Native

This repository hosts [Scala Native](http://scala-native.org) bindings to the

popular graphics programming libraries SDL2 and OpenGL. With these, you can

develop high-performing graphical software, such as games, in your favorite

language.

The bindings are designed to reproduce as much as possible the original

programming interface in C. In particular, they won't hide Scala Native

interoperability types behind regular Scala types. These bindings are only

meant to provide access to these libraries for pure Scala Native projects. As

such, they expose the low-level details of the underlying API and they might

not be suitable for use in platforms that are not supported by Scala Native.

If you are looking for a truly cross-platform solution, the

[ScalaGL](https://github.com/samarion/scalagl) project aims to provide a

cross-platform (Native, JS, JVM) OpenGL wrapper. Alternatively, The [Scala Game

Library](http://github.com/regb/scala-game-library) is a complete 2D Scala game

engine with cross-platform support, which uses the SDL2 and OpenGL bindings for

its Scala Native backend implementation.

To get started, have a look at the [examples](/examples) folder containing

runnable demo projects. They demonstrate how to use the different librairies

and extensions.

## SDL2

Add this to your `build.sbt`:

    libraryDependencies += "com.regblanc" %%% "native-sdl2" % "0.2"

The bindings export most of SDL2 standard functionalities. Importing

    import sdl2.SDL._

    import sdl2.Extras._

is pretty much equivalent to

    #include "SDL.h"

SDL2 extensions can be provided as separate dependencies. Currently, we have an

implementation of `SDL2_image` and `SDL_ttf`, which can be included in your

project with:

    libraryDependencies += "com.regblanc" %%% "native-sdl2-image" % "0.2"

    libraryDependencies += "com.regblanc" %%% "native-sdl2-ttf" % "0.2"

For more documentation, you should refer to the official documentation of SDL,

as the bindings maintain almost the exact same interface.

## OpenGL

OpenGL functions up to 4.6 are exported.

Add this to your `build.sbt`:

    libraryDependencies += "com.regblanc" %%% "native-opengl" % "0.2"

You will also need to add an additional linking option, which will vary

depending on your system. For Linux, add the following to your project:

      nativeLinkingOptions += "-lGL"

And for OSX, add the following instead:

      nativeLinkingOptions ++= Seq("-framework", "OpenGL")

The bindings export all of the OpenGL standard up to 4.6. Importing

    import opengl.GL._

    import opengl.Extras._

will bring all of the standard functions and definitions of OpenGL.

For more documentation, you should refer to the official documentation of

OpenGL, as the bindings maintain almost the exact same interface.

## OpenGL ES

Coming soon..