Details

Reviewers

Clément Foucault (fclem)
Brecht Van Lommel (brecht)
Michael Parkin-White (MichaelPW)

Maniphest Tasks

T101905: Blender: Add command line argument to switch gpu backends

Commits

rB3655eb7ff0e8: Blender: Add command line argument to switch gpu backends.

Summary

Add command line argument to switch gpu backend. Add --gpu-backend option to
override the gpu backend selected by Blender.

Values for this option that will be available in releases for now are:

opengl: Force blender to select OpenGL backend.

During development and depending on compile options additional values can exist:

metal: Force Blender to select Metal backend.

--help text is dynamic based on the active compile options.

When this option isn't provided the internal logic for GPU backend selection will be used.
Note that this is at the time of writing the same as always selecting the opengl backend.

Diff Detail

Repository: rB Blender

Event Timeline

Jeroen Bakker (jbakker) created this revision.Oct 19 2022, 10:29 AM

Harbormaster completed remote builds in B24330: Diff 56946.Oct 19 2022, 10:29 AM

Jeroen Bakker (jbakker) added a reviewer: Clément Foucault (fclem).Oct 19 2022, 10:31 AM

Jeroen Bakker (jbakker) added a project: EEVEE & Viewport.

Add support for animation playback.

On mac with WITH_METAL_BACKEND=On it creates the correct context + gpu backend. It fails compiling some shaders. There is a patch that could be applied to master that should fix outstanding shader compilation errors.

Harbormaster completed remote builds in B24331: Diff 56948.Oct 19 2022, 10:43 AM

Jeroen Bakker (jbakker) edited the summary of this revision. (Show Details)Oct 19 2022, 10:46 AM

https://builder.blender.org/admin/#/builders/136/builds/167 started to check if GHOST changes compiles on all platforms.

source/blender/gpu/GPU_context.h
24	selection is a wrong name. GPU_backend_default_type_get/set?
26	Should we rename this to `GPU_backend_active_type_get`

Jeroen Bakker (jbakker) added a reviewer: Brecht Van Lommel (brecht).Oct 19 2022, 10:55 AM

Jeroen Bakker (jbakker) edited the summary of this revision. (Show Details)

Jeroen Bakker (jbakker) added a task: T101905: Blender: Add command line argument to switch gpu backends.

Jeroen Bakker (jbakker) edited the summary of this revision. (Show Details)Oct 19 2022, 11:59 AM

Jeroen Bakker (jbakker) edited the summary of this revision. (Show Details)

Jeroen Bakker (jbakker) edited the summary of this revision. (Show Details)Oct 19 2022, 12:49 PM

Combined glSettings and type in ghost.
Add support for animation playback.
Fix compilation errors on linux.
Fix compilation errors windows.
Fix compilation errors SDL.
Merge branch 'master' into temp-T101905-gpu-backend-argument
Shader builder process all available backends.

Harbormaster completed remote builds in B24334: Diff 56953.Oct 19 2022, 1:19 PM

Jeroen Bakker (jbakker) requested review of this revision.Oct 19 2022, 1:20 PM

Kazashi Yoshioka (AgAmemnno) added a subscriber: Kazashi Yoshioka (AgAmemnno).Oct 19 2022, 1:23 PM

Jeroen Bakker (jbakker) added a reviewer: Michael Parkin-White (MichaelPW).Oct 19 2022, 1:54 PM

LGTM

In D16297#443770, @Jeroen Bakker (jbakker) wrote:

Add support for animation playback.

On mac with WITH_METAL_BACKEND=On it creates the correct context + gpu backend. It fails compiling some shaders. There is a patch that could be applied to master that should fix outstanding shader compilation errors.

That's great to hear, thanks! I also have several follow-up patches to clean up certain paths for Metal as functionality is still not at 100%, including the currently in-review patch for porting EEVEE to use Shader Create Info's.

Edit: For reference, device requirements for Metal Viewport enablement. All recent devices will cover this, though there may be a number of edge cases for older devices.

Metal 2.2 support
macOS 10.15 and onwards
Argument Buffers Tier 2 support (Most GPUs supporting Metal will have this)
Support for shader barycentric

source/blender/gpu/intern/gpu_shader_builder.cc
97	Metal availability on certain devices is dependent on certain available API features, which are not available on all devices which do support Metal. While the WITH_METAL_BACKEND CMake flag should guard against OS availability, this only applies to the build platform rather than the device that Blender is running on. As a result, while I'm not sure how best to factor this into the code, it would be useful to ensure that areas in the code do not attempt to initialise a Metal device if the device fails compatibility as defined in: `GPU_backend_supported()`. The `GPU_backend_supported()` could also likely be refactored to take the backend type as a parameter, rather than reading the global for these cases. There may also be other places in the code that it makes sense to guard.
source/creator/creator_args.c
1144	As per other comment, this one may be less relevant but as Metal device initialisation may fail on certain configs, due to feature availability, then it could be good to call `GPU_backend_supported()` and if this fails, fall back to the default GPU backend. Though this may not be relevant for an explicit launch flag, as it may be preferable just to let the app silently fail if Metal is not available, to avoid any confusion. At the point where there is a selection in the app's interface, then I imagine falling back to the supported API would be idea.

Add supported backend check to shader builder.
Report error when choosing incorrect GPU backend.

Harbormaster completed remote builds in B24336: Diff 56955.Oct 19 2022, 2:47 PM

Brecht Van Lommel (brecht) accepted this revision.Oct 19 2022, 3:09 PM

This revision is now accepted and ready to land.Oct 19 2022, 3:09 PM

In D16297#443834, @Jeroen Bakker (jbakker) wrote:

Add supported backend check to shader builder.

Report error when choosing incorrect GPU backend.

Looks good :)

Closed by commit rB3655eb7ff0e8: Blender: Add command line argument to switch gpu backends. (authored by Jeroen Bakker (jbakker)). · Explain WhyOct 19 2022, 3:14 PM

This revision was automatically updated to reflect the committed changes.

Jeroen Bakker (jbakker) marked an inline comment as done.

Jeroen Bakker (jbakker) added a commit: rB3655eb7ff0e8: Blender: Add command line argument to switch gpu backends..

Erik Sanabria (ersb2194) added a subscriber: Erik Sanabria (ersb2194).Dec 5 2022, 6:27 PM

Blender: Add command line argument to switch gpu backends.
ClosedPublic
Actions

Details

Diff Detail

Event Timeline

Revision Contents
Changeset List

Diff 56957

intern/ghost/GHOST_C-api.h

intern/ghost/GHOST_ISystem.h

intern/ghost/GHOST_Types.h

intern/ghost/intern/GHOST_C-api.cpp

intern/ghost/intern/GHOST_ContextCGL.h

intern/ghost/intern/GHOST_ContextCGL.mm

intern/ghost/intern/GHOST_System.cpp

intern/ghost/intern/GHOST_SystemCocoa.h

intern/ghost/intern/GHOST_SystemCocoa.mm

intern/ghost/intern/GHOST_SystemHeadless.h

intern/ghost/intern/GHOST_SystemSDL.h

intern/ghost/intern/GHOST_SystemSDL.cpp

intern/ghost/intern/GHOST_SystemWayland.h

intern/ghost/intern/GHOST_SystemWayland.cpp

intern/ghost/intern/GHOST_SystemWin32.h

intern/ghost/intern/GHOST_SystemWin32.cpp

intern/ghost/intern/GHOST_SystemX11.h

intern/ghost/intern/GHOST_SystemX11.cpp

intern/ghost/intern/GHOST_WindowCocoa.mm

intern/ghost/test/gears/GHOST_Test.cpp

source/blender/gpu/GPU_context.h

source/blender/gpu/intern/gpu_context.cc

source/blender/gpu/intern/gpu_shader_builder.cc

source/blender/gpu/intern/gpu_shader_builder_stubs.cc

source/blender/windowmanager/intern/wm_playanim.c

source/blender/windowmanager/intern/wm_window.c

source/blender/windowmanager/intern/wm_window_private.h

source/creator/creator_args.c

Blender: Add command line argument to switch gpu backends.ClosedPublicActions

Details

Diff Detail

Event Timeline

Revision ContentsChangeset List

Diff 56957

intern/ghost/GHOST_C-api.h

intern/ghost/GHOST_ISystem.h

intern/ghost/GHOST_Types.h

intern/ghost/intern/GHOST_C-api.cpp

intern/ghost/intern/GHOST_ContextCGL.h

intern/ghost/intern/GHOST_ContextCGL.mm

intern/ghost/intern/GHOST_System.cpp

intern/ghost/intern/GHOST_SystemCocoa.h

intern/ghost/intern/GHOST_SystemCocoa.mm

intern/ghost/intern/GHOST_SystemHeadless.h

intern/ghost/intern/GHOST_SystemSDL.h

intern/ghost/intern/GHOST_SystemSDL.cpp

intern/ghost/intern/GHOST_SystemWayland.h

intern/ghost/intern/GHOST_SystemWayland.cpp

intern/ghost/intern/GHOST_SystemWin32.h

intern/ghost/intern/GHOST_SystemWin32.cpp

intern/ghost/intern/GHOST_SystemX11.h

intern/ghost/intern/GHOST_SystemX11.cpp

intern/ghost/intern/GHOST_WindowCocoa.mm

intern/ghost/test/gears/GHOST_Test.cpp

source/blender/gpu/GPU_context.h

source/blender/gpu/intern/gpu_context.cc

source/blender/gpu/intern/gpu_shader_builder.cc

source/blender/gpu/intern/gpu_shader_builder_stubs.cc

source/blender/windowmanager/intern/wm_playanim.c

source/blender/windowmanager/intern/wm_window.c

source/blender/windowmanager/intern/wm_window_private.h

source/creator/creator_args.c

Blender: Add command line argument to switch gpu backends.
ClosedPublic
Actions

Revision Contents
Changeset List