Filament Real-Time PBR Engine

nanozlib is a lightweight C/C++ library designed for embedding zlib support into applications. It provides nanoscale secure zlib decoding (using Wuffs std/zlib) and somewhat secure zlib compression (using stb_zlib).

Key Characteristics

• Security: The decoding part is designed to be highly secure, specifically avoiding assert, C++ exceptions, and segmentation faults when encountering corrupted or malicious zlib data.
• Limitations:
  • Supports up to 2GB.
  • Adds approximately 50 KB or more to the compiled binary size (even with -Os optimization).
• Alternatives: If you require a 'picoscale' (extremely small) zlib decoder, consider the zlib module in stb_image instead.

matdbg is a library and web application designed for debugging and live-editing Filament shaders. It allows you to inspect and modify shader code across different graphics backends:

• OpenGL: Editing GLSL
• Metal: Editing MSL
• Vulkan: Editing transpiled GLSL or viewing disassembled SPIR-V
• WebGPU: Editing WGSL

Note that a material can be inspected for multiple backends (e.g., Metal) even if the current active session is using a different backend (e.g., Vulkan), provided the material was built with support for those backends included.

The Layer Interface provides a way to interact with the Vulkan loader using a layer-centric view. Layers allow developers to intercept Vulkan calls, add functionality (such as validation or debugging), or modify behavior without changing the application code. This interface is part of the Vulkan ecosystem and is managed by the Vulkan loader to facilitate discovery, dispatching, and management of these layers.

For a complete architectural overview of the loader, refer to LoaderInterfaceArchitecture.md.

glslang is a reference compiler and validator for shader languages. Its core components include:

• Reference Validator and GLSL/ESSL -> AST Front End: Translates OpenGL GLSL and OpenGL|ES GLSL (ESSL) into an internal Abstract Syntax Tree (AST).
• HLSL -> AST Front End: Translates an approximation of HLSL to the glslang AST. Note that semantics are not reference quality and input is not validated.
• AST -> SPIR-V Back End: Translates the internal AST into the Khronos-specified SPIR-V intermediate language.
• Reflector: An API to retrieve reflection information (types, variables, etc.) from the High-Level Language (HLL) source via the AST.
• Standalone Wrapper: A command-line tool (glslang) providing access to the components above.

ZLib.Ada is a thick binding interface for the ZLib data compression library. It provides Ada-style access to the ZLib C library functions.

Key features and recent updates include:

• Package ZLib and ZLib.Streams: Includes Is_Open routines to check stream status.
• ZLib.Read routine: Now supports Allow_Read_Some and Flush parameters (requires initialization for the Read_Last parameter).
• Error Handling: Includes a Status_Error exception definition.
• Demonstration: The source files test.adb and read.adb serve as small demo programs illustrating the main functionality of the binding.

Emdawnwebgpu is Dawn's implementation of webgpu.h for Emscripten, built on top of the WebGPU JavaScript API. It allows developers to use the standard <webgpu/webgpu.h> and the Dawn-style <webgpu/webgpu_cpp.h> headers within an Emscripten-based Web project. It is a fork of Emscripten's original USE_WEBGPU bindings and is maintained within the Dawn repository.

API Stability Note:

• Core parts of webgpu.h (from webgpu-native/webgpu-headers) are considered stable.
• Dawn/Emscripten-specific parts and all of webgpu_cpp.h are NOT considered stable and may change.

The Vulkan Loader is a library that sits between a Vulkan application and various Vulkan drivers (Installable Client Drivers or ICDs). Its primary responsibilities include:

• Multi-driver support: Enabling systems with multiple GPUs (each with different drivers) to function within a single Vulkan environment.
• Instance management: Supporting multiple global Vulkan instances.
• Layer management: Managing the insertion of Vulkan layer libraries (such as validation layers) between the application and the drivers.

This repository provides the loader for Linux, Windows, MacOS, and iOS.

Note: For Android, a separate loader maintained by Google must be used instead of this one.

SPIRV-Cross is a tool designed for parsing and converting SPIR-V shader code into other shader languages or reflection formats. It aims to produce readable, human-like code rather than assembly-like IR.

Key Features:

• Language Conversion: Converts SPIR-V to GLSL, Metal Shading Language (MSL), and HLSL.
• Reflection:
  • Converts SPIR-V to a JSON reflection format.
  • Provides a Reflection API to simplify Vulkan pipeline layout creation.
  • Provides a Reflection API to modify and tweak OpDecorations.
• Shader Support: Supports vertex, fragment, tessellation, geometry, and compute shaders.