obs-studio/docs/sphinx
Jim 03d9bda387 libobs: Deprecate obs object addref functions
Deprecates:
obs_source_addref()
obs_output_addref()
obs_encoder_addref()
obs_service_addref()
obs_scene_addref()

These functions should be considered unsafe and not used. Instead, use:
obs_source_get_ref()
obs_output_get_ref()
obs_encoder_get_ref()
obs_service_get_ref()
obs_scene_get_ref()

These functions return a pointer to the incremented object only if the
object is still valid, otherwise they will return null, indicating that
the object is no longer valid or is unsafe to use.

The reason why this is being done is because certain third party plugins
seem to be using addref, and are somehow managing to call addref on
sources that have already been fully released. For the sake of safety,
almost all usage of these functions within OBS have also been replaced
as well.
2022-01-25 05:20:03 -08:00
..
_build docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
_static docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
_templates docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
backend-design.rst docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
conf.py docs/sphinx: Bump major OBS version 2020-03-28 23:17:20 +11:00
frontends.rst docs/sphinx: Fix various typos 2019-10-14 17:19:38 -07:00
graphics.rst docs/sphinx: Document SRGB changes 2021-01-21 07:42:56 -08:00
index.rst docs/sphinx: Add scripting documentation 2018-01-04 11:37:43 -08:00
make.bat docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
Makefile docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
plugins.rst docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
reference-core-objects.rst docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
reference-core.rst docs: Document obs_get_scene_by_name 2021-12-23 06:31:45 -08:00
reference-encoders.rst libobs: Deprecate obs object addref functions 2022-01-25 05:20:03 -08:00
reference-frontend-api.rst docs: Fix frontend API docs for preview_scene functions 2022-01-04 01:53:42 -08:00
reference-libobs-callback.rst libobs/callback: Add signal reference counting 2018-06-03 15:04:03 -07:00
reference-libobs-graphics-axisang.rst docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
reference-libobs-graphics-effects.rst docs/sphinx: Document SRGB changes 2021-01-21 07:42:56 -08:00
reference-libobs-graphics-graphics.rst libobs/graphics: Add Linux-only gs_query_dmabuf_* functions 2021-12-22 14:27:53 -03:00
reference-libobs-graphics-image-file.rst docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
reference-libobs-graphics-math.rst docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
reference-libobs-graphics-matrix4.rst docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
reference-libobs-graphics-quat.rst docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
reference-libobs-graphics-vec2.rst docs/sphinx: Fix various typos 2019-10-14 17:19:38 -07:00
reference-libobs-graphics-vec3.rst docs/sphinx: Fix various typos 2019-10-14 17:19:38 -07:00
reference-libobs-graphics-vec4.rst docs/sphinx: Fix various typos 2019-10-14 17:19:38 -07:00
reference-libobs-graphics.rst docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
reference-libobs-media-io.rst docs: Fix outdated speaker_layout enum 2021-11-19 00:16:23 -05:00
reference-libobs-util-base.rst docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
reference-libobs-util-bmem.rst docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
reference-libobs-util-circlebuf.rst libobs/util: Add funcs to push zeroed data to circlebufs 2017-12-02 13:52:40 -08:00
reference-libobs-util-config-file.rst docs: Add missing config_t get/set functions 2021-11-23 21:52:30 -08:00
reference-libobs-util-darray.rst docs/sphinx: Fix various typos 2019-10-14 17:19:38 -07:00
reference-libobs-util-dstr.rst docs/sphinx: Fix various typos 2019-10-14 17:19:38 -07:00
reference-libobs-util-platform.rst libobs: Add os_is_obs_plugin function 2021-01-18 19:05:41 -08:00
reference-libobs-util-profiler.rst docs/sphinx: Fix various typos 2019-10-14 17:19:38 -07:00
reference-libobs-util-serializers.rst docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
reference-libobs-util-text-lookup.rst docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
reference-libobs-util-threading.rst docs/sphinx: Update atomic API 2021-02-03 08:51:31 -08:00
reference-libobs-util.rst docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
reference-modules.rst libobs: Add function to get module lib 2021-01-26 03:31:31 -08:00
reference-outputs.rst libobs: Deprecate obs object addref functions 2022-01-25 05:20:03 -08:00
reference-properties.rst libobs, UI: Add support for button properties as links 2021-07-09 17:32:09 +12:00
reference-scenes.rst libobs: Deprecate obs object addref functions 2022-01-25 05:20:03 -08:00
reference-services.rst libobs: Deprecate obs object addref functions 2022-01-25 05:20:03 -08:00
reference-settings.rst libobs: Add obs_data_get_last_json() 2021-04-23 12:38:50 -07:00
reference-sources.rst libobs: Deprecate obs object addref functions 2022-01-25 05:20:03 -08:00
scripting.rst docs/sphinx: Fix incorrect callback information 2020-08-31 12:02:11 +12:00