# khronosgroup/openxr-sdk architecture

> Architecture diagram of the GitHub repository khronosgroup/openxr-sdk, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/khronosgroup/openxr-sdk
- Repository: https://github.com/khronosgroup/openxr-sdk

## Overview

This repository packages the OpenXR public headers and the native loader. An application uses the OpenXR API; the loader initializes instance state, discovers runtime and API-layer manifests, and forwards API calls through generated trampolines and dispatch tables to the selected runtime. The tree also includes loader logging and shared object/handle utilities. The README establishes the SDK/loader role; source excerpts show selected loader, manifest, and dispatch behavior, so links beyond those are omitted where wiring is not evidenced.

Main entry points: [`src/loader/loader_core.cpp`](https://github.com/khronosgroup/openxr-sdk/blob/main/src/loader/loader_core.cpp) (Loader core), [`src/loader/manifest_file.cpp`](https://github.com/khronosgroup/openxr-sdk/blob/main/src/loader/manifest_file.cpp) (Manifest discovery), [`src/loader/xr_generated_loader.cpp`](https://github.com/khronosgroup/openxr-sdk/blob/main/src/loader/xr_generated_loader.cpp) (API trampolines), [`src/loader/api_layer_interface.cpp`](https://github.com/khronosgroup/openxr-sdk/blob/main/src/loader/api_layer_interface.cpp) (API layer interface)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_public["Public API"]
  node_api_headers["OpenXR headers<br/>[openxr.h]"]
  node_platform_headers["Platform headers<br/>[openxr_platform.h]"]
  node_loader_negotiation["Loader negotiation"]
end

subgraph group_loader["Loader Runtime"]
  node_loader_core["Loader core<br/>[loader_core.cpp]"]
  node_generated_trampolines["API trampolines"]
  node_dispatch_tables["Dispatch tables"]
  node_instance_state["Instance state"]
  node_init_data["Loader initialization"]
end

subgraph group_discovery["Runtime Discovery"]
  node_api_layers["API layer interface"]
  node_manifest_files["Manifest discovery<br/>[manifest_file.cpp]"]
  node_runtime_interface["Runtime interface"]
end

subgraph group_support["Loader Support"]
  node_platform_loading["Platform library loading"]
  node_loader_logging["Loader logging<br/>[loader_logger.hpp]"]
  node_object_info["Debug object info<br/>[object_info.h]"]
  node_handle_utils["Handle utilities<br/>[hex_and_handles.h]"]
  node_platform_utils["Platform utilities<br/>[platform_utils.hpp]"]
end

node_application(("OpenXR application"))

node_application -->|"uses API"| node_api_headers
node_application -->|"uses platform API"| node_platform_headers
node_loader_core -->|"creates instance"| node_instance_state
node_loader_core -->|"uses layers"| node_api_layers
node_loader_core -->|"uses initialization"| node_init_data
node_loader_core -->|"logs events"| node_loader_logging
node_loader_core -->|"uses runtime interface"| node_runtime_interface
node_loader_core -->|"uses trampolines"| node_generated_trampolines
node_generated_trampolines -->|"gets active instance"| node_instance_state
node_generated_trampolines -->|"dispatches calls"| node_dispatch_tables
node_manifest_files -->|"configures runtime"| node_runtime_interface
node_api_layers -->|"reads manifests"| node_manifest_files
node_api_layers -->|"uses initialization"| node_init_data
node_manifest_files -->|"uses platform utilities"| node_platform_utils
node_manifest_files -->|"uses platform loading"| node_platform_loading
node_loader_logging -->|"records object info"| node_object_info
node_object_info -->|"uses handle utilities"| node_handle_utils
node_platform_loading -->|"uses platform utilities"| node_platform_utils
node_loader_negotiation -->|"references API types"| node_api_headers

click node_api_headers "https://github.com/khronosgroup/openxr-sdk/blob/main/include/openxr/openxr.h"
click node_platform_headers "https://github.com/khronosgroup/openxr-sdk/blob/main/include/openxr/openxr_platform.h"
click node_loader_negotiation "https://github.com/khronosgroup/openxr-sdk/blob/main/include/openxr/openxr_loader_negotiation.h"
click node_loader_core "https://github.com/khronosgroup/openxr-sdk/blob/main/src/loader/loader_core.cpp"
click node_generated_trampolines "https://github.com/khronosgroup/openxr-sdk/blob/main/src/loader/xr_generated_loader.cpp"
click node_dispatch_tables "https://github.com/khronosgroup/openxr-sdk/blob/main/src/xr_generated_dispatch_table_core.h"
click node_instance_state "https://github.com/khronosgroup/openxr-sdk/blob/main/src/loader/loader_instance.hpp"
click node_init_data "https://github.com/khronosgroup/openxr-sdk/blob/main/src/loader/loader_init_data.hpp"
click node_api_layers "https://github.com/khronosgroup/openxr-sdk/blob/main/src/loader/api_layer_interface.cpp"
click node_manifest_files "https://github.com/khronosgroup/openxr-sdk/blob/main/src/loader/manifest_file.cpp"
click node_runtime_interface "https://github.com/khronosgroup/openxr-sdk/blob/main/src/loader/runtime_interface.hpp"
click node_platform_loading "https://github.com/khronosgroup/openxr-sdk/blob/main/src/loader/loader_platform.hpp"
click node_loader_logging "https://github.com/khronosgroup/openxr-sdk/blob/main/src/loader/loader_logger.hpp"
click node_object_info "https://github.com/khronosgroup/openxr-sdk/blob/main/src/common/object_info.h"
click node_handle_utils "https://github.com/khronosgroup/openxr-sdk/blob/main/src/common/hex_and_handles.h"
click node_platform_utils "https://github.com/khronosgroup/openxr-sdk/blob/main/src/common/platform_utils.hpp"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_api_headers,node_platform_headers,node_loader_negotiation toneBlue
class node_loader_core,node_generated_trampolines,node_dispatch_tables,node_instance_state,node_init_data toneAmber
class node_api_layers,node_manifest_files,node_runtime_interface toneMint
class node_platform_loading,node_loader_logging,node_object_info,node_handle_utils,node_platform_utils toneRose
class node_application toneIndigo
```

## Components

### Public API

- [OpenXR headers](https://github.com/khronosgroup/openxr-sdk/blob/main/include/openxr/openxr.h): `include/openxr/openxr.h`
- [Platform headers](https://github.com/khronosgroup/openxr-sdk/blob/main/include/openxr/openxr_platform.h): `include/openxr/openxr_platform.h`
- [Loader negotiation](https://github.com/khronosgroup/openxr-sdk/blob/main/include/openxr/openxr_loader_negotiation.h): `include/openxr/openxr_loader_negotiation.h`

### Loader Runtime

- [Loader core](https://github.com/khronosgroup/openxr-sdk/blob/main/src/loader/loader_core.cpp): `src/loader/loader_core.cpp`
- [API trampolines](https://github.com/khronosgroup/openxr-sdk/blob/main/src/loader/xr_generated_loader.cpp): `src/loader/xr_generated_loader.cpp`
- [Dispatch tables](https://github.com/khronosgroup/openxr-sdk/blob/main/src/xr_generated_dispatch_table_core.h): `src/xr_generated_dispatch_table_core.h`
- [Instance state](https://github.com/khronosgroup/openxr-sdk/blob/main/src/loader/loader_instance.hpp): `src/loader/loader_instance.hpp`
- [Loader initialization](https://github.com/khronosgroup/openxr-sdk/blob/main/src/loader/loader_init_data.hpp): `src/loader/loader_init_data.hpp`

### Runtime Discovery

- [API layer interface](https://github.com/khronosgroup/openxr-sdk/blob/main/src/loader/api_layer_interface.cpp): `src/loader/api_layer_interface.cpp`
- [Manifest discovery](https://github.com/khronosgroup/openxr-sdk/blob/main/src/loader/manifest_file.cpp): `src/loader/manifest_file.cpp`
- [Runtime interface](https://github.com/khronosgroup/openxr-sdk/blob/main/src/loader/runtime_interface.hpp): `src/loader/runtime_interface.hpp`

### Loader Support

- [Platform library loading](https://github.com/khronosgroup/openxr-sdk/blob/main/src/loader/loader_platform.hpp): `src/loader/loader_platform.hpp`
- [Loader logging](https://github.com/khronosgroup/openxr-sdk/blob/main/src/loader/loader_logger.hpp): `src/loader/loader_logger.hpp`
- [Debug object info](https://github.com/khronosgroup/openxr-sdk/blob/main/src/common/object_info.h): `src/common/object_info.h`
- [Handle utilities](https://github.com/khronosgroup/openxr-sdk/blob/main/src/common/hex_and_handles.h): `src/common/hex_and_handles.h`
- [Platform utilities](https://github.com/khronosgroup/openxr-sdk/blob/main/src/common/platform_utils.hpp): `src/common/platform_utils.hpp`

### Other components

- **OpenXR application**

## Connections

- OpenXR application → OpenXR headers: uses API (evidence: `README.md`)
- OpenXR application → Platform headers: uses platform API (evidence: `README.md`)
- Loader core → Instance state: creates instance (evidence: `src/loader/loader_core.cpp`)
- Loader core → API layer interface: uses layers (evidence: `src/loader/loader_core.cpp`)
- Loader core → Loader initialization: uses initialization (evidence: `src/loader/loader_core.cpp`)
- Loader core → Loader logging: logs events (evidence: `src/loader/loader_core.cpp`)
- Loader core → Runtime interface: uses runtime interface (evidence: `src/loader/loader_core.cpp`)
- Loader core → API trampolines: uses trampolines (evidence: `src/loader/loader_core.cpp`)
- API trampolines → Instance state: gets active instance (evidence: `src/loader/xr_generated_loader.cpp`)
- API trampolines → Dispatch tables: dispatches calls (evidence: `src/loader/xr_generated_loader.cpp`)
- Manifest discovery → Runtime interface: configures runtime (evidence: `src/loader/manifest_file.cpp`)
- API layer interface → Manifest discovery: reads manifests (evidence: `src/loader/api_layer_interface.cpp`)
- API layer interface → Loader initialization: uses initialization (evidence: `src/loader/api_layer_interface.cpp`)
- Manifest discovery → Platform utilities: uses platform utilities (evidence: `src/loader/manifest_file.cpp`)
- Manifest discovery → Platform library loading: uses platform loading (evidence: `src/loader/manifest_file.cpp`)
- Loader logging → Debug object info: records object info (evidence: `src/loader/loader_logger.hpp`)
- Debug object info → Handle utilities: uses handle utilities (evidence: `src/common/object_info.h`)
- Platform library loading → Platform utilities: uses platform utilities (evidence: `src/loader/loader_platform.hpp`)
- Loader negotiation → OpenXR headers: references API types (evidence: `include/openxr/openxr_loader_negotiation.h`)
