blender/blender-addons
19
43
Fork 96
Code Issues 627 Pull Requests 27 Projects 1 Releases Wiki Activity

BGL deprecation #80730

New Issue
Closed
opened 2020-09-12 18:08:00 +02:00 by Clément Foucault · 36 comments
Clément Foucault commented 2020-09-12 18:08:00 +02:00
Member
Copy Link

Situation:
For 2.91 we refactored the whole GPU module to be ready for vulkan. In this process we added a state tracking mechanism which removes unneeded state changes by only pushing the state before drawing commands.

The issue is that BGL does not make use of this and directly use the GL API which can lead to unsafe states.

The current workaround is to push the state to the GL before the callbacks loop starts and just force reset all states after the loop (see blender/blender@fe5efccd8f).

This is quite ugly since it does not prevent misusage of the BGL API with the pyGPU API (which is using our GPU module states).

So we have things to do here:

  • Polish the pyGPU API and force its usage everywhere: Impractical for 2.91 because there would be no transition period. But we do need to get started already since the API did change a little (see GPUOffscreen). A refactor is in the process here D8826. This is the long term plan. blender/blender@4430e8a008
  • Make wrappers inside the BGL module to make the GPUState undefined if calling a function that modifies it: This would trigger a special path inside gl_state.cc where the state would be ignored. This should fix some of the API mixing issues. blender/blender@f12b0373f3
  • ~~But we also need to push the state for commands that need it (like glClear, glDrawArray, glReadPixels, ...). ~~ blender/blender@f12b0373f3
  • The last remaining issue is our resource binding check that needs to be disable because incompatible with the glUniform + glBindTexture idiom (we now use internal fixed binding points). blender/blender@f12b0373f3

We still have to figure how to mitigate:

  • Current framebuffer state: calling glBindFramebuffer(GL_FRAMEBUFFER, id) will break the state tracking. (Resolved with python's with statement forcing a context specific block. See blender/blender@4430e8a008)
  • Current bound program state: calling glUseProgam(program) will break the state tracking.
  • ... (any other?)

Other issues with pyGPU:

  • There are still functions to get the raw GL handle for some object (Shader/Texture). Deprecate them.
  • GPUOffscreen / GPUFramebuffer now always store/resets their own Viewport/Scissor bounds. Document the API change.

Addons and scripts using the bgl module:

Related links:
https://devtalk.blender.org/t/suggestions-feedback-on-the-extensions-for-the-gpu-module/17706/38

**Situation:** For 2.91 we refactored the whole GPU module to be ready for vulkan. In this process we added a state tracking mechanism which removes unneeded state changes by only pushing the state before drawing commands. The issue is that BGL does not make use of this and directly use the GL API which can lead to unsafe states. The current workaround is to push the state to the GL before the callbacks loop starts and just force reset all states after the loop (see blender/blender@fe5efccd8f). This is quite ugly since it does not prevent misusage of the BGL API with the pyGPU API (which is using our GPU module states). **So we have things to do here:** - ~~Polish the pyGPU API and force its usage everywhere: Impractical for 2.91 because there would be no transition period. But we do need to get started already since the API did change a little (see GPUOffscreen). A refactor is in the process here [D8826](https://archive.blender.org/developer/D8826). This is the long term plan.~~ blender/blender@4430e8a008 - ~~Make wrappers inside the BGL module to make the `GPUState` undefined if calling a function that modifies it: This would trigger a special path inside `gl_state.cc` where the state would be ignored. This should fix some of the API mixing issues.~~ blender/blender@f12b0373f3 - ~~But we also need to push the state for commands that need it (like `glClear`, `glDrawArray`, `glReadPixels`, ...). ~~ blender/blender@f12b0373f3 - ~~The last remaining issue is our resource binding check that needs to be disable because incompatible with the `glUniform + glBindTexture` idiom (we now use internal fixed binding points).~~ blender/blender@f12b0373f3 **We still have to figure how to mitigate:** - ~~Current framebuffer state: calling `glBindFramebuffer(GL_FRAMEBUFFER, id)` will break the state tracking.~~ (Resolved with python's `with` statement forcing a context specific block. See blender/blender@4430e8a008) - Current bound program state: calling `glUseProgam(program)` will break the state tracking. - ... (any other?) **Other issues with pyGPU:** - There are still functions to get the raw GL handle for some object (Shader/Texture). Deprecate them. - GPUOffscreen / GPUFramebuffer now always store/resets their own Viewport/Scissor bounds. Document the API change. **Addons and scripts using the bgl module:** - [x] addons - [x] archimesh (547adaa4ed) - [x] curve_assign_shapekey.py (f7c2fc6395) - [x] curve_tools (c383b02744) - [x] cycles - [x] greasepencil_tools (294e899bf7) - [x] io_mesh_uv_layout (5578ae83b3) - [x] magic_uv (6feb9c532d) - [x] measureit (a1424dc87f) - [x] mesh_snap_utilities_line - [x] node_wrangler.py (d37c2abc6f) - [x] object_carver (708255a88f) - [x] object_collection_manager (be6cbe0222) - [x] object_scatter (c8109966ce) - [x] power_sequencer (ce8c5f8d1b) - [x] precision_drawing_tools (c1cdc33579) - [x] space_view3d_math_vis (f3e1e980b6) - [x] sun_position (af94627460) - [x] viewport_vr_preview.py (ec558f2a91) - [ ] addons_contrib - [ ] animation_motion_trail.py - [ ] exact_edit - [ ] mesh_show_vgroup_weights.py - [ ] np_station - [ ] space_clip_editor_autotracker.py - [ ] modules - [x] bl_ui_utils/bug_report_url.py - [x] bpy_types.py - [ ] gpu_extras/presets.py - [x] sys_info.py - [x] templates - [x] operador_modal_draw.py **Related links:** https://devtalk.blender.org/t/suggestions-feedback-on-the-extensions-for-the-gpu-module/17706/38
Clément Foucault commented 2020-09-12 18:08:00 +02:00
Author
Member
Copy Link

Changed status from 'Needs Triage' to: 'Confirmed'

Changed status from 'Needs Triage' to: 'Confirmed'
Clément Foucault commented 2020-09-12 18:08:00 +02:00
Author
Member
Copy Link

Added subscribers: @fclem, @ideasman42, @brecht, @mano-wii

Added subscribers: @fclem, @ideasman42, @brecht, @mano-wii
Robert Guetzkow commented 2020-09-12 18:23:38 +02:00
Member
Copy Link

Added subscriber: @rjg

Added subscriber: @rjg
Evan Wilson commented 2020-09-12 21:03:58 +02:00
Member
Copy Link

Added subscriber: @EAW

Added subscriber: @EAW
Philipp Oeser commented 2020-09-14 10:01:03 +02:00
Member
Copy Link

Added subscriber: @lichtwerk

Added subscriber: @lichtwerk
Swann Martinez commented 2020-09-24 12:32:55 +02:00
Copy Link

Added subscriber: @slumber

Added subscriber: @slumber
Jeroen Bakker commented 2020-10-06 12:37:44 +02:00
Member
Copy Link

Added subscriber: @Jeroen-Bakker

Added subscriber: @Jeroen-Bakker
Jacob Merrill commented 2020-10-14 22:59:20 +02:00
Copy Link

Added subscriber: @JacobMerrill-1

Added subscriber: @JacobMerrill-1
Jacob Merrill commented 2020-10-14 22:59:20 +02:00
Copy Link

So all the same abilities - (grab texture ID - replace with new Texture using py - will be abstracted now like the draw calls in order to be restored?)

So all the same abilities - (grab texture ID - replace with new Texture using py - will be abstracted now like the draw calls in order to be restored?)
Kenzie commented 2020-10-16 22:06:58 +02:00
Copy Link

Added subscriber: @KenzieMac130

Added subscriber: @KenzieMac130
MACHIN3 commented 2020-11-20 15:42:31 +01:00
Copy Link

Added subscriber: @MACHIN3

Added subscriber: @MACHIN3
Erik Abrahamsson commented 2020-11-30 01:58:15 +01:00
Member
Copy Link

Added subscriber: @erik85

Added subscriber: @erik85
hujin commented 2020-12-27 17:38:32 +01:00
Copy Link

Added subscriber: @2046411367

Added subscriber: @2046411367
Chris Kohl commented 2020-12-28 02:26:30 +01:00
Copy Link

Added subscriber: @ckohl_art

Added subscriber: @ckohl_art
Philippe Crassous commented 2021-02-15 15:13:50 +01:00
Copy Link

Added subscriber: @PhilippeCrassous

Added subscriber: @PhilippeCrassous
Brecht Van Lommel commented 2021-02-15 15:15:21 +01:00
Owner
Copy Link

Once D8826: Python: gpu module: add new submodules and types is committed, this task should be updated to reflect the current status.

Besides taking care of any remaining known API issues and documenting the new APIs, I think we should also involve the community. Once we are ready for it, I suggest to:

  • Create a task with the list of add-ons that needs to be updated, and get the community to help with this
  • Create a devtalk thread to gather feedback
Once [D8826: Python: gpu module: add new submodules and types](https://archive.blender.org/developer/D8826) is committed, this task should be updated to reflect the current status. Besides taking care of any remaining known API issues and documenting the new APIs, I think we should also involve the community. Once we are ready for it, I suggest to: * Create a task with the list of add-ons that needs to be updated, and get the community to help with this * Create a devtalk thread to gather feedback
blender-admin commented 2021-02-17 14:48:08 +01:00
Copy Link

This issue was referenced by blender/blender@4430e8a008

This issue was referenced by blender/blender@4430e8a00810ca8df2fa20029c4cb8078e8cdbe6
blender-admin commented 2021-02-17 16:45:52 +01:00
Copy Link

This issue was referenced by f01d08b7c5

This issue was referenced by f01d08b7c5f7873e0ce8a77b84788e2f6b1ad716
JT Nelson commented 2021-03-05 02:22:13 +01:00
Member
Copy Link

Added subscriber: @jta

Added subscriber: @jta
lvxejay commented 2021-04-19 04:27:35 +02:00
Copy Link

Added subscriber: @lvxejay

Added subscriber: @lvxejay
Jason van Gumster commented 2021-04-20 14:33:30 +02:00
Member
Copy Link

Added subscriber: @JasonvanGumster

Added subscriber: @JasonvanGumster
Vladimir Spivak commented 2021-05-14 21:37:56 +02:00
Member
Copy Link

Added subscriber: @cwolf3d

Added subscriber: @cwolf3d
warcanin commented 2021-05-15 04:56:57 +02:00
Copy Link

Added subscriber: @warcanin

Added subscriber: @warcanin
Alistair Sealy commented 2021-05-18 17:17:58 +02:00
Copy Link

Added subscriber: @alisealy

Added subscriber: @alisealy
Alexander Samsonov commented 2021-05-22 21:59:40 +02:00
Copy Link

Added subscriber: @blendersamsonov

Added subscriber: @blendersamsonov
Christian Stolze commented 2021-06-12 14:03:41 +02:00
Copy Link

Added subscriber: @regcs

Added subscriber: @regcs
Raimund Klink commented 2021-09-20 10:55:28 +02:00
Copy Link

Added subscriber: @Raimund58

Added subscriber: @Raimund58
Ryan Inch commented 2021-10-26 09:58:52 +02:00
Member
Copy Link

Added subscriber: @Imaginer

Added subscriber: @Imaginer
Moritz Brückner commented 2021-11-25 22:11:11 +01:00
Copy Link

Added subscriber: @timodriaan

Added subscriber: @timodriaan
David Friedli commented 2021-12-07 07:44:12 +01:00
Copy Link

Added subscriber: @hlorus

Added subscriber: @hlorus
jon denning commented 2021-12-09 15:42:33 +01:00
Member
Copy Link

Added subscriber: @gfxcoder

Added subscriber: @gfxcoder
Jakub Uhlik commented 2022-04-11 13:36:36 +02:00
Copy Link

Added subscriber: @JakubUhlik

Added subscriber: @JakubUhlik
blender-admin commented 2022-05-19 21:10:17 +02:00
Copy Link

This issue was referenced by blender/blender@1a627d528c

This issue was referenced by blender/blender@1a627d528cf91a58893e31ce89a6114eec2a6630
Ryan Inch commented 2022-09-22 07:20:51 +02:00
Member
Copy Link

So, which release is BGL actually going to be removed for? And why was object_collection_manager removed from the list?

So, which release is BGL actually going to be removed for? And why was object_collection_manager removed from the list?
Germano Cavalcante commented 2022-09-22 18:55:58 +02:00
Member
Copy Link

In #80730#1420991, @Imaginer wrote:
So, which release is BGL actually going to be removed for?

Probably in 3.4 (along with the Metal stand support)

And why was object_collection_manager removed from the list?

It doesn't look like this addon has ever used bgl, it seems like it was a mistake to add it to the list.

> In #80730#1420991, @Imaginer wrote: > So, which release is BGL actually going to be removed for? Probably in 3.4 (along with the Metal stand support) > And why was object_collection_manager removed from the list? It doesn't look like this addon has ever used `bgl`, it seems like it was a mistake to add it to the list.
Ryan Inch commented 2022-09-25 11:24:39 +02:00
Member
Copy Link

It doesn't look like this addon has ever used bgl, it seems like it was a mistake to add it to the list.

No, it uses bgl fairly extensively in qcd_move_widget.py (I should know, I'm the author 😛 )

I've been waiting to update it to use the pyGPU API for a number of reasons, but if it's official that bgl is being removed for 3.4 then I'll update it.

> It doesn't look like this addon has ever used bgl, it seems like it was a mistake to add it to the list. No, it uses `bgl` fairly extensively in `qcd_move_widget.py` (I should know, I'm the author 😛 ) I've been waiting to update it to use the pyGPU API for a number of reasons, but if it's official that `bgl` is being removed for 3.4 then I'll update it.
Blender Bot added
Status
Archived
 and removed
Status
Confirmed
 labels 2024-02-26 14:24:19 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels   
Interest
Animation & Rigging

  
Interest
Blender Cloud

  
Interest
Collada

  
Interest
Core

  
Interest
Documentation

  
Interest
Eevee & Viewport

  
Interest
Geometry Nodes

  
Interest
Grease Pencil

  
Interest
Import and Export

  
Interest
Modeling

  
Interest
Modifiers

  
Interest
Nodes & Physics

  
Interest
Pipeline, Assets & IO

  
Interest
Platforms, Builds, Tests & Devices

  
Interest
Python API

  
Interest
Rendering & Cycles

  
Interest
Sculpt, Paint & Texture

  
Interest
Translations

  
Interest
User Interface

  
Interest
UV Editing

  
Interest
VFX & Video

  
Meta
Good First Issue

  
Meta
Papercut

  
Module
Add-ons (BF-Blender)

  
Module
Add-ons (Community)

  
Platform
Linux

  
Platform
macOS

  
Platform
Windows

  
Priority
High

  
Priority
Low

  
Priority
Normal

  
Priority
Unbreak Now!

  
Status
Archived

  
Status
Confirmed

  
Status
Duplicate

  
Status
Needs Info from Developers

  
Status
Needs Information from User

  
Status
Needs Triage

  
Status
Resolved

  
Type
Bug

  
Type
Design

  
Type
Known Issue

  
Type
Patch

  
Type
Report

  
Type
To Do

No Label
Interest
Animation & Rigging
Interest
Blender Cloud
Interest
Collada
Interest
Core
Interest
Documentation
Interest
Eevee & Viewport
Interest
Geometry Nodes
Interest
Grease Pencil
Interest
Import and Export
Interest
Modeling
Interest
Modifiers
Interest
Nodes & Physics
Interest
Pipeline, Assets & IO
Interest
Platforms, Builds, Tests & Devices
Interest
Python API
Interest
Rendering & Cycles
Interest
Sculpt, Paint & Texture
Interest
Translations
Interest
User Interface
Interest
UV Editing
Interest
VFX & Video
Meta
Good First Issue
Meta
Papercut
Module
Add-ons (BF-Blender)
Module
Add-ons (Community)
Platform
Linux
Platform
macOS
Platform
Windows
Priority
High
Priority
Low
Priority
Normal
Priority
Unbreak Now!
Status
Archived
Status
Confirmed
Status
Duplicate
Status
Needs Info from Developers
Status
Needs Information from User
Status
Needs Triage
Status
Resolved
Type
Bug
Type
Design
Type
Known Issue
Type
Patch
Type
Report
Type
To Do
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
30 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender-addons#80730
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?