oscar-soirey/Raven

Maintainer? Show your league in your README

Card: your league's emblem, from Copper to Legendary

[![bestofgithub](https://bestofgithub.dev/badge/oscar-soirey/Raven.svg?style=card)](https://bestofgithub.dev/repo/oscar-soirey/Raven)

Flat: fits beside your other badges

[![bestofgithub](https://bestofgithub.dev/badge/oscar-soirey/Raven.svg)](https://bestofgithub.dev/repo/oscar-soirey/Raven)

Loading README…

Language	Loads the XML	Binds an action	Finds a widget
C, C++	`Rwindow_create_from_xml_file("main.xml")`	`Raction_bind("hello.clicked", f, NULL)`	`Rwidget_find(window, "status")`
Rust	`Rwindow_create_from_xml_file(...)`, `window_from_xml(text)`	`action_bind("hello.clicked", closure)`	`widget_find(window, "status")`
Python	`r.Rwindow_create_from_xml_file("main.xml")`	`r.Raction_bind("hello.clicked", f)`	`r.Rwidget_find(window, "status")`
Go	`raven.WindowCreateFromXmlFile("main.xml")`	`raven.ActionBind("hello.clicked", f)`	`raven.WidgetFind(window, "status")`
C#	`R.Rwindow_create_from_xml_file("main.xml")`	`R.Raction_bind("hello.clicked", R.Keep<RActionCallback>(F), IntPtr.Zero)`	`R.Rwidget_find(window, "status")`
Zig	`r.Rwindow_create_from_xml_file("main.xml")`	`r.Raction_bind("hello.clicked", f, null)`	`r.Rwidget_find(window, "status")`
LuaJIT	`r.Rwindow_create_from_xml_file("main.xml")`	`r.Raction_bind("hello.clicked", ffi.cast("RActionCallback", f), nil)`	`r.Rwidget_find(window, "status")`

Option	Default
`RAVEN_BUILD_SHARED`	`OFF`	shared library instead of static
`RAVEN_BUILD_EXAMPLES`	`ON` when top level
`RAVEN_BUILD_TESTS`	`ON` when top level	tests, tests of the bindings, `raven_benchmark`
`RAVEN_BUILD_TOOLS`	`ON` when top level	`raven_designer`
`RAVEN_BUILD_WEB`	`ON`	web pages (`raven_web.h`, docs/WEB.md), compiled into the Raven library itself; it needs nothing more to build
`RAVEN_BACKEND_VULKAN`	`ON`	`OFF` builds without any GPU code (custom backend or headless)
`RAVEN_PLATFORM`	`auto`	`win32`, `x11`, `cocoa` (macOS) or `null`
`RAVEN_WITH_STB_IMAGE`	`ON`	PNG / JPEG / BMP / TGA decoding
`RAVEN_FETCH_VULKAN_HEADERS`	`ON`	download the Khronos headers when no SDK is found
`RAVEN_VULKAN_INCLUDE_DIR`		folder containing `vulkan/vulkan.h`, to skip the search
`RAVEN_REBUILD_SHADERS`	`OFF`	recompile the GLSL (needs `glslangValidator` or `glslc`); the SPIR-V is committed
`RAVEN_MSVC_STATIC_RUNTIME`	`OFF`	Visual C++: `/MT` instead of `/MD`
`RAVEN_WARNINGS_AS_ERRORS`	`OFF`


`examples/hello`	a window with the C API
`examples/editor`	a scene editor described in `editor.xml`: menus, splitters, tree, tabs, property grid, a viewport rendered in software on the job system, a custom-drawn graph, a virtual list. Its View menu switches between the four themes
`examples/notepad`	a text editor: custom header bar, languages chosen from the name of the file, a language declared by the application, proposals from a callback, markers, the file dialogs of the system, files dropped on the window
`examples/animations`	transitions played on demand, four springs in a custom widget, cards that pop in and out, an island, speed and "reduce motion"
`examples/workspace`	panels that dock, a file browser that opens files in new panels, the three kinds of glass for everything or for one panel, saving and restoring the arrangement
`examples/components`	tags declared with `<Widget>`, `<Repeat>`, `<ForEach>`, `<Include>`, and a piece of interface built from C as a document
`examples/memory`	an allocator given by the application, the statistics of the library, the heap check
`examples/studio`	a graph of nodes (widgets inside the nodes, links the application can refuse, nodes added from code), a timeline that plays, a color picker that colors the selected nodes; its XML is loaded again when saved
`examples/themes`	two theme files, styles and classes, a card that keeps its own theme, Markdown in a label and in an editor; every file of the example is watched
`examples/overlay`	a window that is seen through, the backdrops of the system, and the four ways to blur what is behind a panel
`examples/browser`	web pages with `raven_web`: an address bar, the history, a color picker of Raven that drives the CSS of the page, messages from the page
`examples/glass`	the glass themes and the three glass materials. `raven_glass light` starts with the light glass
`examples/viewport_vulkan`	a Vulkan scene in the UI, twice: offscreen image wrapped as a texture, and drawn in the render pass of Raven. Needs the Vulkan library
`examples/viewport_opengl`	an OpenGL scene in a native child window (WGL / GLX)
`examples/bevy_editor`	a 3D scene editor in Rust, its whole interface in one `editor.xml`: hierarchy, inspector, gizmos to move, rotate and scale, undo, scene files. Bevy draws the scene into the viewport; without Bevy, a software renderer does. See its README
`examples/languages`	the same program in C, C++, Rust, Python, Go, C#, Zig and Lua: one `main.xml` loaded by the program of each language, as the IDE creates them, built by the tools of each language


functions	`R<object>_<action>`	`Rwindow_create`, `Rwindow_get_size`, `Rbutton_set_text`, `Rslot_set_padding`
library functions	`R<action>`	`Rinit`, `Rdraw_frame`, `Rwait_frame`, `Rquit`, `Rshutdown`
types	`R<Name>`	`Rid`, `REvent`, `RInitDesc`, `RPainter`; callbacks end with `Callback`
constants	`R_<NAME>`	`R_INVALID_ID`, `R_WIDGET_VBOX`, `R_KEY_ESCAPE`, `R_THEME_GLASS_DARK`
build options and macros	`RAVEN_<NAME>`	`RAVEN_BUILD_SHARED`, `RAVEN_API`, `RAVEN_VERSION_MAJOR`


`Solid`	filled with the colors of the theme
`Glass`	clear glass: what is behind shows through, bent at the rim
`FrostedGlass`	blurred: the colors behind, without their shapes
`TintedGlass`	blurred and colored by the theme: the easiest to read on


`Plain`	only blurred
`Frosted`	blurred, a little veiled, with a fine grain (the default)
`Glass`	blurred and bent at its rim, like the glass material
`Native`	opens the window: the system blurs the desktop behind it

12 000 widgets, 27 800 primitives
first layout	2 to 3 ms
full repaint	1.3 to 2.3 ms, one draw call
layout after changing one label	0.03 to 0.05 ms

Raven

Disclaimer : This project is still in active development and public API is subject to change.

Build from source

Windows (Visual Studio)

Windows (MinGW-w64)

Linux

macOS

Using the built library

Any language: the interface in XML, the code in yours

The IDE

License

Status

Build options and scripts

Packages to give away

Examples

Other languages

Concepts

Names

Handles and errors

The loop

Layout

XML

Animations

Text editor

Header bar

Docking

Dialogs and files

Drag and drop

Materials and glass

Blur, and windows that are seen through

Color picker, timeline, node graph

Markdown

Files that are loaded again

Translations

Right to left, scripts and emoji

Accessibility

Web pages

Island

Memory

Threads

Viewports

Themes

Custom widgets and custom backends

Performance

Layout of the repository

Not implemented yet

Third-party code