obs-studio icon indicating copy to clipboard operation
obs-studio copied to clipboard

docs: Add API disclaimer to canvases

Open Warchamp7 opened this issue 3 weeks ago • 0 comments

Description

Adds a disclaimer to the docs regarding Canvases and their current in-progress state image

Motivation and Context

I want to make sure we have a sign to tap when these APIs change and evolve as we use them.

In a perfect world Canvases would have been added to libobs, implemented across all of OBS Studio, and in a more or less final state. That is sadly unrealistic with the resources we have available, and it was decided it was better to implement canvases gradually as both project and volunteer contributors have time to do so. Due to the architecture of libobs and OBS there is no way currently for us to have private APIs that are available to OBS and not plugins. An unstable API is the lesser of two evils here and so we disclose as such.

How Has This Been Tested?

Built the docs locally.

Types of changes

  • Documentation (a change to documentation pages)

Checklist:

  • [x] My code has been run through clang-format.
  • [x] I have read the contributing document.
  • [x] My code is not on the master branch.
  • [x] The code has been tested.
  • [x] All commit messages are properly formatted and commits squashed where appropriate.
  • [x] I have included updates to all appropriate documentation.

Warchamp7 avatar Dec 03 '25 19:12 Warchamp7