Hyprland hl.* Lua API Reference

This is an AI-generated HTML reference for the hl global Lua table exposed by Hyprland's Lua configuration system.

Disclaimer

This document was not created by the Hyprland project. It is an independent reference generated by an AI system (opencode) based on analysis of the Hyprland source code at commit a0136d8c04687bb36eb8a28eb9d1ff92aea99704 (v0.55.4).

For the official documentation, visit the Hyprland Wiki.

Source of Truth

The reference was compiled by reading the following source files from the Hyprland repository:

• src/config/lua/bindings/LuaBindingsRegistration.cpp — binding registration
• src/config/lua/bindings/LuaBindingsQuery.cpp — hl.get_*() functions
• src/config/lua/bindings/LuaBindingsDispatchers.cpp — hl.dsp.* dispatchers
• src/config/lua/bindings/LuaBindingsToplevel.cpp — hl.bind(), hl.on(), hl.timer()
• src/config/lua/bindings/LuaBindingsConfigRules.cpp — hl.config(), hl.monitor(), hl.window_rule(), etc.
• src/config/lua/bindings/LuaBindingsNotification.cpp — hl.notification.*
• src/config/lua/objects/LuaWindow.cpp — HL.Window properties
• src/config/lua/objects/LuaWorkspace.cpp — HL.Workspace properties
• src/config/lua/objects/LuaMonitor.cpp — HL.Monitor properties
• src/config/lua/objects/LuaLayerSurface.cpp — HL.LayerSurface properties
• src/config/lua/objects/LuaGroup.cpp — HL.Group properties
• src/config/lua/bindings/LuaBindingsInternal.hpp — window & layer rule effects lists
• src/config/lua/LuaEventHandler.cpp — event system
• src/config/lua/objects/LuaEventSubscription.cpp — event subscription handle
• src/config/lua/objects/LuaNotification.cpp — notification handle methods