[Bf-blender-cvs] [1a627d528cf] blender-v3.2-release: Python API: warn that the bgl module is deprecated in the docs

[Brecht Van Lommel]

Commit: 1a627d528cf91a58893e31ce89a6114eec2a6630
Author: Brecht Van Lommel
Date:   Thu May 19 21:10:17 2022 +0200
Branches: blender-v3.2-release
https://developer.blender.org/rB1a627d528cf91a58893e31ce89a6114eec2a6630

Python API: warn that the bgl module is deprecated in the docs

This was already mentioned in the release notes but not the API docs.

Ref T80730

===================================================================

M	doc/python_api/rst/bgl.rst

===================================================================

diff --git a/doc/python_api/rst/bgl.rst b/doc/python_api/rst/bgl.rst
index 2369a422396..48d7d31489c 100644
--- a/doc/python_api/rst/bgl.rst
+++ b/doc/python_api/rst/bgl.rst
@@ -4,6 +4,12 @@ OpenGL Wrapper (bgl)
 
 .. module:: bgl
 
+.. warning::
+
+   This module is deprecated and will be removed in a future release,
+   when OpenGL is replaced by Metal and Vulkan.
+   Use the graphics API independent :mod:`gpu` module instead.
+
 This module wraps OpenGL constants and functions, making them available from
 within Blender Python.