Setting Workbench as Render Engine blocks loading of icon previews #69001

New Issue

Mikhail Rachinskiy · 2019-08-21T16:59:26+02:00

2019-08-21 16:59:26 +02:00

System Information
Operating system: Windows-10-10.0.17134 64 Bits
Graphics card: GeForce GTX 860M/PCIe/SSE2 NVIDIA Corporation 4.5.0 NVIDIA 430.86

Blender Version
Broken: version: 2.81 (sub 2), branch: master, commit date: 2019-08-17 21:40, hash: e69fb44027

Short description of error
Setting Workbench as Render Engine blocks loading of icon previews, while setting it to EEVEE or Cycles does not.

Exact steps for others to reproduce the error

Open attached blend file: workbench_x_icons.zip
Use Run Script and check TEST tab in Sidebar (icon loads).

Change Render Engine to Workbench and use Run Script again (icon does not load).

workbench_x_icons.mp4

**System Information** Operating system: Windows-10-10.0.17134 64 Bits Graphics card: GeForce GTX 860M/PCIe/SSE2 NVIDIA Corporation 4.5.0 NVIDIA 430.86 **Blender Version** Broken: version: 2.81 (sub 2), branch: master, commit date: 2019-08-17 21:40, hash: `e69fb44027` **Short description of error** Setting Workbench as Render Engine blocks loading of icon previews, while setting it to EEVEE or Cycles does not. **Exact steps for others to reproduce the error** - Open attached blend file: [workbench_x_icons.zip](https://archive.blender.org/developer/F7681096/workbench_x_icons.zip) - Use Run Script and check TEST tab in Sidebar (icon loads). # Change Render Engine to Workbench and use Run Script again (icon does not load). [workbench_x_icons.mp4](https://archive.blender.org/developer/F7681123/workbench_x_icons.mp4)

Mikhail Rachinskiy commented

2019-08-21 16:59:26 +02:00

Added subscriber: @MikhailRachinskiy

blender-admin commented

2019-08-21 16:59:26 +02:00

blender/blender-addons#80110 was marked as duplicate of this issue

blender-admin commented

2019-08-21 16:59:26 +02:00

#76169 was marked as duplicate of this issue

blender-admin commented

2019-08-21 16:59:26 +02:00

#74405 was marked as duplicate of this issue

Philipp Oeser commented

2019-08-21 18:27:34 +02:00

Added subscriber: @lichtwerk

Philipp Oeser commented

2019-08-21 18:27:34 +02:00

Interesting, will have a quick look...

Philipp Oeser commented

2019-11-28 17:21:45 +01:00

Afaict, bpy_utils_previews_load does its thing in three cases without something obvious going wrong, needs some further investigation still :(

Afaict, `bpy_utils_previews_load` does its thing in three cases without something obvious going wrong, needs some further investigation still :(

Brecht Van Lommel commented

2020-03-04 01:51:21 +01:00

Added subscriber: @Andrew_D

Philipp Oeser commented

2020-04-28 11:42:00 +02:00

Added subscribers: @Dervock, @BrendonMurphy

Philipp Oeser commented

2020-08-25 18:45:09 +02:00

Added subscriber: @oswaldo.sndvl

Oswaldo E Sandoval G commented

2020-08-26 00:33:21 +02:00

So I was able to recreate the problem and a temporary solution. I made a video of it. HopsIcons.mp4

So I was able to recreate the problem and a temporary solution. I made a video of it. [HopsIcons.mp4](https://archive.blender.org/developer/F8811045/HopsIcons.mp4)

Robert Guetzkow commented

2021-01-28 00:06:49 +01:00

Added subscriber: @rjg

Robert Guetzkow commented

2021-01-28 00:06:49 +01:00

When the workbench engine is used, the icon_preview_startjob isn't called, which results in the missing icon. icon_preview_startjob should've been called eventually once icon_preview_startjob_all_sizes is called (set as callback for window manager job by ED_preview_icon_job).

Callstack when Eevee is used:

icon_preview_startjob(void * customdata, short * stop, short * do_update) Line 1238	C
common_preview_startjob(void * customdata, short * stop, short * do_update, float * UNUSED_progress) Line 1343	C
other_id_types_preview_render(IconPreview * ip, IconPreviewSize * cur_size, const bool is_deferred, short * stop, short * do_update, float * progress) Line 1396	C
icon_preview_startjob_all_sizes(void * customdata, short * stop, short * do_update, float * progress) Line 1456	C
do_job_thread(void * job_v) Line 390	C

However, it doesn't when the render engine is set to Workbench because of the following check in icon_preview_startjob_all_sizes:

    if (!check_engine_supports_preview(ip->scene)) {
      continue;
    }

This checks if the render engine type has the RE_USE_PREVIEW flag set, which is to indicate whether the engine is able to render previews. This appears entirely irrelevant for the previewing of image icons as the one in the task. The Workbench engine doesn't have the flag set, thus icon_preview_startjob_all_sizes never calls other_id_types_preview_render.

When the workbench engine is used, the `icon_preview_startjob` isn't called, which results in the missing icon. `icon_preview_startjob` should've been called eventually once `icon_preview_startjob_all_sizes` is called (set as callback for window manager job by `ED_preview_icon_job`). Callstack when Eevee is used: ``` icon_preview_startjob(void * customdata, short * stop, short * do_update) Line 1238 C common_preview_startjob(void * customdata, short * stop, short * do_update, float * UNUSED_progress) Line 1343 C other_id_types_preview_render(IconPreview * ip, IconPreviewSize * cur_size, const bool is_deferred, short * stop, short * do_update, float * progress) Line 1396 C icon_preview_startjob_all_sizes(void * customdata, short * stop, short * do_update, float * progress) Line 1456 C do_job_thread(void * job_v) Line 390 C ``` However, it doesn't when the render engine is set to *Workbench* because of the following check in `icon_preview_startjob_all_sizes`: ``` if (!check_engine_supports_preview(ip->scene)) { continue; } ``` This checks if the render engine type has the `RE_USE_PREVIEW` flag set, which is to indicate whether the engine is able to render previews. This appears entirely irrelevant for the previewing of image icons as the one in the task. The Workbench engine doesn't have the flag set, thus `icon_preview_startjob_all_sizes` never calls `other_id_types_preview_render`.

Robert Guetzkow commented

2021-01-28 00:27:48 +01:00

I have to check if I've missed any edge case, but the following seems to do the job:

    if (!check_engine_supports_preview(ip->scene) && !(prv->tag & PRV_TAG_DEFFERED)) {
      continue;
    }

The prv->tag & PRV_TAG_DEFERRED is used to determine whether this preview is to be rendered or an image for which deferred loading is used. If it's the latter it shouldn't run into any unsupported cases in other_id_types_preview_render, common_preview_startjob or icon_preview_startjob.

I have to check if I've missed any edge case, but the following seems to do the job: ``` if (!check_engine_supports_preview(ip->scene) && !(prv->tag & PRV_TAG_DEFFERED)) { continue; } ``` The `prv->tag & PRV_TAG_DEFERRED` is used to determine whether this preview is to be rendered or an image for which deferred loading is used. If it's the latter it shouldn't run into any unsupported cases in `other_id_types_preview_render`, `common_preview_startjob` or `icon_preview_startjob`.

blender-admin commented

2021-01-28 00:34:40 +01:00

This issue was referenced by c0d2b10c59

This issue was referenced by c0d2b10c5947f49b316d39b66fb18ff6ab21a82a

Robert Guetzkow self-assigned this 2021-01-28 00:53:44 +01:00

Julian Eisel commented

2021-01-28 12:23:48 +01:00

Changed status from 'Confirmed' to: 'Resolved'

Julian Eisel closed this issue

2021-01-28 12:23:48 +01:00

Sign in to join this conversation.

No Label

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Setting Workbench as Render Engine blocks loading of icon previews #69001

Change Render Engine to Workbench and use Run Script again (icon does not load).