Browse Source

Update docs;

bjorn 5 months ago
parent
commit
dae046bb14
2 changed files with 3 additions and 2 deletions
  1. 1 1
      api/init.lua
  2. 2 1
      api/lovr/system/pollEvents.lua

+ 1 - 1
api/init.lua

@@ -44626,7 +44626,7 @@ return {
           name = "pollEvents",
           name = "pollEvents",
           tag = "system-window",
           tag = "system-window",
           summary = "Poll the OS for new window events.",
           summary = "Poll the OS for new window events.",
-          description = "Fills the event queue with unprocessed events from the operating system.  This function should be called often, otherwise the operating system will consider the application unresponsive. This function is called in the default implementation of `lovr.run`.",
+          description = "Fills the event queue with unprocessed events from the operating system.  This function should be called often, otherwise the operating system will consider the application unresponsive. This function is called in the default implementation of `lovr.run`, and the events are later processed by `lovr.event.poll`.",
           key = "lovr.system.pollEvents",
           key = "lovr.system.pollEvents",
           module = "lovr.system",
           module = "lovr.system",
           related = {
           related = {

+ 2 - 1
api/lovr/system/pollEvents.lua

@@ -4,7 +4,8 @@ return {
   description = [[
   description = [[
     Fills the event queue with unprocessed events from the operating system.  This function should
     Fills the event queue with unprocessed events from the operating system.  This function should
     be called often, otherwise the operating system will consider the application unresponsive.
     be called often, otherwise the operating system will consider the application unresponsive.
-    This function is called in the default implementation of `lovr.run`.
+    This function is called in the default implementation of `lovr.run`, and the events are later
+    processed by `lovr.event.poll`.
   ]],
   ]],
   arguments = {},
   arguments = {},
   returns = {},
   returns = {},