Skip to content

Commit c750456

Browse files
committed
docs(readme): include C variants for desktop examples and clarify C demo usage
1 parent 79abbec commit c750456

2 files changed

Lines changed: 25 additions & 12 deletions

File tree

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,7 @@ int main() {
140140
```
141141
142142
Available error codes include:
143+
143144
- `ErrorCode::NoDeviceFound` - No camera device found
144145
- `ErrorCode::InvalidDevice` - Invalid device name or index
145146
- `ErrorCode::DeviceOpenFailed` - Camera open failed
@@ -226,12 +227,11 @@ int main() {
226227
227228
| Example | Description | Language | Platform |
228229
|---------|-------------|----------|----------|
229-
| [0-print_camera](./examples/desktop/0-print_camera.cpp) | List available cameras | C++ | Desktop |
230-
| [0-print_camera_c](./examples/desktop/0-print_camera_c.c) | List available cameras | C | Desktop |
231-
| [1-minimal_example](./examples/desktop/1-minimal_example.cpp) | Basic frame capture | C++ | Desktop |
232-
| [2-capture_grab](./examples/desktop/2-capture_grab.cpp) | Continuous capture | C++ | Desktop |
233-
| [3-capture_callback](./examples/desktop/3-capture_callback.cpp) | Callback-based capture | C++ | Desktop |
234-
| [4-example_with_glfw](./examples/desktop/4-example_with_glfw.cpp) | OpenGL rendering | C++ | Desktop |
230+
| [0-print_camera](./examples/desktop/0-print_camera.cpp) / [0-print_camera_c](./examples/desktop/0-print_camera_c.c) | List available cameras | C++ / C | Desktop |
231+
| [1-minimal_example](./examples/desktop/1-minimal_example.cpp) / [1-minimal_example_c](./examples/desktop/1-minimal_example_c.c) | Basic frame capture | C++ / C | Desktop |
232+
| [2-capture_grab](./examples/desktop/2-capture_grab.cpp) / [2-capture_grab_c](./examples/desktop/2-capture_grab_c.c) | Continuous capture | C++ / C | Desktop |
233+
| [3-capture_callback](./examples/desktop/3-capture_callback.cpp) / [3-capture_callback_c](./examples/desktop/3-capture_callback_c.c) | Callback-based capture | C++ / C | Desktop |
234+
| [4-example_with_glfw](./examples/desktop/4-example_with_glfw.cpp) / [4-example_with_glfw_c](./examples/desktop/4-example_with_glfw_c.c) | OpenGL rendering | C++ / C | Desktop |
235235
| [iOS Demo](./examples/) | iOS application | Objective-C++ | iOS |
236236
237237
### Build and Run Examples
@@ -244,8 +244,14 @@ cmake --build .
244244
# Run examples
245245
./0-print_camera
246246
./1-minimal_example
247+
248+
# Run the pure C variants (if you built C examples)
249+
./0-print_camera_c
250+
./1-minimal_example_c
247251
```
248252
253+
> Note: Each desktop example is available in both C++ (.cpp) and pure C (.c) variants. Use the filenames with a trailing `_c` (e.g. `1-minimal_example_c.c`) for the C versions.
254+
249255
## API Reference
250256
251257
ccap provides both complete C++ and pure C interfaces to meet different project requirements.

README.zh-CN.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -190,12 +190,11 @@ int main() {
190190
191191
| 示例 | 描述 | 语言 | 平台 |
192192
|------|------|------|------|
193-
| [0-print_camera](./examples/desktop/0-print_camera.cpp) | 列出可用相机 | C++ | 桌面端 |
194-
| [0-print_camera_c](./examples/desktop/0-print_camera_c.c) | 列出可用相机 | C | 桌面端 |
195-
| [1-minimal_example](./examples/desktop/1-minimal_example.cpp) | 基本帧捕获 | C++ | 桌面端 |
196-
| [2-capture_grab](./examples/desktop/2-capture_grab.cpp) | 连续捕获 | C++ | 桌面端 |
197-
| [3-capture_callback](./examples/desktop/3-capture_callback.cpp) | 回调式捕获 | C++ | 桌面端 |
198-
| [4-example_with_glfw](./examples/desktop/4-example_with_glfw.cpp) | OpenGL 渲染 | C++ | 桌面端 |
193+
| [0-print_camera](./examples/desktop/0-print_camera.cpp) / [0-print_camera_c](./examples/desktop/0-print_camera_c.c) | 列出可用相机 | C++ / C | 桌面端 |
194+
| [1-minimal_example](./examples/desktop/1-minimal_example.cpp) / [1-minimal_example_c](./examples/desktop/1-minimal_example_c.c) | 基本帧捕获 | C++ / C | 桌面端 |
195+
| [2-capture_grab](./examples/desktop/2-capture_grab.cpp) / [2-capture_grab_c](./examples/desktop/2-capture_grab_c.c) | 连续捕获 | C++ / C | 桌面端 |
196+
| [3-capture_callback](./examples/desktop/3-capture_callback.cpp) / [3-capture_callback_c](./examples/desktop/3-capture_callback_c.c) | 回调式捕获 | C++ / C | 桌面端 |
197+
| [4-example_with_glfw](./examples/desktop/4-example_with_glfw.cpp) / [4-example_with_glfw_c](./examples/desktop/4-example_with_glfw_c.c) | OpenGL 渲染 | C++ / C | 桌面端 |
199198
| [iOS Demo](./examples/) | iOS 应用程序 | Objective-C++ | iOS |
200199
201200
### 构建和运行示例
@@ -210,6 +209,14 @@ cmake --build .
210209
./1-minimal_example
211210
```
212211
212+
```bash
213+
# 运行纯 C 版本(如果你启用了 C 示例构建)
214+
./0-print_camera_c
215+
./1-minimal_example_c
216+
```
217+
218+
> 说明:每个桌面示例均包含 C++ (.cpp) 和纯 C (.c) 两个版本。C 语言版本对应的文件名带有 `_c` 后缀(例如 `1-minimal_example_c.c`)。
219+
213220
## API 参考
214221
215222
ccap 提供完整的 C++ 和纯 C 语言接口,满足不同项目的需求。

0 commit comments

Comments
 (0)