Skip to content

Commit d06c30e

Browse files
committed
Update README
1 parent a9be700 commit d06c30e

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# NetLibDirectshowCapture
2-
A .NET Wrapper of [libdshowcapture](https://github.com/obsproject/libdshowcapture) using .NET 8.0 C++/CLI
2+
[![Build](https://github.com/charlescao460/NetLibDirectshowCapture/actions/workflows/msbuild.yml/badge.svg)](https://github.com/charlescao460/NetLibDirectshowCapture/actions/workflows/msbuild.yml)
3+
[![NuGet](https://img.shields.io/nuget/v/NetLibDirectshowCapture
4+
)](https://www.nuget.org/packages/NetLibDirectshowCapture)
35

4-
This is a direct wrapper, so almost all behaviors should be consistent with [libdshowcapture](https://github.com/obsproject/libdshowcapture).
6+
A .NET Wrapper of [libdshowcapture](https://github.com/obsproject/libdshowcapture) using .NET 8.0 C++/CLI
57

6-
# Git Submodules
7-
Since this repo contains [libdshowcapture](https://github.com/obsproject/libdshowcapture) as its submodule, please use `--recurse-submodules` flag when cloning.
8+
This is a direct wrapper, so almost all behaviors should be consistent with [libdshowcapture](https://github.com/obsproject/libdshowcapture). And it should be compatible with all the devices that [OBS Studio](https://obsproject.com/) supports.
89

9-
```bash
10-
git clone --recurse-submodules git@github.com:charlescao460/NetLibDirectshowCapture.git
11-
```
10+
# Performance
11+
This library is written in C++/CLI (aka. C++ Interop), which has better performance according to [Microsoft](https://learn.microsoft.com/en-us/cpp/dotnet/performance-considerations-for-interop-cpp). All the marshaling details are manually controlled for optimized performance and latency. The callback exposed the native pointer directly, which eliminate all of the unnecessary copies. It should has lower latency compared to other camera library using explicit P/Invoke.
1212

1313
# Usage Example
1414
```C#
@@ -46,3 +46,10 @@ device.VideoConfiguration = videoConfig;
4646
device.ConnectFilters();
4747
device.Start();
4848
```
49+
50+
# Git Submodules
51+
Since this repo contains [libdshowcapture](https://github.com/obsproject/libdshowcapture) as its submodule, please use `--recurse-submodules` flag when cloning.
52+
53+
```bash
54+
git clone --recurse-submodules git@github.com:charlescao460/NetLibDirectshowCapture.git
55+
```

0 commit comments

Comments
 (0)