Lightweight render-related enums (ShaderMode, VisualizationMode) shared across disp3D. More...

#include "../disp3D_global.h"
#include <cstdint>

Include dependency graph for rendertypes.h:

This graph shows which files directly or indirectly include this file:

Enumerations
enum	ShaderMode { Standard , Holographic , Anatomical , Dipole , XRay , ShowNormals }
enum	VisualizationMode { ModeSurface , ModeAnnotation , ModeScientific , ModeSourceEstimate }

Functions
uint32_t	packABGR (uint32_t r, uint32_t g, uint32_t b, uint32_t a=0xFF)

Detailed Description

Lightweight render-related enums (ShaderMode, VisualizationMode) shared across disp3D.

Author: Christoph Dinh chris.nosp@m.toph.nosp@m..dinh.nosp@m.@mne.nosp@m.-cpp..nosp@m.org

Since: 2.0.0

Date: March 2026

Kept QRhi-free and free of heavy Qt includes so it can be pulled in from any disp3D translation unit without forcing a recompile of every shader pipeline when a new render mode is added.

ShaderMode selects between the Standard Phong lighting model, Holographic (translucent fresnel), Anatomical (matte tissue), Dipole (instanced arrow shader), XRay (additive front-faces) and ShowNormals (debug visualisation of vertex normals). VisualizationMode selects how per-vertex colour is computed in the fragment shader: from the base surface tint, from FsAnnotation parcellation, from a scientific (curvature-shaded) palette, or from a source-time-course overlay.

Definition in file rendertypes.h.

Enumeration Type Documentation

◆ ShaderMode

enum ShaderMode

Shader pipeline modes supported by the renderer.

Each mode corresponds to a different GPU shader program and visual style. Values are kept compatible with the original BrainRenderer::ShaderMode enum.

Enumerator
Standard	Default Phong-style shading.
Holographic	Two-sided holographic effect.
Anatomical	Anatomical / curvature-based coloring.
Dipole	Specialized dipole rendering.
XRay	Semi-transparent X-ray effect.
ShowNormals	Visualise surface normals as colour.

Definition at line 60 of file rendertypes.h.

◆ VisualizationMode

enum VisualizationMode

Overlay visualisation modes for brain surfaces.

Controls which vertex-colour channel drives the final appearance. Values are kept compatible with the original BrainSurface::VisualizationMode enum.

Enumerator
ModeSurface	Plain surface colours (curvature-derived).
ModeAnnotation	Atlas / parcellation annotation colours.
ModeScientific	Scientific colourmap (curvature).
ModeSourceEstimate	Source-estimate overlay colours.

Definition at line 77 of file rendertypes.h.

Function Documentation

◆ packABGR()

uint32_t packABGR	(	uint32_t	r,
		uint32_t	g,
		uint32_t	b,
		uint32_t	a = 0xFF )

inline

Pack RGBA colour components into a single ABGR uint32_t suitable for GPU vertex attributes declared as UNormByte4.

Parameters

[in]	r	Red channel (0–255).
[in]	g	Green channel (0–255).
[in]	b	Blue channel (0–255).
[in]	a	Alpha channel (0–255, default 255).

Returns: Packed ABGR colour.

Definition at line 48 of file rendertypes.h.