You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
VTK.js rendering profiles are side-effect imports that register rendering implementations for classes used by the scene graph. They keep applications smaller by letting you import only the rendering backends and mapper support you need.
8
+
9
+
## Why profiles exist
10
+
11
+
Many VTK.js classes are pure pipeline or data-model classes. They only become renderable after a matching rendering profile registers the view-node overrides required by the active backend such as OpenGL or WebGPU.
12
+
13
+
Without the relevant profile import, VTK.js can still construct the data objects, actors, mappers, and pipeline, but rendering may fail when the scene graph asks `ViewNodeFactory` to create a backend-specific implementation for one of those classes.
14
+
15
+
## Typical usage
16
+
17
+
Import a profile near your application entry point before creating the render window content:
If you need broader coverage, import the combined profile:
24
+
25
+
```js
26
+
import'@kitware/vtk.js/Rendering/Profiles/All';
27
+
```
28
+
29
+
## Common profiles
30
+
31
+
-`Geometry`: core polygonal rendering support.
32
+
-`Volume`: image and volume rendering support.
33
+
-`Glyph`: glyph-specific mapper support.
34
+
-`Molecule`: sphere and stick mapper support.
35
+
-`LIC`: line integral convolution rendering support.
36
+
-`All`: imports all supported profiles.
37
+
38
+
## When a profile is missing
39
+
40
+
A missing profile often shows up as an error from `Rendering/SceneGraph/ViewNodeFactory` saying that no implementation was found for a class and that a rendering profile is likely missing.
41
+
42
+
That warning means one of these is true:
43
+
44
+
- A built-in renderable class is being used without importing the profile that registers its rendering implementation.
45
+
- A custom renderable class has not been registered with the view-node factory.
46
+
47
+
If you are unsure which profile is required, importing `Rendering/Profiles/All` is the easiest way to confirm that the issue is profile-related. After that, you can narrow it back down to the smallest profile set your application needs.
0 commit comments