mirror of
https://github.com/raylib-zig/raylib-zig.git
synced 2026-02-21 00:34:46 +00:00
Update ReadMe.md
This commit is contained in:
parent
96f83b9104
commit
add088f69d
64
ReadMe.md
Executable file → Normal file
64
ReadMe.md
Executable file → Normal file
@ -2,65 +2,5 @@
|
||||
Manually tweaked, auto generated [raylib](https://github.com/raysan5/raylib) bindings for zig.<br>
|
||||
Bindings tested on raylib version 3.0
|
||||
|
||||
## Example
|
||||
We can copy the default example with some minor changes:
|
||||
```zig
|
||||
usingnamespace @import("raylib");
|
||||
|
||||
pub fn main() anyerror!void
|
||||
{
|
||||
// Initialization
|
||||
//--------------------------------------------------------------------------------------
|
||||
const screenWidth = 800;
|
||||
const screenHeight = 450;
|
||||
|
||||
InitWindow(screenWidth, screenHeight, "MyWindow");
|
||||
|
||||
SetTargetFPS(60); // Set our game to run at 60 frames-per-second
|
||||
//--------------------------------------------------------------------------------------
|
||||
|
||||
// Main game loop
|
||||
while (!WindowShouldClose()) // Detect window close button or ESC key
|
||||
{
|
||||
// Draw
|
||||
//----------------------------------------------------------------------------------
|
||||
BeginDrawing();
|
||||
|
||||
ClearBackground(WHITE);
|
||||
|
||||
DrawText("Congrats! You created your first window!", 190, 200, 20, LIGHTGRAY);
|
||||
|
||||
EndDrawing();
|
||||
//----------------------------------------------------------------------------------
|
||||
}
|
||||
|
||||
// De-Initialization
|
||||
//--------------------------------------------------------------------------------------
|
||||
CloseWindow(); // Close window and OpenGL context
|
||||
//--------------------------------------------------------------------------------------
|
||||
}
|
||||
```
|
||||
|
||||
## Technical restrictions
|
||||
Due to zig being a relatively new language it does [not have full C ABI support](https://github.com/ziglang/zig/issues/1481) at the moment. For use that mainly means we can't use any functions that return structs that are less than 16 bytes large.
|
||||
Here is an incomplete list of some functions affected by this:
|
||||
+ DrawCircleV
|
||||
+ DrawRectangleRec
|
||||
+ DrawModel and all its variations
|
||||
|
||||
## Building the examples
|
||||
To build all available examples simply `zig build examples`. To list available examples run `zig build --help`. If you want to run and examples, say `basic_window` run `zig build basic_window`
|
||||
|
||||
## Building and using
|
||||
+ Install raylib
|
||||
+ Execute `projectSetup.sh project_name`, this will create a folder with the name specified
|
||||
+ You can copy that folder anywhere you want and edit the source
|
||||
+ Run `zig build run` at any time to test your project
|
||||
|
||||
### When is the binding updated?
|
||||
I plan on updating it every mayor release (2.5, 3.0, etc.). Keep in mind these are technically header files, so any implementation stuff should be updatable with some hacks on your side.
|
||||
|
||||
### What's to be done?
|
||||
+ _(Done)_ Set up a proper package build and a build script for the examples
|
||||
+ Port all the examples
|
||||
+ Object orientation
|
||||
## Workaround
|
||||
On this branch I will try to wokraround the [technical restrictions](https://github.com/Not-Nik/raylib-zig#technical-restrictions) the normal binding has. May cause severe bugs, terms of the [license](https://github.com/Not-Nik/raylib-zig/blob/master/LICENSE) apply.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user