From 1a627d528cf91a58893e31ce89a6114eec2a6630 Mon Sep 17 00:00:00 2001
From: Brecht Van Lommel <brecht@blender.org>
Date: Thu, 19 May 2022 21:10:17 +0200
Subject: 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
---
 doc/python_api/rst/bgl.rst | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'doc')

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.
 
-- 
cgit v1.2.3