summary refs log tree commit diff
path: root/doc/packages/opengl.section.md
diff options
context:
space:
mode:
authorAdam Joseph <54836058+amjoseph-nixpkgs@users.noreply.github.com>2023-11-08 06:15:46 +0000
committerGitHub <noreply@github.com>2023-11-08 06:15:46 +0000
commitba2ed469c261928415e1121f26bfe96ebbed8a33 (patch)
tree806254c8497062bce2f1d43b4602002290a4ae1a /doc/packages/opengl.section.md
parent4c234ceeb61f6d111bb1db30376cdb4019e56142 (diff)
parent3db5de3ba9909bc8631fe6808638099a5cad0a49 (diff)
downloadnixpkgs-ba2ed469c261928415e1121f26bfe96ebbed8a33.tar
nixpkgs-ba2ed469c261928415e1121f26bfe96ebbed8a33.tar.gz
nixpkgs-ba2ed469c261928415e1121f26bfe96ebbed8a33.tar.bz2
nixpkgs-ba2ed469c261928415e1121f26bfe96ebbed8a33.tar.lz
nixpkgs-ba2ed469c261928415e1121f26bfe96ebbed8a33.tar.xz
nixpkgs-ba2ed469c261928415e1121f26bfe96ebbed8a33.tar.zst
nixpkgs-ba2ed469c261928415e1121f26bfe96ebbed8a33.zip
Merge branch 'master' into staging-next
Diffstat (limited to 'doc/packages/opengl.section.md')
-rw-r--r--doc/packages/opengl.section.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/packages/opengl.section.md b/doc/packages/opengl.section.md
new file mode 100644
index 00000000000..f4d282267a0
--- /dev/null
+++ b/doc/packages/opengl.section.md
@@ -0,0 +1,15 @@
+# OpenGL {#sec-opengl}
+
+OpenGL support varies depending on which hardware is used and which drivers are available and loaded.
+
+Broadly, we support both GL vendors: Mesa and NVIDIA.
+
+## NixOS Desktop {#nixos-desktop}
+
+The NixOS desktop or other non-headless configurations are the primary target for OpenGL libraries and applications. The current solution for discovering which drivers are available is based on [libglvnd](https://gitlab.freedesktop.org/glvnd/libglvnd). `libglvnd` performs "vendor-neutral dispatch", trying a variety of techniques to find the system's GL implementation. In practice, this will be either via standard GLX for X11 users or EGL for Wayland users, and supporting either NVIDIA or Mesa extensions.
+
+## Nix on GNU/Linux {#nix-on-gnulinux}
+
+If you are using a non-NixOS GNU/Linux/X11 desktop with free software video drivers, consider launching OpenGL-dependent programs from Nixpkgs with Nixpkgs versions of `libglvnd` and `mesa.drivers` in `LD_LIBRARY_PATH`. For Mesa drivers, the Linux kernel version doesn't have to match nixpkgs.
+
+For proprietary video drivers, you might have luck with also adding the corresponding video driver package.