Raylib-CsLo 4.0.0-rc.0

<h1 align="center"> <a href="#"><img align="center" src="meta/logos/raylib-cslo_128x128.png" height="96"> Raylib-CsLo</a> <br /> </h1>

<div align="center">

</div>

Table of Contents

• Table of Contents
• Raylib-CsLo
  • Release timeline
    • RELEASE CANDIDATE
    • RELEASE
• Differences from raylib-cs
• Usage Tips / FAQ
• Known Issues:
• How to Contribute
• ChangeLog

Raylib-CsLo

LowLevel autogen bindings to Raylib 4.0 and convenience wrappers on top.

• Requires use of unsafe
• Requires use of DotNet 6.0
• A focus on performance. No runtime allocations if at all possible.
• because these are autogen, there won't be any intellisense docs. read the raylib cheatsheet for docs

The entire API of Raylib 4.0 is available via these bindings. However, as the bindings are auto-generated, they are not user friendly, even for unsafe use.

To make these bindings "friendly" to C# use, convenience wrappers are being added, so you can use these bindings with a minimal amount of unsafe code.

The current mission of this project is to port all Raylib examples (more than 120 of them) to work with these bindings, with as little modification to the example code as possible. In doing so, convenience wrappers will be added for the Raylib api's used in the examples. This is a good heuristic for "primary usage scenarios", so writing wrappers for these API's should make these bindings user friendly in the fastest time, while also providing valuable C# examples.

Right now mose of the examples have been ported.

Release timeline

RELEASE CANDIDATE

• The current status.
• All Raylib features, including Extras bindings
  • raylib
  • rlgl
  • raygui
  • physac
  • easings
  • raymath
• All raylib examples are ported and working (see the github repository for the example project)
• A Nuget package is avalable

RELEASE

• Triggered 2 weeks after the last RC issue is fixed. (so if you find any bugs with the release candidate, be sure to file them!)

Differences from raylib-cs

Usage Tips / FAQ

• Does Raylib-CsLo include the SOME_FUNCTION_YOU_NEED() function?
  • Raylib-CsLo has bindings for everything in the Raylib 4.0 release, including extras like raygui and physac, but with the exception of things in the Known Issues section further below.
• Why didn't you add a wrapper for function SOME_OTHER_FUNCTION_YOU_NEED()?
  • Raylib-CsLo uses a manual marshalling technique, as the built in PInvoke marshalling is not very efficienct. Unfortunately writing wrappers takes time.
  • I am going through all the examples and porting them, and when I do I'm adding wrappers to the raylib api's used (I'm using examples as a heuristic for "commonly used api's) For a function I haven't written a wrapper for, you can look at how I do it and write your own wrapper, or can help the project by submitting a PR.
  • On average it only takes me about 15 min to port each example, but there are many examples.
• How do I convert a string to sbyte* or vice-versa?
  • Look if there is a wrapper overload you can call. If not, you can write your own wrapper by coppying the pattern in one of the existing wrappers.
• Do I have to really cast my Enum to int?
  • The autogen bindings are left untouched, however convenience wrappers are added. Usually these will automagically "work" via function overloads, but where this is not possible, try adding an underscore _ to the end of the function/property. For example: Camera3D.projection_ = CameraProjection.CAMERA_ORTHOGRAPHIC; or Gesture gesture = Raylib.GetGestureDetected_();
• I ran the examples in a profiler. What are all these sbyte[] arrays being allocated?
  • A pool of sbyte[] is allocated for string marshall purposes, to avoid runtime allocations.
• Why don't you add wrappers for the Math helpers?
  • The RayMath helper functions have been translated into C# code. This is because crossing between Managed and Native code isn't free. Better you do all your maths in managed code, and pass the final result to raylib.
• Why are my matricies corrupt?
  • Raylib/OpenGl uses column-major matricies, while dotnet/vulkan/directx uses row-major. When passing your final calculated matrix to raylib for rendering, call Matrix4x4.Transpose(yourMatrix)

Known Issues:

• RayGui: be sure to call RayGui.GuiLoadStyleDefault(); right after you InitWindow(). This is needed to initialize the gui properly. If you don't, if you close a raylib window and then open a new one (inside the same app), the gui will be broken.
• The Text.Unicode example doesn't render unicode properly. Maybe the required font is missing, maybe there is a bug in the example (Utf16 to Utf8 conversion) or maybe there is a bug in Raylib. A hunch: I think it's probably due to the fonts not including unicode characters, but I didn't investigate further.
• Native Memory allocation functions: use System.Runtime.InteropServices.NativeMemory.Alloc() instead
• LogCustom() is ported but doesn't support variable length arguments.

How to Contribute

0. assume you are using Visual Studio (or maybe rider?) and can run dev.sln
1. fork the repo, build and try out the example project
2. ??? add some wrappers? All features are done and working 😄

ChangeLog

• 4.0.0-rc.0 (2021/11/22): physac.dll and bindings for it added. Physics and Audio examples ported. All raylib examples complete!
• 4.0.0-beta.2 (2021/11/22): RayGui, and Easings Raylib.extras ported to managed code. Shapes,Textures, and Text examples ported.
• 4.0.0-beta.0 (2021/11/20): Model, and Shader examples ported.
• 4.0.0-alpha.2 (2021/11/18): Model examples ported. AutoGen Bindings expanded to include all api's exposed by Raylib.dll (adding RayMath, RlGl)
• 4.0.0-alpha.1 (2021/11/16): all Core examples ported, so "feature complete" for the workflows used in those examples (and, complete only for those workflows)