DisplayXR Unity Samples

Sample Unity projects for the DisplayXR Unity plugin (com.displayxr.unity) — one repo, one shared installer, one place to keep them building against new plugin/runtime releases.

Three of the samples are render-pipeline conformance tests (a matrix of render pipeline × stereo mode × 2D-UI overlay); the fourth is the Desktop Avatar feature showcase.

Sample	Folder	Render pipeline / mode	Highlights
BiRP Multi-Pass	samples/birp-multipass	Built-in RP, multi-pass stereo	Baseline cube + rig-switching demo
URP Single-Pass + 2D UI	samples/urp-singlepass-ui	URP, single-pass instanced	XrCompositionLayerWindowSpaceDXR 2D UI overlay
HDRP Single-Pass + 2D UI	samples/hdrp-singlepass-ui	HDRP, single-pass instanced	Same UI overlay as URP, on HDRP
Desktop Avatar	samples/desktop-avatar	URP	Alpha-native transparency, click-through, per-eye foreground clip, XR_DXR_display_zones (3D zone + Local2D)

Cloning — install Git LFS first

The Desktop Avatar sample's tiger model (samples/desktop-avatar/Assets/cartoon-tiger-in-witches-hat/source/*.fbx, 2.4 MB) is the one Git LFS–tracked file in this repo. Install the LFS filters before you clone:

git lfs install     # once per machine
git clone https://github.com/DisplayXR/displayxr-unity-samples.git

Without git-lfs, git clone still succeeds with exit 0 — you just get a 130-byte text pointer where the FBX should be, and Unity silently fails to import it: the avatar is simply missing from the scene, with no error naming LFS. Check with:

ls -l "samples/desktop-avatar/Assets/cartoon-tiger-in-witches-hat/source/cartoon tiger in witches hat_ rigged and animated.fbx"

2.4 MB is correct; ~130 bytes means the object was never fetched. Repair an existing clone in place — no re-clone needed:

git lfs install
git lfs pull

If git lfs pull instead hangs or times out, that's a network block, not a missing tool: LFS objects are served from github-cloud.s3.amazonaws.com, a different host than github.com, and it is throttled or blocked on some corporate and regional networks even when the git clone itself works fine. In that case obtain the FBX out of band and drop it at the path above — nothing else in the repo is LFS-tracked.

Prerequisites

• Git LFS (git lfs install) — see Cloning above.
• The DisplayXR runtime installed (the installers hard-require it; floor 1.26.1).
• Unity matching each sample's ProjectSettings/ProjectVersion.txt.
• NSIS (for building installers) at C:\Program Files (x86)\NSIS\.

Building a sample

1. Build the Unity Player to Builds/Win64/<productName>/. Either:
   • Headless (canonical): samples\<sample>\unity_build.bat — batchmode build that honors the project's committed graphics API. Override the editor with set UNITY_PATH=....
   • Editor: open samples/<sample>/ in Unity and File ▸ Build. (The BiRP sample additionally has BuildScript.BuildWindows64 in Assets/Editor/DXRBuildScript.cs, which force-sets D3D12.)
2. Build its installer:

   samples\<sample>\installer\build-installer.bat [VERSION]

   The Setup .exe is written next to the stub under samples\<sample>\installer\.

Plugin pin

Each sample pins the plugin via Packages/manifest.json:

"com.displayxr.unity": "https://github.com/DisplayXR/displayxr-unity.git#upm/vX.Y.Z"

For local plugin development, override with a file: path to your displayxr-unity checkout (don't commit that override).

One shared installer — the important bit

All installer/uninstaller logic lives in installer/common/SampleInstaller.nsh. Each sample's installer/*.nsi is a thin stub that sets five SAMPLE_* !defines and !includes the shared file. Install dir, registry keys, the Add/Remove-Programs entry, the app-manifest slug, icon filenames, and the uninstall sweep are all derived from one SAMPLE_KEY — so they can never drift between samples. (This is what previously caused the HDRP installer to collide with the 2D-UI one in %ProgramData%\DisplayXR\apps\.)

Adding a sample = drop a Unity project under samples/<name>/, add a 6-line stub under its installer/, done. See CLAUDE.md for the exact stub template and conventions.

History

These samples were consolidated from the former displayxr-unity-test, displayxr-unity-test-2d-ui, displayxr-unity-test-hdrp, and displayxr-unity-test-transparent repos (full history preserved via git subtree).