storytold/k4a-sys-temp
2
0
Fork 0
mirror of https://github.com/storytold/k4a-sys-temp.git synced 2026-10-25 08:19:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Readme and add changelog.

Browse Source
This commit is contained in:
Amédée d'Aboville
2020-02-20 15:24:55 -05:00
parent 347a89b1d3
commit b6105ed47b
2 changed files with 29 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CHANGELOG.md
+19
View File
@@ -0,0 +1,19 @@
# Changelog
All notable changes to this project will be documented in this file.
## [0.2.1] - 2020-02-20
### Removed
- Vendored `.so`s as they are actually not used in the build.
## [0.2.0] - 2020-02-05
### Added
- Initial linux bindings to `libk4a` version 1.3.
## [0.1.0] - 2020-02-05
### Added
- Initial windows bindings to `libk4a` version 1.3.
README.md
+10 -11
View File
@@ -1,12 +1,17 @@
k4a-sys k4a-sys
------- -------
A bingden wrapper for the Azure Kinect Sensor SDK, which works on both Linux and Windows. A bingden wrapper for the Azure Kinect Sensor SDK, which should work on both Linux and Windows.
Vendors the compiled SDK libs from version 1.3. Vendors the compiled SDK libs from version 1.3.
At the moment I have compiled the sdk on both Linux and Windows On linux you need to install `libk4a1.3` to be able to use `libk4a.so` and `libdepthengine.so`.
and added the `include`s and dynamic libraries by hand to the
`vendor` folder. It might be possible to compile libk4a from source in the future, On windows you need to install the Sensor SDK to able to have the `libdepthengine.dll`.
One future wish is to statically compile the SDK into this library, which would require modifying
the SDK's build to output a static library we could link against.
It also might be possible to compile libk4a from source in the future,
but it looks time consuming. but it looks time consuming.
Examples Examples
@@ -20,13 +25,7 @@ cargo run --example streaming
Future plans Future plans
------ ------
This is temporarily missing the `depthengine` library, my plan is to statically compile this into the lib soon. I've started also planning on writing a safe Rust wrapper library, `k4a-rs` to allow Rust-idiomatic (not raw pointers!)
Raise an issue if you'd like dynamic linking, but since `k4a` is such
a niche library, I think it's very convenient to have it statically compiled
for now.
I'm also planning on writing a safe Rust wrapper library, `k4a-rs` to allow Rust-idiomatic (not raw pointers!)
access to the libraries. It will probably live in this repo and we'll move `k4a-sys` to a sub-directory here, the access to the libraries. It will probably live in this repo and we'll move `k4a-sys` to a sub-directory here, the
same way [`bzip2-rs` and `bzip2-sys`](https://github.com/alexcrichton/bzip2-rs) work. same way [`bzip2-rs` and `bzip2-sys`](https://github.com/alexcrichton/bzip2-rs) work.