A hvif rendered in modern standard C without extra dependencies.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Hans-Joerg Schurr 0bb035050f Update README 3 months ago
docs Update README 1 year ago
m4 Add build system 1 year ago
src Simplify buildsystem 1 year ago
.clang-format Add configuration files for dev environment 1 year ago
.gitignore Simplify buildsystem 1 year ago
LICENSE License under MIT license 1 year ago
Makefile.am Simplify buildsystem 1 year ago
README.md Update README 3 months ago
configure.ac Bump version to 0.1.0 1 year ago
shell.nix Change buildsystem to build a library 1 year ago

README.md

A simple library to render Haiku Vector Icons

⚠️ Do not use this library. It is not ready yet.

The Haiku operating system uses a custom format to represent vector icons. The Haiku Vector Icon Format (hvif) is optimized to create tiny files that can be saved with the file metadata. For a good technical overview of the format see this blog post by Leah Hanson. The goal of this library is to allow the usage of this format independent of the Haiku ecosystem. The best way to create new icons is to use the Icon-O-Matic tool that ships with Haiku.

The library is written in modern standard C and MIT licensed. When finished it will feature a parser and and serializer for hvif files without any dependencies beyond libc and multiple simple backends. Furthermore, a toy tool to convert hvif files into png files is included.

The author is not associated with the Haiku project.

Current Status

The library is currently under active development. The current parser should be able to parse hvif files created with current Haiku builds, but is mostly untested. There is an experimental rasterizer based on cairo is included. The purpose of this rasterizer is testing. It is not feature complete, but renders most real world icons reasonably well.

Example

The File_GoogleFS icon from the Haiku distribution as rendered by Haiku:

and as rendered with the current cairo based rasterizer:

While not perfect, the result is quite decent.

Building

Release Distribution

The build system is standard auto tools. When downloading a release distribution the usual

$ ./configure
$ make -j

and make install as root should work. Beside a recent C compiler and pkg-config the cairo library is required for now. Since no sensible functionality independent of cairo is implemented as of now, cairo is a hard dependency.

Development

To compile a freshly cloned repository run:

$ autoreconf -i
$ ./configure
$ make -j

On NixOS the included shell.nix script can be used to bring the dependencies and a couple of development tools into scope.

Documentation

HTML documentation can be generated with make html if Doxygen is installed.

Contribution

Contributions are very welcome. Please send patches or bugreports to commits at schurr dot at. If you are unfamiliar with the Email based git workflow, see this excellent tutorial.