Addons with gpu rendering may not work in 4.0.0 #114359

New Issue

Inês Almeida · 2023-11-01T10:35:54+01:00

Inês Almeida commented

2023-11-01 10:35:54 +01:00

Blender Version
Broken: 4.0.0-beta, commit date 2023-11-01
Worked: 3.6

Short description of error
Due to changes in the Python API for builtin shaders, addons may no longer work in 4.0.
They won't display as expected, due to an error such as this:

ValueError: expected a string in ('FLAT_COLOR', 'IMAGE', 'IMAGE_COLOR', 'SMOOTH_COLOR', 'UNIFORM_COLOR', 'POLYLINE_FLAT_COLOR', 'POLYLINE_SMOOTH_COLOR', 'POLYLINE_UNIFORM_COLOR'), got '2D_UNIFORM_COLOR'

Longer description
While usage of the bgl module had a deprecation warning, removal of gpu.shader.2D_UNIFORM_COLOR and 2D_IMAGE came as an unexpected surprise (at least to me :).
I tested the addons I maintain with a development version of 4.0 a couple months ago, made sure they're updated from bgl to gpu and today I gave them a quick check before 4.0 release and was surprised that they don't work at all.

It seems related to this change 223665b994, but it mentions it intends to keep API backwards compatibility, I'm not sure when that was lost.

Maybe backwards compatibility is intended, but not working?
Or, please provide instructions for addon developers to update their addons to work both in 4.0 and 3.6LTS.

There are other addons with the same issue: #113004

**Blender Version** Broken: 4.0.0-beta, commit date 2023-11-01 Worked: 3.6 **Short description of error** Due to changes in the Python API for builtin shaders, addons may no longer work in 4.0. They won't display as expected, due to an error such as this: `ValueError: expected a string in ('FLAT_COLOR', 'IMAGE', 'IMAGE_COLOR', 'SMOOTH_COLOR', 'UNIFORM_COLOR', 'POLYLINE_FLAT_COLOR', 'POLYLINE_SMOOTH_COLOR', 'POLYLINE_UNIFORM_COLOR'), got '2D_UNIFORM_COLOR'` **Longer description** While usage of the `bgl` module had a deprecation warning, removal of `gpu.shader.2D_UNIFORM_COLOR` and `2D_IMAGE `came as an unexpected surprise (at least to me :). I tested the addons I maintain with a development version of 4.0 a couple months ago, made sure they're updated from bgl to gpu and today I gave them a quick check before 4.0 release and was surprised that they don't work at all. It seems related to this change https://projects.blender.org/blender/blender/commit/223665b994d785672c023432ac3861d4d2c0ffb6, but it mentions it intends to keep API backwards compatibility, I'm not sure when that was lost. Maybe backwards compatibility is intended, but not working? Or, please provide instructions for addon developers to update their addons to work both in 4.0 and 3.6LTS. There are other addons with the same issue: https://projects.blender.org/blender/blender/issues/113004

Inês Almeida added the

labels 2023-11-01 10:35:55 +01:00

Inês Almeida commented

2023-11-01 10:53:21 +01:00

Simply using the new names seems to also work for 3.6 and 3.3LTS :)

Example:
gpu.shader.from_builtin('2D_UNIFORM_COLOR') → gpu.shader.from_builtin('UNIFORM_COLOR')

Updating Edit Breakdown addon: 8ea7be3024

Simply using the new names seems to also work for 3.6 and 3.3LTS :) Example: `gpu.shader.from_builtin('2D_UNIFORM_COLOR')` → `gpu.shader.from_builtin('UNIFORM_COLOR')` Updating Edit Breakdown addon: https://github.com/britalmeida/edit_breakdown/commit/8ea7be30244b519d99bdf7b93a34d5d6170527fb

Iliya Katushenock added

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Addons with gpu rendering may not work in 4.0.0 #114359