mirror/obs-studio
1
0
Fork 0
mirror of https://github.com/obsproject/obs-studio.git synced 2026-05-19 05:51:16 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add API disclaimer to canvases

Browse Source
This commit is contained in:
Warchamp7
2025-12-03 14:38:37 -05:00
committed by Ryan Foster
parent ad4315b15a
commit bf0ec56df3
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/sphinx/reference-canvases.rst
View File

@@ -1,6 +1,16 @@
Canvas API Reference (obs_canvas_t)
===================================
.. danger::
Canvases are still in their early stages of implementation and the API will evolve as they are gradually integrated
across OBS Studio.
The Canvas API should be considered **unstable** and may be changed without warning. This documentation serves to aid
in their iterative development within OBS Studio.
**If you are developing a plugin that utilizes canvases, proceed with great caution.**
Canvases are reference-counted objects that contain scenes and define how those are rendered.
They provide a video object which can be used with encoders or raw outputs.