mirror of
https://github.com/obsproject/obs-studio.git
synced 2024-09-19 20:32:15 +02:00
docs/sphinx: Minor formatting corrections
This commit is contained in:
parent
f4b8a3c0e0
commit
736c14f0f5
@ -78,7 +78,7 @@ it's no longer needed.
|
|||||||
|
|
||||||
*(Important note: do not use more than one display widget within the
|
*(Important note: do not use more than one display widget within the
|
||||||
hierarchy of the same base window; this will cause presentation stalls
|
hierarchy of the same base window; this will cause presentation stalls
|
||||||
on Macs.)*
|
on macOS.)*
|
||||||
|
|
||||||
For an example of how displays are used with Qt, see
|
For an example of how displays are used with Qt, see
|
||||||
`UI/qt-display.hpp`_ and `UI/qt-display.cpp`_.
|
`UI/qt-display.hpp`_ and `UI/qt-display.cpp`_.
|
||||||
|
@ -669,7 +669,7 @@ Displays
|
|||||||
|
|
||||||
*(Important note: do not use more than one display widget within the
|
*(Important note: do not use more than one display widget within the
|
||||||
hierarchy of the same base window; this will cause presentation
|
hierarchy of the same base window; this will cause presentation
|
||||||
stalls on Macs.)*
|
stalls on macOS.)*
|
||||||
|
|
||||||
:param graphics_data: The swap chain initialization data
|
:param graphics_data: The swap chain initialization data
|
||||||
:return: The new display context, or NULL if failed
|
:return: The new display context, or NULL if failed
|
||||||
|
@ -238,7 +238,7 @@ Graphics Structures
|
|||||||
|
|
||||||
.. member:: id gs_window.view
|
.. member:: id gs_window.view
|
||||||
|
|
||||||
(Mac only) A view ID.
|
(macOS only) A view ID.
|
||||||
|
|
||||||
.. member:: uint32_t gs_window.id
|
.. member:: uint32_t gs_window.id
|
||||||
void* gs_window.display
|
void* gs_window.display
|
||||||
@ -267,7 +267,7 @@ Initialization Functions
|
|||||||
|
|
||||||
.. function:: void gs_enum_adapters(bool (*callback)(void *param, const char *name, uint32_t id), void *param)
|
.. function:: void gs_enum_adapters(bool (*callback)(void *param, const char *name, uint32_t id), void *param)
|
||||||
|
|
||||||
Enumerates adapters (this really only applies on windows).
|
Enumerates adapters (this really only applies on Windows).
|
||||||
|
|
||||||
:param callback: Enumeration callback
|
:param callback: Enumeration callback
|
||||||
:param param: Private data passed to the callback
|
:param param: Private data passed to the callback
|
||||||
@ -1084,7 +1084,7 @@ Texture Functions
|
|||||||
|
|
||||||
.. function:: gs_texture_t *gs_texture_create_from_iosurface(void *iosurf)
|
.. function:: gs_texture_t *gs_texture_create_from_iosurface(void *iosurf)
|
||||||
|
|
||||||
**Mac only:** Creates a texture from an IOSurface.
|
**macOS only:** Creates a texture from an IOSurface.
|
||||||
|
|
||||||
:param iosurf: IOSurface object
|
:param iosurf: IOSurface object
|
||||||
|
|
||||||
@ -1092,7 +1092,7 @@ Texture Functions
|
|||||||
|
|
||||||
.. function:: bool gs_texture_rebind_iosurface(gs_texture_t *texture, void *iosurf)
|
.. function:: bool gs_texture_rebind_iosurface(gs_texture_t *texture, void *iosurf)
|
||||||
|
|
||||||
**Mac only:** Rebinds a texture to another IOSurface
|
**macOS only:** Rebinds a texture to another IOSurface
|
||||||
|
|
||||||
:param texture: Texture object
|
:param texture: Texture object
|
||||||
:param iosuf: IOSurface object
|
:param iosuf: IOSurface object
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
Extra Math Functions/Macros
|
Extra Math Functions/Macros
|
||||||
===========================
|
===========================
|
||||||
|
|
||||||
.. code::
|
.. code:: cpp
|
||||||
|
|
||||||
#include <graphics/math-extra.h>
|
#include <graphics/math-extra.h>
|
||||||
|
|
||||||
|
@ -3,7 +3,7 @@ Threading
|
|||||||
|
|
||||||
Libobs provides a number of helper functions/types specifically for
|
Libobs provides a number of helper functions/types specifically for
|
||||||
threading. The threading header will additionally provide access to
|
threading. The threading header will additionally provide access to
|
||||||
pthread functions even on windows.
|
pthread functions even on Windows.
|
||||||
|
|
||||||
.. code:: cpp
|
.. code:: cpp
|
||||||
|
|
||||||
|
@ -10,8 +10,8 @@ Scripting can be accessed in OBS Studio via the Tools menu -> Scripts
|
|||||||
option, which will bring up the scripting dialog. Scripts can be added,
|
option, which will bring up the scripting dialog. Scripts can be added,
|
||||||
removed, and reloaded in real time while the program is running.
|
removed, and reloaded in real time while the program is running.
|
||||||
|
|
||||||
**NOTE:** On windows, currently only Python 3.6 is supported. To use
|
**NOTE:** On Windows, currently only Python 3.6 is supported. To use
|
||||||
Python on windows, you must download and install Python 3.6.x "x86-64"
|
Python on Windows, you must download and install Python 3.6.x "x86-64"
|
||||||
for OBS 64bit (64bit is the default), or Python 3.6.x "x86" if using OBS
|
for OBS 64bit (64bit is the default), or Python 3.6.x "x86" if using OBS
|
||||||
32bit. Then, in the scripting dialog, you must set the path to the
|
32bit. Then, in the scripting dialog, you must set the path to the
|
||||||
Python 3.6.x install in the "Python Settings" tab.
|
Python 3.6.x install in the "Python Settings" tab.
|
||||||
|
Loading…
Reference in New Issue
Block a user