Skip to content

Commit

Permalink
doc: Engine change related doc
Browse files Browse the repository at this point in the history
  • Loading branch information
mwestphal committed Dec 26, 2024
1 parent 5ca3923 commit 644d34b
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
2 changes: 1 addition & 1 deletion doc/libf3d/LANGUAGE_BINDINGS.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Here is an example showing how to use libf3d python bindings:
```python
import f3d

eng = f3d.Engine(f3d.Window.NATIVE)
eng = f3d.Engine.create(False)
eng.options.update({
"model.scivis.array-name": "Normals",
"model.scivis.component": 0,
Expand Down
8 changes: 4 additions & 4 deletions doc/libf3d/OVERVIEW.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Rendering a file and starting the interaction is very easy:
f3d::engine::autoloadPlugins();

// Create a f3d::engine
f3d::engine eng();
f3d::engine eng = f3d::engine::create();

// Add a file into a scene
eng.getScene().add("path/to/file.ext");
Expand All @@ -39,7 +39,7 @@ As well as loading multiple files:
f3d::engine::autoloadPlugins();

// Create a f3d::engine
f3d::engine eng();
f3d::engine eng = f3d::engine::create();

// Load multiples geometries
eng.getScene().add({"path/to/file.ext", "path/to/file2.ext"});
Expand All @@ -56,7 +56,7 @@ It's also possible to load a geometry from memory buffers:
#include <f3d/scene.h>
// Create a f3d::engine
f3d::engine eng();
f3d::engine eng = f3d::engine::create();
// Create a single triangle
f3d::mesh_t mesh = {};
Expand Down Expand Up @@ -105,7 +105,7 @@ Changing some options can be done this way:
f3d::engine::autoloadPlugins();

// Create a f3d::engine
f3d::engine eng();
f3d::engine eng = f3d::engine::create();

// Recover the options and set the wanted value
options& opt = eng.getOptions();
Expand Down
1 change: 1 addition & 0 deletions doc/libf3d/PLUGINS.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,5 +69,6 @@ F3D provides access to a VTK modules containing utilities that may be useful for
- `vtkF3DFaceVaryingPointDispatcher`: A VTK filter that manipulates point data so that F3D can display them as face-varying data (used by `usd` plugin)
- `vtkF3DBitonicSort`: A VTK class that perform Bitonic Sort algorithm on the GPU (used by the `splat` point sprites rendering algorithm
- `vtkF3DImporter`: An Importer class that abstract away support for different version of VTK after some API changes.
- `vtkF3DGLTFImporter`: An custom glTF importer class that support armatures, usefull when creating other plugin supporting glTF extensions.

Check failure on line 72 in doc/libf3d/PLUGINS.md

View workflow job for this annotation

GitHub Actions / Codespell Check

usefull ==> useful

For the complete documentation, please consult the [vtkext doxygen documentation.](https://f3d.app/doc/libf3d/vtkext_doxygen/).

0 comments on commit 644d34b

Please sign in to comment.