Skip to content

Commit 4954b94

Browse files
committed
update doc
1 parent 075c6b7 commit 4954b94

127 files changed

Lines changed: 12868 additions & 38 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 7 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -20,43 +20,12 @@ The v2-main branch, C# Wrapper is based the open source version of [Orbbec SDK v
2020
| Femto Mega | 1.1.7/1.2.7 |
2121

2222

23-
# Compile and run sample
24-
Here, it is assumed that you have installed Cmake correctly. If you have not installed Cmake, you can refer to the Cmake official website for installation.
25-
- Open Cmake, set the source code path, and set the “build” folder as the path for generating binary files, as shown in the following figure.
26-
27-
- First, click Configure, then select x64 in the dialog box that appears, and finally click Finish.
28-
![compile-1](image/compile-1.png)
29-
30-
- Click “Generate”, as shown below:
31-
![compile-2](image/compile-2.png)
32-
33-
- Use the file explorer to directly start the Visual Studio project in the build directory, as shown in the following figure:
34-
![compile-3](image/compile-3.png)
35-
36-
- Open the project, as shown below, First, select Release, then choose ALL BUILD to compile, and finally select INSTALL.
37-
![compile-4](image/compile-4.png)
38-
39-
- The compiled sample is located in the build/install/bin directory.
40-
![compile-5](image/compile-5.png)
41-
- Click on 0.basic.quick_start.exe, and the running result is as follows:
42-
![compile-6](image/compile-6.png)
43-
44-
# Sample Features
45-
| Example | Description | level |
46-
| --------------------- | ------------------------ |----------------|
47-
| 0.basic.quick_start | Quickly use the camera to capture color and depth video streams.||
48-
| 1.stream.color | Displays the color stream from the camera.||
49-
| 1.stream.depth | Displays the depth stream from the camera.||
50-
| 1.stream.imu | Demonstrates how to read IMU data.||
51-
| 1.stream.infrared | Displays the infrared stream from the camera.||
52-
| 1.stream.multi_streams | Use SDK to obtain multiple camera data streams and output them.||
53-
| 2.device.control | The SDK can be used to modify camera-related parameters, including laser switch, laser level intensity, white balance switch, etc.| ⭐⭐ |
54-
| 2.device.firmware_update | This sample demonstrates how to read a firmware file to perform firmware upgrades on the device.| ⭐⭐ |
55-
| 2.device.hot_plugin | Demonstrates how to detect hot plug events.| ⭐⭐ |
56-
| 3.advanced.coordinate_transform | Use the SDK interface to transform different coordinate systems.| ⭐⭐⭐ |
57-
| 3.advanced.hw_d2c_align | Demonstrates how to use hardware D2C.| ⭐⭐⭐ |
58-
| 3.advanced.multi_devices | Demonstrates how to use multiple devices.| ⭐⭐⭐ |
59-
| 3.advanced.point_cloud | Demonstrates how to save the point cloud to disk using a point cloud filter.| ⭐⭐⭐ |
60-
| 3.advanced.post_processing | Demonstrates how to use post-processing filters.| ⭐⭐⭐ |
23+
# Documentation
24+
25+
For compilation and API reference, please refer to [UserGuide](https://orbbec.github.io/OrbbecSDK_CSharp/index.html) documentation.
26+
27+
# License
28+
This project is licensed under the Apache License 2.0.
29+
6130
6231

docs/.buildinfo

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 45773a445e0cde04ee9f0497f3595d1a
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/.nojekyll

Whitespace-only changes.

docs/README.html

Lines changed: 264 additions & 0 deletions
Large diffs are not rendered by default.

docs/_images/compile-1.png

990 KB
Loading

docs/_images/compile-10.png

335 KB
Loading

docs/_images/compile-11.png

24.4 KB
Loading

docs/_images/compile-2.png

1.02 MB
Loading

docs/_images/compile-3.png

849 KB
Loading

docs/_images/compile-4.png

1000 KB
Loading

0 commit comments

Comments
 (0)