diff --git a/docs/sphinx/reference-canvases.rst b/docs/sphinx/reference-canvases.rst index 1edf7be08..5639433d7 100644 --- a/docs/sphinx/reference-canvases.rst +++ b/docs/sphinx/reference-canvases.rst @@ -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.