cursor:zoom_factor in Lua config - how to set/get correctly?

[ngxccc]

Hi team,

I'm migrating my config to the new Lua parser (hyprland.lua) and I'm trying to dynamically change cursor:zoom_factor.

What I tried:

In hyprland.lua:

hypr.set_option("cursor:zoom_factor", 1.5)

or via terminal:

hyprctl eval 'hypr.set_option("cursor:zoom_factor", 1.5)'

Problem:

• hyprctl keyword returns: "keyword can't work with non-legacy parsers. Use eval."
• hyprctl eval with various syntaxes returns either "function arguments expected near '='" or "attempt to index a nil value (global 'hypr')"

Questions:

1. What is the correct way to set cursor:zoom_factor (and other options) inside hyprland.lua?
2. Is there a hypr.get_option() / hypr.set_option() API available, or should we use another method?

Environment:

• Hyprland main branch (Lua config)
• Arch Linux

Thanks in advance!

[Hy4ri]

@ngxccc
here is how you can get the zoom value:
hl.get_config("cursor.zoom_factor")

and here how to edit it:

hl.config({
    cursor = { zoom_factor = 2 }
  })

[ngxccc]

How can I pass a custom value to the zoom shortcut?

[hitahitahitahita]

@ngxccc You can do this mate :

hyprctl eval "hl.config({ cursor = { zoom_factor = 2 }})" 

I ended up with one-liners like this to increment/decrement from current value :

hyprctl eval "hl.config({ cursor = { zoom_factor = $(hyprctl getoption cursor:zoom_factor | awk '/^float/ {print $2 * 0.9}') }})"

Cheers, it4

[aphelei]

i wrote this if you want. The event will make zoom per monitor. If you zoom on a monitor and then focus another monitor it will set zoom_factor to 1.0 or go back to the zoom you had previously. Unzooming is a bit ugly but it's usable. If you don't like it just remove it.

Monitor_zoom = {}
function Adjust_zoom(operation)
	local monitor = hl.get_active_monitor().name
	local current = Monitor_zoom[monitor] or hl.get_config("cursor.zoom_factor")
	local new_zoom
	if operation == "*" then
		new_zoom = current * 1.1
	elseif operation == "/" then
		new_zoom = current / 1.1
		if new_zoom < 1.0 then
			new_zoom = 1.0
		end
	else
		new_zoom = 1.0
	end
	Monitor_zoom[monitor] = new_zoom
	hl.config({ cursor = { zoom_factor = new_zoom } })
end

hl.bind(mainMod .. " + mouse_down", function()
	Adjust_zoom("*")
end)
hl.bind(mainMod .. " + mouse_up", function()
	Adjust_zoom("/")
end)
hl.bind(mainMod .. " + SHIFT + mouse_up", function()
	Adjust_zoom("1")
end)
hl.bind(mainMod .. " + equal", function()
	Adjust_zoom("*")
end, { repeating = true, description = "Zoom in" })
hl.bind(mainMod .. " + minus", function()
	Adjust_zoom("/")
end, { repeating = true, description = "Zoom out" })
hl.bind(mainMod .. " + SHIFT + minus", function()
	Adjust_zoom("1")
end)
hl.bind(mainMod .. " + KP_ADD", function()
	Adjust_zoom("*")
end, { repeating = true })
hl.bind(mainMod .. " + KP_SUBTRACT", function()
	Adjust_zoom("/")
end, { repeating = true })
hl.bind(mainMod .. " + SHIFT + KP_SUBTRACT", function()
	Adjust_zoom("1")
end)
hl.bind("MOD5 + KP_ADD", function()
	Adjust_zoom("*")
end, { repeating = true })
hl.bind("MOD5 + KP_SUBTRACT", function()
	Adjust_zoom("/")
end, { repeating = true })
hl.bind("MOD5 + SHIFT + KP_SUBTRACT", function()
	Adjust_zoom("1")
end)

hl.on("monitor.focused", function()
	local zoom = Monitor_zoom[monitor] or 1.0
	hl.config({ cursor = { zoom_factor = zoom } })
end)

[ngxccc]

Big thanks to @hitahitahitahita, @Hy4ri, @rubyist, it works! This is my config:

-- Zoom Shortcut
local global_zoom = 1.0

local function adjust_zoom(operation)
  if operation == "*" then
    global_zoom = math.min(global_zoom * 1.1, 3.0)
  elseif operation == "/" then
    global_zoom = math.max(global_zoom / 1.1, 1.0)
  else
    global_zoom = 1.0
  end

  hl.config({ cursor = { zoom_factor = global_zoom } })
end

hl.bind(mainMod .. " + Z", function()
  hl.dispatch(hl.dsp.submap("zoom_mode"))
  hl.dispatch(
    hl.dsp.exec_cmd(
      "notify-send -t 1500 'Zoom mode' 'scroll to zoom. press E to exit.'"
    )
  )
end, { desc = "Enter Zoom Mode" })

hl.define_submap("zoom_mode", function()
  hl.bind("k", function()
    adjust_zoom("*")
  end, { repeating = true, desc = "Zoom In" })
  hl.bind("j", function()
    adjust_zoom("/")
  end, { repeating = true, desc = "Zoom Out" })

  -- hl.bind("equal", function()
  --   adjust_zoom("*")
  -- end, { repeating = true })

  -- hl.bind("minus", function()
  --   adjust_zoom("/")
  -- end, { repeating = true })

  hl.bind("0", function()
    adjust_zoom("1")
  end)

  hl.bind("e", function()
    hl.dispatch(hl.dsp.submap("reset"))
    hl.dispatch(
      hl.dsp.exec_cmd("notify-send -t 1500 'Normal mode' 'Exited Zoom Mode.'")
    )
  end)
end)

[fdev31]

Is it supposed to work with the version 0.54.0 ?