Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Engine related doc changes #1838

Merged
merged 2 commits into from
Dec 27, 2024
Merged

Engine related doc changes #1838

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aad7fe7
doc: Engine change related doc
mwestphal Dec 26, 2024
c0e31d7
Update doc/libf3d/PLUGINS.md
mwestphal Dec 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/libf3d/LANGUAGE_BINDINGS.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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, useful when creating other plugin supporting glTF extensions.

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