mirror/obs-studio
0
0
Fork 0
mirror of https://github.com/obsproject/obs-studio.git synced 2024-09-19 20:32:15 +02:00
Code

docs: Clarify signal_handler_connect()

Browse Source 
Notes that it does nothing if the combination of `signal`,
`callback`, and `data` is already connected to the handler.
Adds missing param `signal` description.
Typo fix
This commit is contained in:
CodeYan01 2022-11-24 03:16:16 +08:00 committed by Jim
parent b6fe7dbd4e
commit d3eba18718
1 changed files with 16 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/sphinx/reference-libobs-callback.rst
View File

@ -192,11 +192,14 @@ Signals are used for all event-based callbacks.
.. function:: void signal_handler_connect(signal_handler_t *handler, const char *signal, signal_callback_t callback, void *data)
Connect a callback to a signal on a signal handler.
Connects a callback to a signal on a signal handler. Does nothing
if the combination of ``signal``, ``callback``, and ``data``
is already connected to the handler.
:param handler: Signal handler object
:param signal: Name of signal to handle
:param callback: Signal callback
:param data: Private data passed the callback
:param data: Private data passed to the callback
For scripting, use :py:func:`signal_handler_connect`.
@ -204,23 +207,29 @@ Signals are used for all event-based callbacks.
.. function:: void signal_handler_connect_ref(signal_handler_t *handler, const char *signal, signal_callback_t callback, void *data)
Connect a callback to a signal on a signal handler, and increments
Connects a callback to a signal on a signal handler, and increments
the handler's internal reference counter, preventing it from being
destroyed until the signal has been disconnected.
destroyed until the signal has been disconnected. Even if the combination of
``signal``, ``callback``, and ``data`` is already connected to the handler,
the reference counter is still incremented.
:param handler: Signal handler object
:param signal: Name of signal to handle
:param callback: Signal callback
:param data: Private data passed the callback
:param data: Private data passed to the callback
---------------------
.. function:: void signal_handler_disconnect(signal_handler_t *handler, const char *signal, signal_callback_t callback, void *data)
Disconnects a callback from a signal on a signal handler.
Disconnects a callback from a signal on a signal handler. Does nothing
if the combination of ``signal``, ``callback``, and ``data``
is not yet connected to the handler.
:param handler: Signal handler object
:param signal: Name of signal that was handled
:param callback: Signal callback
:param data: Private data passed the callback
:param data: Private data passed to the callback
For scripting, use :py:func:`signal_handler_disconnect`.