How to install the normal_pack crate // Lib.rs

Adding `normal_pack` library as a dependency

Run this command in a terminal, in your project"s directory:

cargo add normal_pack

To add it manually, edit your project"s Cargo.toml file and add to the [dependencies] section:

normal_pack = "0.1.4"

The normal_pack library will be automatically available globally. Read the normal_pack library documentation.

Back to the crate overview.

Readme

Compresses normal vectors (or any 3D unit vector) using Octahedron encoding.

This lossy compression scheme is able to achieve a compression ratio as high as 6:1 with an average error rate of less than 1 degree, depending on which representation is chosen.

Example:

let normal = [-0.5082557, 0.54751796, 0.6647558];

let encoded = normal_pack::EncodedUnitVector3U8::encode(normal);
let decoded = encoded.decode();

assert_eq!(decoded, [-0.52032965, 0.5473598, 0.6554802]);

Why compress my normals?

It is common for 3D renderers to be bottlenecked by memory bandwidth, such as when loading normals from VRAM for high-poly meshes to supply to your vertex shader. A smaller memory footprint for your normals corresponds to memory bandwidth savings and higher FPS in such scenarios.

How bad is 1 degree of error?

The teapot example generates a reference visual and contains the wgsl code required to decode the vector in a shader.

Standard [f32; 3] representation

teapot_packed_u8

Packed into a [u8; 2]

teapot_no_packing

As a video

normal_pack_error

The skybox used in the example is the work of Emil Persson, aka Humus. http://www.humus.name

Adding normal_pack library as a dependency

Adding `normal_pack` library as a dependency