View Source Rayex

Hex.pm API Docs Run Tests

BlueSky

Rayex provides Elixir NIF bindings to Raylib

NOTE: some of the functions on raylib are not implemented yet, check the contributing section to help

Installation

The package can be installed by adding rayex to your list of dependencies in mix.exs:

def deps do
  [
    {:rayex, "~> 0.0.3"}
  ]
end

The docs can be found at https://hexdocs.pm/rayex.

Running from source

You need the following packages installed on your system:

  • elixir
  • erlang (headers)
  • pkg-config
  • raylib v5
  • glibc
  • clang-tools (formatter)

If you are using Nix or NixOS you can run nix develop to get an ready to go env to work with!

Now you can run:

mix deps.get
iex -S mix

And test with:

# Import all modules
iex> use Rayex

# open new window
iex> init_window(200, 200, "window name")

# draw a line
iex> begin_drawing()
iex> draw_line(10, 10, 50, 51, %{r: 255, g: 161, b: 0, a: 255})
iex> end_drawing()

You can also run our examples!!

cd examples/3d_picking/
mix deps.get
iex -S mix

iex> The3dPicking.run()

Contributing

There are a few things that you need to know about the code:

  • This project aims to run each one of these functions with elixir
  • To do so, we are using Unifex to create NIFs
  • On c_src/rayex/rayex.spec.exs you can find the definitions that will be generated by Unifex
  • On c_src/rayex/rayex.c you can find how they are implemented
  • On c_src/rayex/rayex.h and lib/unifex/code_generator/base_types/... you can find custom types
  • On lib/rayex/unifex/raylib.ex is where the generated functions will be stored and used for each module under lib/rayex, the public API

Any contributions are appreciated

License

Copyright 2021 Shiryel

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.