Overlay Next: Refactor #107734

Miguel Pozo · 2023-05-08T12:47:41+02:00

Miguel Pozo commented

2023-05-08 12:47:41 +02:00

Refactor of #107045, replacing templates with construction time booleans.

Additionally:

Use the overlay_next prefix for files.
Splits the cold code paths into header/implementation files.
Replaces the RAII wrappers for GPUShader and GPUBatch with unique_ptr.

Refactor of #107045, replacing templates with construction time booleans. Additionally: - Use the `overlay_next` prefix for files. - Splits the cold code paths into header/implementation files. - Replaces the RAII wrappers for `GPUShader` and `GPUBatch` with `unique_ptr`.

Miguel Pozo added the

Module

EEVEE & Viewport

label 2023-05-08 12:47:41 +02:00

Miguel Pozo added 35 commits 2023-05-08 12:47:56 +02:00

2538c3b1a2 Cleanup: DRW: Improve state_stencil documentation

279774ad0b Overlay-Next: First commit

82e298227f Cleanup: EEVEE-Next: Add precision to comment

482fee9bbe DRW: View: Expose matrices through interface

cd93f790c7 Overlay: Add experimental option to enable overlay-next

f0514484f5 DRW: Wrappers: Add TextureRef to wrap around GPUTexture pointers

This adds the possibility to use the C++ API for other GPUTexture.

64d9660fc4 Overlay-Next: Make Grid parameters work

e116c67c3a DRW: Fix gl error related to incorrect uniform size

c3157ddc44 Merge branch 'master' into overlay-next

c4ecfce6bb Overlay-Next: Port Background overlay

2abc4d0538 Overlay-Next: Port Metaball overlay

968f5748c6 Merge branch 'main' into overlay-next

# Conflicts:
#	release/scripts/startup/bl_ui/space_userpref.py
#	source/blender/makesdna/DNA_userdef_types.h
#	source/blender/makesrna/intern/rna_userdef.c

aff61bf5b4 Merge branch 'main' into overlay-next

cdb9b6a041 Overlay-Next: Add support for empties

Also added a shape cache and move the color selection to `Resources`.

ef0126f3a7 Merge branch 'main' into overlay-next

# Conflicts:
#	source/blender/makesdna/DNA_userdef_types.h

84ff44769f Overlay-Next: Add high level separation of selection code

This makes it possible to reuse the overlay engine code for selection
purpose, but without any overhead for the viewport drawing.

The separation is made clear by having a dummy selection implementation for
viewport drawing and an object implementation for object selection.
Other impementation might come later (like for depth picking).

68a0f9e01c Overlay-Next: Port Metaball code to use latest design and support selectid

78ae27bab3 Overlay-Next: Add depth Prepass basics

The depth prepass is supposed to replace the Basic engine:
- Draw object depth when the engine doesn't give correct depth buffer
- Used for object selection

16cc2446f5 Overlay-Next: Add shader module

This allows cleaner declarations of shaders as well as allowing easier
swapping of the whole shader module for selection & clipping.

This also allow to easier toggle between the old overlay engine and
overlay-next as they don't share the same shaders anymore.

ea66898bbe Select-Next: Introduce shader level patching to output selection ids

This leverage imageLoad/Store operations to remove the use of cumbersome
visibility queries.

Patching shaders should only require 4 lines of code (2 for includes, 2 for
the id passthrough).

953cef7b7a Merge branch 'main' into overlay-next

34afb6c05f Select-Next: Fix IDs for meshes and metaballs handles

a9397b5458 Select-Next: Reorganize and rename stuffs

3ac54f67bf Select-Next: Add result buffer injection

This allow compatibility with the old system.

7676b627c2 Merge branch 'main' into overlay-next

# Conflicts:
#	source/blender/draw/engines/select/select_engine.c
#	source/blender/draw/engines/select/shaders/infos/select_id_info.hh

f25b2156df Fix crash when using old overlay engine before enabling overlay-next

d9fd739732 Fix assert in gpu debug mode

ba29927190 Fix buggy selection

bd56cf7a14 Merge branch 'main' into overlay-next

57e2faba23 Remove use of templates

80a00e0452 cleanup

08d8973863 Use overlay_next prefix

f6f8f47246 refactor

692cc1d7ab Class Layout

cdc931d3ab cleanup

Miguel Pozo added this to the EEVEE & Viewport project 2023-05-08 12:48:24 +02:00

Miguel Pozo requested review from Jeroen Bakker 2023-05-08 12:48:38 +02:00

Miguel Pozo requested review from Clément Foucault 2023-05-08 12:48:48 +02:00

Miguel Pozo added 1 commit 2023-05-08 17:03:40 +02:00

96b8a8cbba Move the hot path back to header files

Revert a 5% performance decrease caused by the hh/cc split.

Clément Foucault requested changes 2023-05-15 17:43:36 +02:00

Clément Foucault left a comment

There is still quite a lot of TODOs in the code. Some are rather low hanging fruits that would improve code quality (like in overlay_next_instance.cc).

But the core of the code is good to go.

Will test it on Metal too.

There is still quite a lot of TODOs in the code. Some are rather low hanging fruits that would improve code quality (like in overlay_next_instance.cc). But the core of the code is good to go. Will test it on Metal too.

source/blender/draw/engines/overlay/overlay_next_background.hh Outdated

						
				@ -0,0 +29,4 @@

				      background_type = BG_SOLID;

				      color_override[3] = 1.0f;

				    }

				    /*

Clément Foucault commented

2023-05-15 11:21:16 +02:00

Why is this commented?

Miguel Pozo commented

2023-05-16 18:11:26 +02:00

I think it's because the space type is not stored anywhere yet.
You probably just forgot to add the TODO.

Just for reference, I haven't looked into most of the code yet.
This is 99% your patch, just without the templates (so you could provide feedback) and some minimal changes.

I think it's because the space type is not stored anywhere yet. You probably just forgot to add the TODO. Just for reference, I haven't looked into most of the code yet. This is 99% your patch, just without the templates (so you could provide feedback) and some minimal changes.

fclem marked this conversation as resolved

source/blender/draw/engines/overlay/overlay_next_private.hh

						
				@ -0,0 +1,267 @@

				/* SPDX-License-Identifier: GPL-2.0-or-later

Clément Foucault commented

2023-05-15 17:38:45 +02:00

What is the reasonning on combining all the headers inside this one? The goal of split headers is also to ease code searchability / readability.

Miguel Pozo commented

2023-05-16 18:14:52 +02:00

Initially, when I moved the implementations to their on cc files I moved all declarations to the same header (Workbench Next style).
I personally find it more readable to have all the declarations together, especially if you're looking at the code for the first time.

Then when we moved almost everything back to headers only the shared classes stayed in the private header.

Initially, when I moved the implementations to their on cc files I moved all declarations to the same header (Workbench Next style). I personally find it more readable to have all the declarations together, especially if you're looking at the code for the first time. Then when we moved almost everything back to headers only the shared classes stayed in the private header.

source/blender/draw/engines/select/select_instance.hh Outdated

						
				@ -0,0 +24,4 @@

				namespace blender::draw::select {

				enum class eSelectionType { DISABLED = 0, ENABLED = 1 };

Clément Foucault commented

2023-05-15 13:07:47 +02:00

remove e prefix

remove `e` prefix

Miguel Pozo commented

2023-05-16 18:15:36 +02:00

What's the rule here?
All the enums (at least most of them?) in the code base have the e prefix.

What's the rule here? All the enums (at least most of them?) in the code base have the `e` prefix.

Clément Foucault commented

2023-05-16 19:14:33 +02:00

There was a decision (or discussion, I cannot find it at the moment) not so long ago to not use that prefix as it isn't clear and enums are usually called Types or something else that indicates they are enums.

This hasn't been applied to the whole codebase that's why most of them remains.

There was a decision (or discussion, I cannot find it at the moment) not so long ago to not use that prefix as it isn't clear and enums are usually called `Types` or something else that indicates they are enums. This hasn't been applied to the whole codebase that's why most of them remains.

Miguel Pozo commented

2023-05-17 16:25:42 +02:00

Ok, good to know!

pragma37 marked this conversation as resolved

Clément Foucault reviewed 2023-05-15 18:33:47 +02:00

source/blender/draw/engines/overlay/overlay_next_instance.cc

						
				@ -0,0 +22,4 @@

				  state.depsgraph = ctx->depsgraph;

				  state.view_layer = ctx->view_layer;

				  state.scene = ctx->scene;

				  state.v3d = ctx->v3d;

Clément Foucault commented

2023-05-15 18:33:41 +02:00

The overlay instance can be called for 2D views. This is something that we might want to revisit at some point but that would not be a huge refactor to do. So I would just suggest to check for state.v3d != nullptr and state.rv3d != nullptr for anything that need to access them.

The overlay instance can be called for 2D views. This is something that we might want to revisit at some point but that would not be a huge refactor to do. So I would just suggest to check for `state.v3d != nullptr` and `state.rv3d != nullptr` for anything that need to access them.

pragma37 marked this conversation as resolved

Miguel Pozo added 1 commit 2023-05-17 13:36:33 +02:00

48840725b3 Remove enum prefix

Miguel Pozo added 2 commits 2023-05-17 16:23:50 +02:00

876db91825 Add space_type to State

376ce188f8 v3d null check

Clément Foucault approved these changes 2023-05-22 10:41:31 +02:00

Miguel Pozo referenced this issue from a commit

2023-05-23 15:00:46 +02:00

Overlay-Next: Initial implementation

Miguel Pozo merged commit 9ae2dd577a into main

2023-05-23 15:00:46 +02:00