From 87d8f7208344d8c66c3bad794325e5d458359c27 Mon Sep 17 00:00:00 2001 From: Mar Balibrea Rull Date: Mon, 25 Sep 2023 18:54:28 +0200 Subject: [PATCH 1/3] Fix subpage order (#216) --- docs/release-notes/4.0.md | 3 ++- docs/release-notes/4.0_beta1.md | 20 +++++++++++++------- docs/release-notes/4.1.md | 3 ++- docs/release-notes/4.2.md | 3 ++- docs/release-notes/4.3.md | 3 ++- docs/release-notes/4.4.md | 3 ++- docs/release-notes/4.5.md | 3 ++- docs/release-notes/4.6.md | 3 ++- docs/release-notes/4.7.md | 3 ++- docs/release-notes/4.8.md | 3 ++- docs/release-notes/4.9.md | 3 ++- docs/release-notes/index.md | 2 +- 12 files changed, 34 insertions(+), 18 deletions(-) diff --git a/docs/release-notes/4.0.md b/docs/release-notes/4.0.md index 3046c951..76352a6f 100644 --- a/docs/release-notes/4.0.md +++ b/docs/release-notes/4.0.md @@ -1,7 +1,8 @@ --- layout: page parent: Release notes -title: 4.0 +title: "4.0" +nav_order: 2 --- # ACAP version 4.0 – September 27, 2021 diff --git a/docs/release-notes/4.0_beta1.md b/docs/release-notes/4.0_beta1.md index 98e05e1e..10d7db51 100644 --- a/docs/release-notes/4.0_beta1.md +++ b/docs/release-notes/4.0_beta1.md @@ -1,8 +1,8 @@ --- layout: page parent: Release notes -title: 4.0_beta1 -nav_order: 4.0 beta1 +title: "4.0_beta1" +nav_order: 1 --- # ACAP version 4 Beta 1 – July 13 2021 @@ -11,11 +11,17 @@ nav_order: 4.0 beta1 This is the first ACAP version 4 beta release (limited availability). It contains: -- [ACAP Computer Vision SDK 1.0 beta1](#acap-computer-vision-sdk) -- [ACAP Native SDK 1.0 beta1](#acap-native-sdk) -- [First version of Docker Compose ACAP](#docker-compose-acap) -- First version of new documentation format -- [Code examples](https://github.com/AxisCommunications/acap-application-examples) for the ACAP Computer Vision SDK +- [Overview](#overview) +- [ACAP Computer Vision SDK](#acap-computer-vision-sdk) + - [Compatibility](#compatibility) + - [Firmware](#firmware) + - [Limitations](#limitations) +- [ACAP Native SDK](#acap-native-sdk) + - [Compatibility](#compatibility-1) + - [Firmware](#firmware-1) + - [APIs supported in this release](#apis-supported-in-this-release) +- [New tools](#new-tools) + - [Docker Compose ACAP](#docker-compose-acap) ## ACAP Computer Vision SDK diff --git a/docs/release-notes/4.1.md b/docs/release-notes/4.1.md index 24b028b1..ef540d56 100644 --- a/docs/release-notes/4.1.md +++ b/docs/release-notes/4.1.md @@ -1,7 +1,8 @@ --- layout: page parent: Release notes -title: 4.1 +title: "4.1" +nav_order: 3 --- # ACAP version 4.1 – January 13, 2022 diff --git a/docs/release-notes/4.2.md b/docs/release-notes/4.2.md index c97ab472..e951f7d1 100644 --- a/docs/release-notes/4.2.md +++ b/docs/release-notes/4.2.md @@ -1,7 +1,8 @@ --- layout: page parent: Release notes -title: 4.2 +title: "4.2" +nav_order: 4 --- # ACAP version 4.2 – May 4, 2022 diff --git a/docs/release-notes/4.3.md b/docs/release-notes/4.3.md index aa6e0ecb..088e9f16 100644 --- a/docs/release-notes/4.3.md +++ b/docs/release-notes/4.3.md @@ -1,7 +1,8 @@ --- layout: page parent: Release notes -title: 4.3 +title: "4.3" +nav_order: 5 --- # ACAP version 4.3 – August 31, 2022 diff --git a/docs/release-notes/4.4.md b/docs/release-notes/4.4.md index 2c8eef6e..4840eb8e 100644 --- a/docs/release-notes/4.4.md +++ b/docs/release-notes/4.4.md @@ -1,7 +1,8 @@ --- layout: page parent: Release notes -title: 4.4 +title: "4.4" +nav_order: 6 --- # ACAP version 4.4 – October 12, 2022 diff --git a/docs/release-notes/4.5.md b/docs/release-notes/4.5.md index 9e8541cf..84f358a1 100644 --- a/docs/release-notes/4.5.md +++ b/docs/release-notes/4.5.md @@ -1,7 +1,8 @@ --- layout: page parent: Release notes -title: 4.5 +title: "4.5" +nav_order: 7 --- # ACAP version 4.5 – November 14, 2022 diff --git a/docs/release-notes/4.6.md b/docs/release-notes/4.6.md index 7ad07882..3b0cd4bc 100644 --- a/docs/release-notes/4.6.md +++ b/docs/release-notes/4.6.md @@ -1,7 +1,8 @@ --- layout: page parent: Release notes -title: 4.6 +title: "4.6" +nav_order: 8 --- # ACAP version 4.6 – January 13, 2023 diff --git a/docs/release-notes/4.7.md b/docs/release-notes/4.7.md index db24725f..e4a885aa 100644 --- a/docs/release-notes/4.7.md +++ b/docs/release-notes/4.7.md @@ -1,7 +1,8 @@ --- layout: page parent: Release notes -title: 4.7 +title: "4.7" +nav_order: 9 --- # ACAP version 4.7 – February 28, 2023 diff --git a/docs/release-notes/4.8.md b/docs/release-notes/4.8.md index 96589b8b..9b53cad4 100644 --- a/docs/release-notes/4.8.md +++ b/docs/release-notes/4.8.md @@ -1,7 +1,8 @@ --- layout: page parent: Release notes -title: 4.8 +title: "4.8" +nav_order: 10 --- # ACAP version 4.8 – April 24, 2023 diff --git a/docs/release-notes/4.9.md b/docs/release-notes/4.9.md index 9d6b1e56..49aef528 100644 --- a/docs/release-notes/4.9.md +++ b/docs/release-notes/4.9.md @@ -1,7 +1,8 @@ --- layout: page parent: Release notes -title: 4.9 +title: "4.9" +nav_order: 11 --- # ACAP version 4.9 – June 26, 2023 diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md index 00466b55..e83ec81d 100644 --- a/docs/release-notes/index.md +++ b/docs/release-notes/index.md @@ -3,7 +3,7 @@ layout: default title: Release notes has_children: true nav_order: 12 -child_nav_order: desc +child_nav_order: reversed --- # Release notes From de13ec3d83c0a5e2143c1f121c56176dc5988794 Mon Sep 17 00:00:00 2001 From: Mar Balibrea Rull Date: Tue, 26 Sep 2023 09:50:05 +0200 Subject: [PATCH 2/3] Release notes for 4.10 (#213) Co-authored-by: pataxis --- docs/api/computer-vision-sdk-apis.md | 21 ++-- docs/api/native-sdk-api.md | 22 ++-- docs/axis-devices-and-compatibility/index.md | 9 ++ docs/release-notes/4.10.md | 102 +++++++++++++++++++ 4 files changed, 134 insertions(+), 20 deletions(-) create mode 100644 docs/release-notes/4.10.md diff --git a/docs/api/computer-vision-sdk-apis.md b/docs/api/computer-vision-sdk-apis.md index b54be690..614b41a5 100644 --- a/docs/api/computer-vision-sdk-apis.md +++ b/docs/api/computer-vision-sdk-apis.md @@ -19,16 +19,17 @@ The table below shows ACAP Computer Vision SDK and firmware version compatibilit SDK version | Available from firmware version ----------- | ------------------------------- -1.0 | 10.7 -1.1 | 10.9 -1.2 | 10.10 -1.3 | 10.12 -1.4 | 11.0 -1.5 | 11.1 -1.6 | 11.2 -1.7 | 11.3 -1.8 | 11.4 -1.9 | 11.5 +1.0 | 10.7 +1.1 | 10.9 +1.2 | 10.10 +1.3 | 10.12 +1.4 | 11.0 +1.5 | 11.1 +1.6 | 11.2 +1.7 | 11.3 +1.8 | 11.4 +1.9 | 11.5 +1.10 | 11.6 ## SDK index diff --git a/docs/api/native-sdk-api.md b/docs/api/native-sdk-api.md index 0645f093..89d9e1ee 100644 --- a/docs/api/native-sdk-api.md +++ b/docs/api/native-sdk-api.md @@ -24,16 +24,17 @@ The table below shows ACAP Native SDK and firmware version compatibility. SDK version | Available from firmware version ----------- | ------------------------------- -1.0 | 10.7 -1.1 | 10.9 -1.2 | 10.10 -1.3 | 10.12 -1.4 | 11.0 -1.5 | 11.1 -1.6 | 11.2 -1.7 | 11.3 -1.8 | 11.4 -1.9 | 11.5 +1.0 | 10.7 +1.1 | 10.9 +1.2 | 10.10 +1.3 | 10.12 +1.4 | 11.0 +1.5 | 11.1 +1.6 | 11.2 +1.7 | 11.3 +1.8 | 11.4 +1.9 | 11.5 +1.10 | 11.6 ## Video capture API (VDO) @@ -89,6 +90,7 @@ AXIS OS version | VdoStream API version | New functions added 11.3 | 9.32.0 | - 11.4 | 9.41.16 | `vdo_channel_get_ex` 11.5 | 9.59.0 | - +11.6 | 9.78.12 | `vdo_stream_set_gop_length`, `vdo_error_is_resource_limitation` ### Known issues diff --git a/docs/axis-devices-and-compatibility/index.md b/docs/axis-devices-and-compatibility/index.md index f3ee8aa6..25f6c757 100644 --- a/docs/axis-devices-and-compatibility/index.md +++ b/docs/axis-devices-and-compatibility/index.md @@ -52,24 +52,32 @@ Product | Available from | C [M3215-LVE](https://www.axis.com/products/axis-m3215-lve) | 10.12 | ARTPEC-8 | aarch64 [M3216-LVE](https://www.axis.com/products/axis-m3216-lve) | 10.12 | ARTPEC-8 | aarch64 [M4308-PLE](https://www.axis.com/products/axis-m4308-ple) | 10.8 | ARTPEC-7 | armv7hf +[M4317-PLVE](https://www.axis.com/products/axis-m4317-plve), [M4318-PLVE](https://www.axis.com/products/axis-m4318-plve) | 11.5 | ARTPEC-8 | aarch64 +[M4327-P](https://www.axis.com/products/axis-m4327-p), [M4328-P](https://www.axis.com/products/axis-m4328-p) | 11.4 | ARTPEC-8 | aarch64 [P1465-LE](https://www.axis.com/products/axis-p1465-le) | 11.1 | ARTPEC-8 | aarch64 +[P1465-LE-3](https://www.axis.com/products/axis-p1465-le-3) | 11.5 | ARTPEC-8 | aarch64 [P1467-LE](https://www.axis.com/products/axis-p1467-le) | 11.1 | ARTPEC-8 | aarch64 [P1468-LE](https://www.axis.com/products/axis-p1468-le) | 11.1 | ARTPEC-8 | aarch64 +[P1468-XLE](https://www.axis.com/products/axis-p1468-xle) | 11.5 | ARTPEC-8 | aarch64 [P3255-LVE](https://www.axis.com/products/axis-p3255-lve) | 10.5 | ARTPEC-7 | armv7hf [P3265-LV](https://www.axis.com/products/axis-p3265-lv), [P3265-LVE](https://www.axis.com/products/axis-p3265-lve), [P3265-V](https://www.axis.com/products/axis-p3265-v) | 10.10 | ARTPEC-8 | aarch64 +[P3265-LVE-3](https://www.axis.com/products/axis-p3265-lve-3) | 11.5 | ARTPEC-8 | aarch64 [P3267-LV](https://www.axis.com/products/axis-p3267-lv), [P3267-LVE](https://www.axis.com/products/axis-p3267-lve) | 10.11 | ARTPEC-8 | aarch64 [P3268-LV](https://www.axis.com/products/axis-p3268-lv), [P3268-LVE](https://www.axis.com/products/axis-p3268-lve) | 10.11 | ARTPEC-8 | aarch64 +[P3827-PVE](https://www.axis.com/products/axis-p3827-pve) | 11.5 | ARTPEC-8 | aarch64 [Q1615 Mk III](https://www.axis.com/products/axis-q1615-mk-iii), [Q1615-LE Mk III](https://www.axis.com/products/axis-q1615-le-mk-iii) | 10.4 | ARTPEC-7 | armv7hf [Q1656](https://www.axis.com/products/axis-q1656), [Q1656-LE](https://www.axis.com/products/axis-q1656-le) | 10.8 | ARTPEC-8 | aarch64 [Q1656-B](https://www.axis.com/products/axis-q1656-b), [Q1656-BE](https://www.axis.com/products/axis-q1656-be), [Q1656-BLE](https://www.axis.com/products/axis-q1656-ble) | 10.10 | ARTPEC-8 | aarch64 [Q1656-DLE](https://www.axis.com/products/axis-q1656-dle) | 11.2 | ARTPEC-8 | aarch64 [Q1715](https://www.axis.com/products/axis-q1715) | 10.8 | ARTPEC-7 | armv7hf [Q1961-TE](https://www.axis.com/products/axis-q1961-te) | 11.2 | ARTPEC-8 | aarch64 +[Q2101-TE](https://www.axis.com/products/axis-q2101-te) | 11.5 | ARTPEC-8 | aarch64 [Q3536-LVE](https://www.axis.com/products/axis-q3536-lve) | 10.8 | ARTPEC-8 | aarch64 [Q3538-LVE](https://www.axis.com/products/axis-q3538-lve) | 10.8 | ARTPEC-8 | aarch64 [Q3538-SLVE](https://www.axis.com/products/axis-q3538-slve) | 11.1 | ARTPEC-8 | aarch64 [Q3626-VE](https://www.axis.com/products/axis-q3626-ve) | 11.4 | ARTPEC-8 | aarch64 [Q3628-VE](https://www.axis.com/products/axis-q3628-ve) | 11.4 | ARTPEC-8 | aarch64 +[XFQ1656](https://www.axis.com/products/axis-xfq1656) | 11.5 | ARTPEC-8 | aarch64 ### ACAP Native SDK @@ -104,6 +112,7 @@ SDK 4.6 | 11.2 and later SDK 4.7 | 11.3 and later SDK 4.8 | 11.4 and later SDK 4.9 | 11.5 and later +SDK 4.10 | 11.6 and later How do I know if my device supports a specific AXIS OS version? Please check [firmware releases for supported diff --git a/docs/release-notes/4.10.md b/docs/release-notes/4.10.md new file mode 100644 index 00000000..ebca75d1 --- /dev/null +++ b/docs/release-notes/4.10.md @@ -0,0 +1,102 @@ +--- +layout: page +parent: Release notes +title: "4.10" +nav_order: 12 +--- + +# ACAP version 4.10 – September 26, 2023 + +## Overview + +It contains: + +- [ACAP Computer Vision SDK 1.10](#acap-computer-vision-sdk) +- [ACAP Native SDK 1.10](#acap-native-sdk) +- [ACAP Runtime 1.3.1](https://github.com/AxisCommunications/acap-runtime/tree/1.3.1) + ([Release notes](https://github.com/AxisCommunications/acap-runtime/releases/tag/1.3.1)) +- [Docker ACAP 1.4.1](https://github.com/AxisCommunications/docker-acap/tree/1.4.1) + ([Release notes](https://github.com/AxisCommunications/docker-acap/releases/tag/1.4.1)) +- [Docker Compose ACAP 1.3.1](https://github.com/AxisCommunications/docker-compose-acap/tree/1.3.1) + ([Release notes](https://github.com/AxisCommunications/docker-compose-acap/releases/tag/1.3.1)) + +Code examples for both SDKs: + +- [Code examples ACAP Computer Vision SDK v1.10](https://github.com/AxisCommunications/acap-computer-vision-sdk-examples/tree/v1.10) + ([Release notes](https://github.com/AxisCommunications/acap-computer-vision-sdk-examples/releases/tag/v1.10)) +- [Code examples ACAP Native SDK v1.10](https://github.com/AxisCommunications/acap-native-sdk-examples/tree/v1.10) + ([Release notes](https://github.com/AxisCommunications/acap-native-sdk-examples/releases/tag/v1.10)) + +## New features + +- From [AXIS OS 11.5](https://help.axis.com/en-us/axis-os-release-notes#axis-os-11-5), an [interface is added to VAPIX](https://www.axis.com/vapix-library/subjects/t10102231/section/t10036126/display?section=t10036126-t10185050) to control whether an Axis device only accepts root-privileged access for ACAP applications or not, improving the device's security. For more information regarding the reasoning for this change, and its timeline, see the [article on Developer Community](https://www.axis.com/developer-community/news/axis-os-root-acap-signing). +- From [AXIS OS 11.6](https://help.axis.com/en-us/axis-os-release-notes#axis-os-11-6), ACAP applications can acquire VAPIX service account credentials in runtime. With these credentials, the ACAP application can call a local virtual host to make VAPIX requests on the device. Read more in [VAPIX access for ACAP applications - BETA](../develop/VAPIX-access-for-ACAP-applications). + +### Firmware + +- Minimum AXIS OS version: 11.6 + +See [Firmware releases](https://www.axis.com/support/firmware) for all supported products. + +## ACAP Computer Vision SDK + +Supported architectures: + +- armv7hf and aarch64, see [images on Docker Hub](https://hub.docker.com/r/axisecp/acap-computer-vision-sdk) + +### Compatibility + +New supported products: + +- AXIS M4317-PLVE Panoramic Camera, [Product page](https://www.axis.com/products/axis-m4317-plve) +- AXIS M4318-PLVE Panoramic Camera, [Product page](https://www.axis.com/products/axis-m4318-plve) +- AXIS M4327-P Panoramic Camera, [Product page](https://www.axis.com/products/axis-m4327-p) +- AXIS M4328-P Panoramic Camera, [Product page](https://www.axis.com/products/axis-m4328-p) +- AXIS P1465-LE-3 License Plate Verifier Kit, [Product page](https://www.axis.com/products/axis-p1465-le-3) +- AXIS P1468-XLE Explosion-Protected Bullet Camera, [Product page](https://www.axis.com/products/axis-p1468-xle) +- AXIS P3265-LVE-3 License Plate Verifier Kit, [Product page](https://www.axis.com/products/axis-p3265-lve-3) +- AXIS P3827-PVE Panoramic Camera, [Product page](https://www.axis.com/products/axis-p3827-pve) +- AXIS Q2101-TE Thermal Camera, [Product page](https://www.axis.com/products/axis-q2101-te) +- AXIS XFQ1656 Explosion-Protected Camera, [Product page](https://www.axis.com/products/axis-xfq1656) + +See also [compatibility information](../axis-devices-and-compatibility) for the complete list of +supported products and more product information. + +### Fixes + +- The [ACAP Computer Vision SDK examples](https://github.com/AxisCommunications/acap-computer-vision-sdk-examples) are now using Docker Compose V2 since V1 is no longer receiving updates nor is it available in new releases of Docker Desktop. This means that the previous `docker-compose` that required separate installation has been replaced by `docker compose` which is part of the Docker client. + +## ACAP Native SDK + +Supported architectures: + +- armv7hf and aarch64, see [images on Docker Hub](https://hub.docker.com/r/axisecp/acap-native-sdk) + +### Compatibility + +Supported products: + +- All products with chipsets: ARTPEC-8, ARTPEC-7, ARTPEC-6, CV25, i.MX 6SoloX, i.MX 6ULL, S5L and S5. + +See also [compatibility information](../axis-devices-and-compatibility). + +### Updates + +- `acap-build` has now more granular build options to allow different build setups of ACAP +applications. Run `acap-build --help` for more information. The new options are: + - Skipping the build step (`--build no-build`). + - Disabling manifest validation (`--disable-manifest-validation`). + - Disabling package creation (`--disable-package-creation`). + +### APIs supported in this release + +API | Chip +:-- | :-- +Video capture API | ARTPEC-8, ARTPEC-7, ARTPEC-6, CV25, S5L, S5 +Machine learning API | ARTPEC-8, ARTPEC-7, CV25, S5L +Overlay API | ARTPEC-8, ARTPEC-7, ARTPEC-6 +Cairo | ARTPEC-8, ARTPEC-7, ARTPEC-6 +OpenCL | ARTPEC-8, ARTPEC-7 +Event API | ARTPEC-8, ARTPEC-7, ARTPEC-6, CV25, i.MX 6SoloX, i.MX 6ULL, S5L, S5 +License Key API | ARTPEC-8, ARTPEC-7, ARTPEC-6, CV25, i.MX 6SoloX, i.MX 6ULL, S5L, S5 +FastCGI | ARTPEC-8, ARTPEC-7, CV25, i.MX 6SoloX, i.MX 6ULL From 7c6d75b9a92b1ee7a1de380805a46faf206c9d71 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Patrik=20=C3=85kesson?= <66364872+pataxis@users.noreply.github.com> Date: Tue, 26 Sep 2023 10:17:48 +0200 Subject: [PATCH 3/3] Update API VERSION to 4.10 (#214) Co-authored-by: ecosvc-dockerhub Co-authored-by: Mar Balibrea Rull --- .../axoverlay/example/cairo_image/meson.build | 10 + .../api/src/api/axoverlay/example/meson.build | 7 + .../{config.c => config.cpp} | 0 .../example/opengles_objectloader/meson.build | 24 ++ ...jectloader.c => opengles_objectloader.cpp} | 0 .../{render.c => render.cpp} | 0 .../example/opengles_objectloader/shaders.c | 2 +- .../example/opengles_performance/meson.build | 12 + .../opengles_performance.c | 4 +- .../example/opengles_skia/meson.build | 17 ++ .../api/axoverlay/example/palette/meson.build | 10 + .../src/api/axoverlay/html/axoverlay_8h.html | 199 +++++++++++++- .../src/api/axoverlay/html/axoverlay_8h.js | 9 +- .../api/axoverlay/html/axoverlay_8h__incl.dot | 6 +- .../api/axoverlay/html/axoverlay_8h__incl.md5 | 2 +- .../axoverlay/html/axoverlay_8h_source.html | 121 +++++---- .../src/api/axoverlay/html/axoverlaypage.html | 6 +- ...dir_5f95f37867742e27eef5ba25b7140943.html} | 8 +- .../dir_68267d1309a1af8e8297ef4c3efbcdba.js | 4 - .../dir_a6e26b83e1cc01163d742a8b70e154d1.html | 103 ++++++++ docs/api/src/api/axoverlay/html/files.html | 5 +- docs/api/src/api/axoverlay/html/files.js | 2 +- docs/api/src/api/axoverlay/html/globals.html | 21 ++ .../src/api/axoverlay/html/globals_func.html | 18 ++ .../src/api/axoverlay/html/globals_type.html | 3 + docs/api/src/api/axoverlay/html/index.html | 8 +- .../api/src/api/axoverlay/html/navtreedata.js | 3 +- .../src/api/axoverlay/html/navtreeindex0.js | 219 ++++++++-------- docs/api/src/api/axoverlay/html/pages.html | 2 +- .../src/api/axoverlay/html/search/all_0.js | 9 +- .../src/api/axoverlay/html/search/all_3.js | 2 +- .../src/api/axoverlay/html/search/all_4.js | 2 +- .../src/api/axoverlay/html/search/all_5.js | 3 +- .../src/api/axoverlay/html/search/all_6.js | 4 +- .../src/api/axoverlay/html/search/all_7.js | 5 +- .../src/api/axoverlay/html/search/all_8.js | 5 +- .../src/api/axoverlay/html/search/all_9.js | 3 +- .../src/api/axoverlay/html/search/all_a.js | 2 +- .../src/api/axoverlay/html/search/all_b.js | 2 +- .../src/api/axoverlay/html/search/all_c.js | 2 +- .../src/api/axoverlay/html/search/all_d.html | 26 -- .../src/api/axoverlay/html/search/all_d.js | 4 - .../api/axoverlay/html/search/functions_0.js | 8 +- .../src/api/axoverlay/html/search/pages_0.js | 2 +- .../api/axoverlay/html/search/pages_1.html | 26 -- .../src/api/axoverlay/html/search/pages_1.js | 4 - .../api/axoverlay/html/search/searchdata.js | 4 +- .../api/axoverlay/html/search/typedefs_0.js | 3 +- .../html/structaxoverlay__overlay__data.html | 2 +- .../html/structaxoverlay__palette__color.html | 2 +- .../html/structaxoverlay__settings.html | 4 +- .../html/structaxoverlay__stream__data.html | 2 +- docs/api/src/api/larod/html/annotated.html | 2 +- docs/api/src/api/larod/html/classes.html | 2 +- docs/api/src/api/larod/html/deprecated.html | 2 +- .../dir_97aefd0d527b934f1d99a682da8fe6a9.html | 2 +- docs/api/src/api/larod/html/files.html | 2 +- docs/api/src/api/larod/html/functions.html | 2 +- .../src/api/larod/html/functions_vars.html | 2 +- docs/api/src/api/larod/html/globals.html | 2 +- docs/api/src/api/larod/html/globals_defs.html | 2 +- docs/api/src/api/larod/html/globals_enum.html | 2 +- docs/api/src/api/larod/html/globals_eval.html | 2 +- docs/api/src/api/larod/html/globals_func.html | 2 +- docs/api/src/api/larod/html/globals_type.html | 2 +- docs/api/src/api/larod/html/index.html | 2 +- docs/api/src/api/larod/html/larod_8h.html | 2 +- .../src/api/larod/html/larod_8h_source.html | 2 +- ...opt_builder-doc_larod_doc_api-changes.html | 2 +- ...pt_builder-doc_larod_doc_architecture.html | 2 +- ...md__opt_builder-doc_larod_doc_dma-buf.html | 2 +- ..._doc_how-to-setup-larod-to-use-powerd.html | 2 +- ...d_doc_introduction-for-app-developers.html | 2 +- ...pt_builder-doc_larod_doc_larod-client.html | 2 +- ...t_builder-doc_larod_doc_model-formats.html | 2 +- ...pt_builder-doc_larod_doc_nn-inference.html | 4 +- ...t_builder-doc_larod_doc_preprocessing.html | 2 +- ...oc_larod_tools_model-converter_README.html | 2 +- docs/api/src/api/larod/html/pages.html | 2 +- .../src/api/larod/html/structlarodError.html | 2 +- .../api/larod/html/structlarodTensorDims.html | 2 +- .../larod/html/structlarodTensorPitches.html | 2 +- docs/api/src/api/vdostream/html/globals.html | 3 + .../src/api/vdostream/html/globals_eval.html | 3 + .../src/api/vdostream/html/navtreeindex0.js | 2 +- .../src/api/vdostream/html/navtreeindex1.js | 1 + .../src/api/vdostream/html/search/all_1.js | 1 + .../api/vdostream/html/search/enumvalues_0.js | 1 + .../vdostream/html/vdo-channel_8h_source.html | 4 +- .../src/api/vdostream/html/vdo-error_8h.html | 2 +- .../vdostream/html/vdo-error_8h_source.html | 2 +- .../vdostream/html/vdo-frame_8h_source.html | 6 +- .../api/vdostream/html/vdo-map_8h_source.html | 4 +- .../src/api/vdostream/html/vdo-types_8h.html | 2 + .../src/api/vdostream/html/vdo-types_8h.js | 3 +- .../vdostream/html/vdo-types_8h_source.html | 245 +++++++++--------- 96 files changed, 840 insertions(+), 452 deletions(-) create mode 100644 docs/api/src/api/axoverlay/example/cairo_image/meson.build create mode 100644 docs/api/src/api/axoverlay/example/meson.build rename docs/api/src/api/axoverlay/example/opengles_objectloader/{config.c => config.cpp} (100%) create mode 100644 docs/api/src/api/axoverlay/example/opengles_objectloader/meson.build rename docs/api/src/api/axoverlay/example/opengles_objectloader/{opengles_objectloader.c => opengles_objectloader.cpp} (100%) rename docs/api/src/api/axoverlay/example/opengles_objectloader/{render.c => render.cpp} (100%) create mode 100644 docs/api/src/api/axoverlay/example/opengles_performance/meson.build create mode 100644 docs/api/src/api/axoverlay/example/opengles_skia/meson.build create mode 100644 docs/api/src/api/axoverlay/example/palette/meson.build rename docs/api/src/api/axoverlay/html/{dir_68267d1309a1af8e8297ef4c3efbcdba.html => dir_5f95f37867742e27eef5ba25b7140943.html} (90%) delete mode 100644 docs/api/src/api/axoverlay/html/dir_68267d1309a1af8e8297ef4c3efbcdba.js create mode 100644 docs/api/src/api/axoverlay/html/dir_a6e26b83e1cc01163d742a8b70e154d1.html delete mode 100644 docs/api/src/api/axoverlay/html/search/all_d.html delete mode 100644 docs/api/src/api/axoverlay/html/search/all_d.js delete mode 100644 docs/api/src/api/axoverlay/html/search/pages_1.html delete mode 100644 docs/api/src/api/axoverlay/html/search/pages_1.js diff --git a/docs/api/src/api/axoverlay/example/cairo_image/meson.build b/docs/api/src/api/axoverlay/example/cairo_image/meson.build new file mode 100644 index 00000000..5a35c1b0 --- /dev/null +++ b/docs/api/src/api/axoverlay/example/cairo_image/meson.build @@ -0,0 +1,10 @@ +sources = files('axoverlayexample_cairo.c') + +all_cppcheck_sources += sources + +install_data(sources, install_dir: axo1_example_source_install_dir) + +executable('axo1_cairo', + sources, + install: true, + dependencies: [axo1_dep, glib_dep, cairo_dep]) diff --git a/docs/api/src/api/axoverlay/example/meson.build b/docs/api/src/api/axoverlay/example/meson.build new file mode 100644 index 00000000..72e59160 --- /dev/null +++ b/docs/api/src/api/axoverlay/example/meson.build @@ -0,0 +1,7 @@ +axo1_example_source_install_dir = doc_install_dir / 'example/v1' + +subdir('cairo_image') +subdir('opengles_objectloader') +subdir('opengles_skia') +subdir('opengles_performance') +subdir('palette') diff --git a/docs/api/src/api/axoverlay/example/opengles_objectloader/config.c b/docs/api/src/api/axoverlay/example/opengles_objectloader/config.cpp similarity index 100% rename from docs/api/src/api/axoverlay/example/opengles_objectloader/config.c rename to docs/api/src/api/axoverlay/example/opengles_objectloader/config.cpp diff --git a/docs/api/src/api/axoverlay/example/opengles_objectloader/meson.build b/docs/api/src/api/axoverlay/example/opengles_objectloader/meson.build new file mode 100644 index 00000000..bd5a1240 --- /dev/null +++ b/docs/api/src/api/axoverlay/example/opengles_objectloader/meson.build @@ -0,0 +1,24 @@ +sources = files( + 'config.cpp', + 'gl_example_errors.c', + 'loaders.cpp', + 'mesh.cpp', + 'opengles_objectloader.cpp', + 'render.cpp', + 'shaders.c', +) + +# FIXME opengles_objectloader example is not clean in cppcheck +#all_cppcheck_sources += sources + +install_data(sources, install_dir: axo1_example_source_install_dir) + +if get_option('opengl') + cxx.has_header('tiny_obj_loader.h', required: true) + cxx.has_header('stb_image.h', required: true) + + executable('axo1_opengles_objectloader', + sources, + install: true, + dependencies: [axo1_dep, glib_dep, glesv2_dep, egl_dep]) +endif diff --git a/docs/api/src/api/axoverlay/example/opengles_objectloader/opengles_objectloader.c b/docs/api/src/api/axoverlay/example/opengles_objectloader/opengles_objectloader.cpp similarity index 100% rename from docs/api/src/api/axoverlay/example/opengles_objectloader/opengles_objectloader.c rename to docs/api/src/api/axoverlay/example/opengles_objectloader/opengles_objectloader.cpp diff --git a/docs/api/src/api/axoverlay/example/opengles_objectloader/render.c b/docs/api/src/api/axoverlay/example/opengles_objectloader/render.cpp similarity index 100% rename from docs/api/src/api/axoverlay/example/opengles_objectloader/render.c rename to docs/api/src/api/axoverlay/example/opengles_objectloader/render.cpp diff --git a/docs/api/src/api/axoverlay/example/opengles_objectloader/shaders.c b/docs/api/src/api/axoverlay/example/opengles_objectloader/shaders.c index 95301c82..ff4fdbf3 100644 --- a/docs/api/src/api/axoverlay/example/opengles_objectloader/shaders.c +++ b/docs/api/src/api/axoverlay/example/opengles_objectloader/shaders.c @@ -4,7 +4,7 @@ #include "shaders.h" -#include "error_handler.h" +#include "../../src/error_handler.h" #include #include diff --git a/docs/api/src/api/axoverlay/example/opengles_performance/meson.build b/docs/api/src/api/axoverlay/example/opengles_performance/meson.build new file mode 100644 index 00000000..d0d71d81 --- /dev/null +++ b/docs/api/src/api/axoverlay/example/opengles_performance/meson.build @@ -0,0 +1,12 @@ +sources = files('opengles_performance.c') + +all_cppcheck_sources += sources + +install_data(sources, install_dir: axo1_example_source_install_dir) + +if get_option('opengl') + executable('axo1_opengles_performance', + sources, + install: true, + dependencies: [axo1_dep, glib_dep, cairo_dep, glesv2_dep]) +endif diff --git a/docs/api/src/api/axoverlay/example/opengles_performance/opengles_performance.c b/docs/api/src/api/axoverlay/example/opengles_performance/opengles_performance.c index 3f5454de..8bb3897a 100644 --- a/docs/api/src/api/axoverlay/example/opengles_performance/opengles_performance.c +++ b/docs/api/src/api/axoverlay/example/opengles_performance/opengles_performance.c @@ -51,7 +51,7 @@ struct program_struct { GLuint fragmentShader; }; -static program_struct* the_program = NULL; +static struct program_struct* the_program = NULL; gboolean render_trigger_redraw(gpointer data) { @@ -292,7 +292,7 @@ main(int argc, char **argv) return 1; } - the_program = (program_struct*)g_malloc0(sizeof(program_struct)); + the_program = (struct program_struct*)g_malloc0(sizeof(*the_program)); init_shaders(); diff --git a/docs/api/src/api/axoverlay/example/opengles_skia/meson.build b/docs/api/src/api/axoverlay/example/opengles_skia/meson.build new file mode 100644 index 00000000..00b73c6c --- /dev/null +++ b/docs/api/src/api/axoverlay/example/opengles_skia/meson.build @@ -0,0 +1,17 @@ +sources = files('opengles_skia.cpp') + +all_cppcheck_sources += sources + +install_data(sources, install_dir: axo1_example_source_install_dir) + +if get_option('opengl') + skia_dep = dependency('skia', required: false) + freetype_dep = dependency('freetype2', required: false) + raqm_dep = dependency('raqm', required: false) + harfbuzz_dep = dependency('harfbuzz', required: false) + + executable('axo1_opengles_skia', + sources, + install: true, + dependencies: [axo1_dep, glib_dep, freetype_dep, skia_dep, raqm_dep, harfbuzz_dep, glesv2_dep]) +endif diff --git a/docs/api/src/api/axoverlay/example/palette/meson.build b/docs/api/src/api/axoverlay/example/palette/meson.build new file mode 100644 index 00000000..3557a5f9 --- /dev/null +++ b/docs/api/src/api/axoverlay/example/palette/meson.build @@ -0,0 +1,10 @@ +sources = files('axoverlayexample_palette.c') + +all_cppcheck_sources += sources + +install_data(sources, install_dir: axo1_example_source_install_dir) + +executable('axo1_palette', + sources, + install: true, + dependencies: [axo1_dep, glib_dep, cairo_dep]) diff --git a/docs/api/src/api/axoverlay/html/axoverlay_8h.html b/docs/api/src/api/axoverlay/html/axoverlay_8h.html index c08f350d..77b530e5 100644 --- a/docs/api/src/api/axoverlay/html/axoverlay_8h.html +++ b/docs/api/src/api/axoverlay/html/axoverlay_8h.html @@ -5,7 +5,7 @@ -Axoverlay Library: src/axoverlay.h File Reference +Axoverlay Library: axoverlay.h File Reference @@ -95,11 +95,12 @@

Overlay helper library for creating and rendering custom overlays. More...

#include <glib.h>
+#include <sys/time.h>
Include dependency graph for axoverlay.h:
-
- +
+
@@ -139,6 +140,8 @@   typedef void(* axoverlay_render_function) (gpointer rendering_context, gint id, struct axoverlay_stream_data *stream, enum axoverlay_position_type postype, gfloat overlay_x, gfloat overlay_y, gint overlay_width, gint overlay_height, gpointer user_data)   +typedef void(* axoverlay_synced_render_function) (gpointer rendering_context, gint id, struct axoverlay_stream_data *stream, enum axoverlay_position_type postype, gfloat overlay_x, gfloat overlay_y, gint overlay_width, gint overlay_height, struct timeval *timestamp, gpointer user_data) +  @@ -194,6 +197,18 @@

Enumerations

+ + + + + + + + + + + + @@ -407,6 +422,36 @@

Returns
Returns TRUE if overlays should be rendered for the stream.
+ + +
+

◆ axoverlay_synced_render_function

+ +
+
+

Functions

void axoverlay_enable_cpu_mem_sync (gboolean sync)
 
void axoverlay_set_adjustment_callback (axoverlay_adjustment_function adjustment_callback)
 
void axoverlay_set_stream_select_callback (axoverlay_stream_select_function select_callback)
 
void axoverlay_set_render_callback (axoverlay_render_function render_callback)
 
void axoverlay_set_synced_render_callback (axoverlay_synced_render_function render_callback)
 
void axoverlay_set_backend (const char *backend)
 
void axoverlay_init_axoverlay_settings (struct axoverlay_settings *axoverlay_settings)
 
void axoverlay_init (struct axoverlay_settings *axoverlay_settings, GError **error)
+ + + +
typedef void(* axoverlay_synced_render_function) (gpointer rendering_context, gint id, struct axoverlay_stream_data *stream, enum axoverlay_position_type postype, gfloat overlay_x, gfloat overlay_y, gint overlay_width, gint overlay_height, struct timeval *timestamp, gpointer user_data)
+
+

Same as axoverlay_render_function but also allows you to modify a timestamp for when the overlay should be applied.

+
Parameters
+ + + + + + + + + + + +
rendering_contextA pointer to the rendering context used by the backend. For the Cairo backend ithas the type 'cairo_t'.
idThe id of the overlay
streamInformation about the stream that is currently being rendered to, usually you do not need this information unless you want to rotate your overlay when the stream is rotated.
postypeThe position type.
overlay_xThe x coordinate of the overlay, may be changed
overlay_yThe y coordinate of the overlay, may be changed
overlay_widthThe width of the overlay, may be changed
overlay_heightThe height of the overlay, may be changed
timestampUser sets this timestamp for when the overlay should be applied. timeval contains tv_sec and tv_usec. Time is of type CLOCK_MONOTONIC.
user_dataOptional user data associated with this overlay
+
+
+

Enumeration Type Documentation

@@ -643,6 +688,32 @@

+

◆ axoverlay_enable_cpu_mem_sync()

+ +
+
+ + + + + + + + +
void axoverlay_enable_cpu_mem_sync (gboolean sync)
+
+

This is set to TRUE by default and is necessary for CPU based rendering. However, known GPU backends like OpenGL will have this feature turned off since the GPU will be responsible for knowing when the buffer is ready, such as using glFinish().

+

Note that this option should be set before the first overlay is created, and before axoverlay_init() is called.

+
Parameters
+ + +
syncTRUE if sync of the overlay data should be done after rendering
+
+
+
@@ -813,10 +884,10 @@

-

Initializes the axoverlay system. This function must be called before any other axoverlay function. The thread that calls this function must have a glib main-loop.

+

Initializes the axoverlay system. This function must be called before any other axoverlay function except the one initializing the settings struct. The thread that calls this function must have a glib main-loop.

Parameters
- +
axoverlay_settingsA setting struct where general callbacks.
axoverlay_settingsA setting struct for general callbacks and backend type. If settings has already been set up with setter functions, this argument should be NULL.
errorLocation to store potential error at.
@@ -839,7 +910,13 @@

-

Initializes an axoverlay_settings struct with default values;

+

Initializes an axoverlay_settings struct with default values;

+
Parameters
+ + +
axoverlay_settingsA setting struct for general callbacks and backend type.
+
+
@@ -902,7 +979,7 @@

-

Signals to the system that a redraw should be done. This will in turn call the render function provided in axoverlay_init().

+

Signals to the system that a redraw should be done. This will in turn call the render function provided in axoverlay_init(). If the synced_render_callback is set, axoverlay_redraw will do nothing if a buffer is not available. This means in the time synced case, repeated redraws are necessary for desired behaviour.

Parameters
@@ -936,6 +1013,52 @@

+

◆ axoverlay_set_adjustment_callback()

+ +
+
+

errorLocation to store potential error at.
+ + + + + + + +
void axoverlay_set_adjustment_callback (axoverlay_adjustment_function adjustment_callback)
+
+

Set the adjustment callback method.

See also
axoverlay_settings
+

Note that this option should be set before the first overlay is created, and before axoverlay_init() is called.

+ +
+ + +

◆ axoverlay_set_backend()

+ +
+
+ + + + + + + + +
void axoverlay_set_backend (const char * backend)
+
+

Set backend.

See also
axoverlay_settings
+

Note that this option should be set before the first overlay is created, and before axoverlay_init() is called.

+
Parameters
+ + +
backendThe backend to be used. Options are 'opengles', 'open' and 'cairo'.
+
+
+
@@ -1086,6 +1209,66 @@

+

◆ axoverlay_set_render_callback()

+ +
+
+ + + + + + + + +
void axoverlay_set_render_callback (axoverlay_render_function render_callback)
+
+

Set the standard render callback method.

See also
axoverlay_settings
+

Note that this option should be set before the first overlay is created, and before axoverlay_init() is called.

+ +
+
+ +

◆ axoverlay_set_stream_select_callback()

+ +
+
+ + + + + + + + +
void axoverlay_set_stream_select_callback (axoverlay_stream_select_function select_callback)
+
+

Set the select callback method.

See also
axoverlay_settings
+

Note that this option should be set before the first overlay is created, and before axoverlay_init() is called.

+ +
+
+ +

◆ axoverlay_set_synced_render_callback()

+ +
+
+ + + + + + + + +
void axoverlay_set_synced_render_callback (axoverlay_synced_render_function render_callback)
+
+

Set the extended render callback method that supports timestamps. Either this one or axoverlay_set_render_callback must be set to non-NULL, but not both. An external method in order to keep backwards compatibility.

+

Note that this option should be set before the first overlay is created, and before axoverlay_init() is called.

+
@@ -1094,7 +1277,7 @@

diff --git a/docs/api/src/api/axoverlay/html/axoverlay_8h.js b/docs/api/src/api/axoverlay/html/axoverlay_8h.js index ae934279..75b9c890 100644 --- a/docs/api/src/api/axoverlay/html/axoverlay_8h.js +++ b/docs/api/src/api/axoverlay/html/axoverlay_8h.js @@ -13,6 +13,7 @@ var axoverlay_8h = [ "axoverlay_adjustment_function", "axoverlay_8h.html#acd597540ddc493c361cf49d425527c9b", null ], [ "axoverlay_render_function", "axoverlay_8h.html#af8cda33355d9b1345b4bc97836324a6e", null ], [ "axoverlay_stream_select_function", "axoverlay_8h.html#a69680654ad920dd63825debf80db1835", null ], + [ "axoverlay_synced_render_function", "axoverlay_8h.html#a837c18c9e89496b8e59c23c9320439aa", null ], [ "axoverlay_anchor_point", "axoverlay_8h.html#aa9f8d7e0652223e43d0d80b35fb1b017", [ [ "AXOVERLAY_ANCHOR_TOP_LEFT", "axoverlay_8h.html#aa9f8d7e0652223e43d0d80b35fb1b017a8d67dcee72751fc14aa2d1bce7600efe", null ], [ "AXOVERLAY_ANCHOR_CENTER", "axoverlay_8h.html#aa9f8d7e0652223e43d0d80b35fb1b017a364bf6dd30ca9c71e5e3cb711befd6fc", null ] @@ -56,6 +57,7 @@ var axoverlay_8h = [ "axoverlay_cleanup", "axoverlay_8h.html#a3510c0ea4e04846864603505b3994cf5", null ], [ "axoverlay_create_overlay", "axoverlay_8h.html#a95a791a9f63d0c5bad2d403b0d8c7ba3", null ], [ "axoverlay_destroy_overlay", "axoverlay_8h.html#aef2581df55e0b9adef9fcb795336c902", null ], + [ "axoverlay_enable_cpu_mem_sync", "axoverlay_8h.html#a4f313b61885df524cefe3242527ef1cd", null ], [ "axoverlay_get_max_resolution_height", "axoverlay_8h.html#aba18305ff424cfe2dd8c88974da6c700", null ], [ "axoverlay_get_max_resolution_width", "axoverlay_8h.html#a2081f1e63d1ccefe40e36b7328d07b05", null ], [ "axoverlay_get_number_of_palette_colors", "axoverlay_8h.html#a9039e46539a8ed3e23754e9261b0e793", null ], @@ -66,7 +68,12 @@ var axoverlay_8h = [ "axoverlay_is_backend_supported", "axoverlay_8h.html#ad150141c6187fb915ea263c9824e2114", null ], [ "axoverlay_redraw", "axoverlay_8h.html#ac73bea732951f6bdcead8ee248b35b0a", null ], [ "axoverlay_reload_streams", "axoverlay_8h.html#a05e917b3d92ca3b5e38dd074aeb7d80c", null ], + [ "axoverlay_set_adjustment_callback", "axoverlay_8h.html#af78f0b190338d56da5c6491dfff596d3", null ], + [ "axoverlay_set_backend", "axoverlay_8h.html#af9c9390f00f72ac40793d35f0e4392fd", null ], [ "axoverlay_set_overlay_position", "axoverlay_8h.html#ade3ed3d327deba171eb679416a28af6e", null ], [ "axoverlay_set_overlay_size", "axoverlay_8h.html#aadef178b4a74eb601c095fcb9a0875b3", null ], - [ "axoverlay_set_palette_color", "axoverlay_8h.html#ac95c0f4c11509dfae12707aff79eedb8", null ] + [ "axoverlay_set_palette_color", "axoverlay_8h.html#ac95c0f4c11509dfae12707aff79eedb8", null ], + [ "axoverlay_set_render_callback", "axoverlay_8h.html#a41f1b95d6f4a76bda3795196bee97a2c", null ], + [ "axoverlay_set_stream_select_callback", "axoverlay_8h.html#a14986c555fe904ad27e9cee09c5793b1", null ], + [ "axoverlay_set_synced_render_callback", "axoverlay_8h.html#aa8ef90e6f67e0523c50f70e195b923e9", null ] ]; \ No newline at end of file diff --git a/docs/api/src/api/axoverlay/html/axoverlay_8h__incl.dot b/docs/api/src/api/axoverlay/html/axoverlay_8h__incl.dot index 2b8b2c0b..93544399 100644 --- a/docs/api/src/api/axoverlay/html/axoverlay_8h__incl.dot +++ b/docs/api/src/api/axoverlay/html/axoverlay_8h__incl.dot @@ -1,8 +1,10 @@ -digraph "src/axoverlay.h" +digraph "axoverlay.h" { edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; node [fontname="Helvetica",fontsize="10",shape=record]; - Node0 [label="src/axoverlay.h",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black"]; + Node0 [label="axoverlay.h",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black"]; Node0 -> Node1 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; Node1 [label="glib.h",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled"]; + Node0 -> Node2 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; + Node2 [label="sys/time.h",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled"]; } diff --git a/docs/api/src/api/axoverlay/html/axoverlay_8h__incl.md5 b/docs/api/src/api/axoverlay/html/axoverlay_8h__incl.md5 index dc4454af..7ba89a2f 100644 --- a/docs/api/src/api/axoverlay/html/axoverlay_8h__incl.md5 +++ b/docs/api/src/api/axoverlay/html/axoverlay_8h__incl.md5 @@ -1 +1 @@ -0c919c87ea3a0b3eb2b9909d8b26b08b \ No newline at end of file +779c49708e38945656824c4bc274fc40 \ No newline at end of file diff --git a/docs/api/src/api/axoverlay/html/axoverlay_8h_source.html b/docs/api/src/api/axoverlay/html/axoverlay_8h_source.html index a7015847..5574922a 100644 --- a/docs/api/src/api/axoverlay/html/axoverlay_8h_source.html +++ b/docs/api/src/api/axoverlay/html/axoverlay_8h_source.html @@ -5,7 +5,7 @@ -Axoverlay Library: src/axoverlay.h Source File +Axoverlay Library: axoverlay.h Source File @@ -85,83 +85,90 @@
axoverlay.h
-Go to the documentation of this file.
1 
30 #ifndef AXOVERLAY_H
31 #define AXOVERLAY_H
32 
33 #include <glib.h>
34 
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38 
54 };
55 
68 };
69 
91 };
92 
101 };
102 
113 };
114 
116 #define AXOVERLAY_QUAD_CAMERA_ID 0
117 
119 #define AXOVERLAY_DEFAULT_CAMERA_ID 1
120 
122 #define AXOVERLAY_Z_PRIO_LOW 0
123 
125 #define AXOVERLAY_Z_PRIO_MEDIUM 1000
126 
128 #define AXOVERLAY_Z_PRIO_HIGH 2000
129 
131 #define AXOVERLAY_Z_PRIO_VERY_HIGH 3000
132 
133 enum axoverlay_stream_type {
134  AXOVERLAY_STREAM_JPEG,
135  AXOVERLAY_STREAM_H264,
136  AXOVERLAY_STREAM_H265,
137  AXOVERLAY_STREAM_YCBCR,
138  AXOVERLAY_STREAM_VOUT,
139  AXOVERLAY_STREAM_OTHER
140 };
141 
148  gint id;
149  gint camera;
150  gint width;
153  gint height;
156  gint rotation;
157  gboolean is_mirrored;
159  enum axoverlay_stream_type type;
160 };
161 
164  enum axoverlay_anchor_point anchor_point;
167  enum axoverlay_position_type postype;
172  gfloat x;
174  gfloat y;
176  gint width;
180  gint height;
184  gint z_priority;
188  enum axoverlay_colorspace colorspace;
197  gboolean scale_to_stream;
203 };
204 
207  guchar red;
208  guchar green;
209  guchar blue;
210  guchar alpha;
211  gboolean pixelate;
213 };
214 
229 typedef gboolean (*axoverlay_stream_select_function)(gint camera, gint width,
230  gint height, gint rotation,
231  gboolean is_mirrored,
232  enum axoverlay_stream_type type);
233 
256 typedef void (*axoverlay_adjustment_function)(gint id,
257  struct axoverlay_stream_data *stream,
258  enum axoverlay_position_type *postype,
259  gfloat *overlay_x, gfloat *overlay_y,
260  gint *overlay_width,
261  gint *overlay_height,
262  gpointer user_data);
263 
286 typedef void (*axoverlay_render_function)(gpointer rendering_context, gint id,
287  struct axoverlay_stream_data *stream,
288  enum axoverlay_position_type postype,
289  gfloat overlay_x, gfloat overlay_y,
290  gint overlay_width, gint overlay_height,
291  gpointer user_data);
292 
321  enum axoverlay_backend_type backend;
324 };
325 
331 
341  GError **error);
342 
349 void axoverlay_cleanup(void);
350 
361 void axoverlay_reload_streams(GError **error);
362 
369 void axoverlay_redraw(GError **error);
370 
377 
394  gpointer user_data, GError **error);
395 
406 void axoverlay_destroy_overlay(gint id, GError **error);
407 
421 void axoverlay_set_overlay_position(gint id,
422  enum axoverlay_position_type postype,
423  gfloat x, gfloat y, GError **error);
424 
435 void axoverlay_set_overlay_size(gint id, gint width, gint height,
436  GError **error);
437 
445 gint axoverlay_get_max_resolution_width(gint camera, GError **error);
446 
454 gint axoverlay_get_max_resolution_height(gint camera, GError **error);
455 
461 
468 gint axoverlay_get_number_of_palette_colors(GError **error);
469 
477 void axoverlay_get_palette_color(gint index,
478  struct axoverlay_palette_color *color,
479  GError **error);
480 
488 void axoverlay_set_palette_color(gint index,
489  struct axoverlay_palette_color *color,
490  GError **error);
491 
492 #ifdef __cplusplus
493 }
494 #endif
495 
496 #endif
gint axoverlay_get_number_of_palette_colors(GError **error)
+Go to the documentation of this file.
1 
22 #ifndef AXOVERLAY_H
23 #define AXOVERLAY_H
24 
25 #include <glib.h>
26 #include <sys/time.h>
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
47 };
48 
61 };
62 
84 };
85 
94 };
95 
106 };
107 
109 #define AXOVERLAY_QUAD_CAMERA_ID 0
110 
112 #define AXOVERLAY_DEFAULT_CAMERA_ID 1
113 
115 #define AXOVERLAY_Z_PRIO_LOW 0
116 
118 #define AXOVERLAY_Z_PRIO_MEDIUM 1000
119 
121 #define AXOVERLAY_Z_PRIO_HIGH 2000
122 
124 #define AXOVERLAY_Z_PRIO_VERY_HIGH 3000
125 
126 enum axoverlay_stream_type {
127  AXOVERLAY_STREAM_JPEG,
128  AXOVERLAY_STREAM_H264,
129  AXOVERLAY_STREAM_H265,
130  AXOVERLAY_STREAM_YCBCR,
131  AXOVERLAY_STREAM_VOUT,
132  AXOVERLAY_STREAM_OTHER
133 };
134 
141  gint id;
142  gint camera;
143  gint width;
146  gint height;
149  gint rotation;
150  gboolean is_mirrored;
152  enum axoverlay_stream_type type;
153 };
154 
157  enum axoverlay_anchor_point anchor_point;
160  enum axoverlay_position_type postype;
165  gfloat x;
167  gfloat y;
169  gint width;
173  gint height;
177  gint z_priority;
181  enum axoverlay_colorspace colorspace;
190  gboolean scale_to_stream;
196 };
197 
200  guchar red;
201  guchar green;
202  guchar blue;
203  guchar alpha;
204  gboolean pixelate;
206 };
207 
222 typedef gboolean (*axoverlay_stream_select_function)(gint camera, gint width,
223  gint height, gint rotation,
224  gboolean is_mirrored,
225  enum axoverlay_stream_type type);
226 
249 typedef void (*axoverlay_adjustment_function)(gint id,
250  struct axoverlay_stream_data *stream,
251  enum axoverlay_position_type *postype,
252  gfloat *overlay_x, gfloat *overlay_y,
253  gint *overlay_width,
254  gint *overlay_height,
255  gpointer user_data);
256 
279 typedef void (*axoverlay_render_function)(gpointer rendering_context, gint id,
280  struct axoverlay_stream_data *stream,
281  enum axoverlay_position_type postype,
282  gfloat overlay_x, gfloat overlay_y,
283  gint overlay_width, gint overlay_height,
284  gpointer user_data);
285 
308 typedef void (*axoverlay_synced_render_function)(gpointer rendering_context, gint id,
309  struct axoverlay_stream_data *stream,
310  enum axoverlay_position_type postype,
311  gfloat overlay_x, gfloat overlay_y,
312  gint overlay_width, gint overlay_height,
313  struct timeval *timestamp,
314  gpointer user_data);
315 
347  enum axoverlay_backend_type backend;
350 };
351 
363 void axoverlay_enable_cpu_mem_sync(gboolean sync);
364 
372 
380 
388 
399 
408 void axoverlay_set_backend(const char *backend);
409 
417 
429  GError **error);
430 
437 void axoverlay_cleanup(void);
438 
449 void axoverlay_reload_streams(GError **error);
450 
460 void axoverlay_redraw(GError **error);
461 
468 
485  gpointer user_data, GError **error);
486 
497 void axoverlay_destroy_overlay(gint id, GError **error);
498 
512 void axoverlay_set_overlay_position(gint id,
513  enum axoverlay_position_type postype,
514  gfloat x, gfloat y, GError **error);
515 
526 void axoverlay_set_overlay_size(gint id, gint width, gint height,
527  GError **error);
528 
536 gint axoverlay_get_max_resolution_width(gint camera, GError **error);
537 
545 gint axoverlay_get_max_resolution_height(gint camera, GError **error);
546 
552 
559 gint axoverlay_get_number_of_palette_colors(GError **error);
560 
568 void axoverlay_get_palette_color(gint index,
569  struct axoverlay_palette_color *color,
570  GError **error);
571 
579 void axoverlay_set_palette_color(gint index,
580  struct axoverlay_palette_color *color,
581  GError **error);
582 
583 #ifdef __cplusplus
584 }
585 #endif
586 
587 #endif
gint axoverlay_get_number_of_palette_colors(GError **error)
+
void(* axoverlay_synced_render_function)(gpointer rendering_context, gint id, struct axoverlay_stream_data *stream, enum axoverlay_position_type postype, gfloat overlay_x, gfloat overlay_y, gint overlay_width, gint overlay_height, struct timeval *timestamp, gpointer user_data)
Definition: axoverlay.h:308
void axoverlay_init_overlay_data(struct axoverlay_overlay_data *data)
-
gint z_priority
Definition: axoverlay.h:184
-
void(* axoverlay_render_function)(gpointer rendering_context, gint id, struct axoverlay_stream_data *stream, enum axoverlay_position_type postype, gfloat overlay_x, gfloat overlay_y, gint overlay_width, gint overlay_height, gpointer user_data)
Definition: axoverlay.h:286
-
Definition: axoverlay.h:64
-
Definition: axoverlay.h:67
-
guchar red
Definition: axoverlay.h:207
-
gboolean(* axoverlay_stream_select_function)(gint camera, gint width, gint height, gint rotation, gboolean is_mirrored, enum axoverlay_stream_type type)
Definition: axoverlay.h:229
-
gboolean is_mirrored
Definition: axoverlay.h:157
-
Definition: axoverlay.h:111
-
axoverlay_position_type
Definition: axoverlay.h:82
-
Definition: axoverlay.h:65
-
Definition: axoverlay.h:43
-
gint id
Definition: axoverlay.h:148
-
guchar green
Definition: axoverlay.h:208
+
gint z_priority
Definition: axoverlay.h:177
+
void(* axoverlay_render_function)(gpointer rendering_context, gint id, struct axoverlay_stream_data *stream, enum axoverlay_position_type postype, gfloat overlay_x, gfloat overlay_y, gint overlay_width, gint overlay_height, gpointer user_data)
Definition: axoverlay.h:279
+
Definition: axoverlay.h:57
+
Definition: axoverlay.h:60
+
guchar red
Definition: axoverlay.h:200
+
gboolean(* axoverlay_stream_select_function)(gint camera, gint width, gint height, gint rotation, gboolean is_mirrored, enum axoverlay_stream_type type)
Definition: axoverlay.h:222
+
gboolean is_mirrored
Definition: axoverlay.h:150
+
Definition: axoverlay.h:104
+
axoverlay_position_type
Definition: axoverlay.h:75
+
void axoverlay_set_synced_render_callback(axoverlay_synced_render_function render_callback)
+
Definition: axoverlay.h:58
+
Definition: axoverlay.h:36
+
gint id
Definition: axoverlay.h:141
+
guchar green
Definition: axoverlay.h:201
void axoverlay_destroy_overlay(gint id, GError **error)
void axoverlay_cleanup(void)
-
Definition: axoverlay.h:86
-
Definition: axoverlay.h:84
-
Definition: axoverlay.h:206
+
void axoverlay_set_render_callback(axoverlay_render_function render_callback)
+
Definition: axoverlay.h:79
+
Definition: axoverlay.h:77
+
Definition: axoverlay.h:199
void axoverlay_reload_streams(GError **error)
-
Definition: axoverlay.h:112
-
Definition: axoverlay.h:85
-
axoverlay_adjustment_function adjustment_callback
Definition: axoverlay.h:305
+
void axoverlay_set_stream_select_callback(axoverlay_stream_select_function select_callback)
+
Definition: axoverlay.h:105
+
Definition: axoverlay.h:78
+
axoverlay_adjustment_function adjustment_callback
Definition: axoverlay.h:331
void axoverlay_set_overlay_size(gint id, gint width, gint height, GError **error)
-
Definition: axoverlay.h:163
+
Definition: axoverlay.h:156
void axoverlay_init(struct axoverlay_settings *axoverlay_settings, GError **error)
-
axoverlay_anchor_point
Definition: axoverlay.h:110
-
Definition: axoverlay.h:48
-
axoverlay_backend_type
Definition: axoverlay.h:97
-
Definition: axoverlay.h:50
+
axoverlay_anchor_point
Definition: axoverlay.h:103
+
Definition: axoverlay.h:41
+
axoverlay_backend_type
Definition: axoverlay.h:90
+
Definition: axoverlay.h:43
gboolean axoverlay_is_backend_supported(enum axoverlay_backend_type backend)
void axoverlay_set_overlay_position(gint id, enum axoverlay_position_type postype, gfloat x, gfloat y, GError **error)
-
Definition: axoverlay.h:100
-
void(* axoverlay_adjustment_function)(gint id, struct axoverlay_stream_data *stream, enum axoverlay_position_type *postype, gfloat *overlay_x, gfloat *overlay_y, gint *overlay_width, gint *overlay_height, gpointer user_data)
Definition: axoverlay.h:256
-
Definition: axoverlay.h:99
-
Definition: axoverlay.h:87
-
gint height
Definition: axoverlay.h:153
-
gfloat y
Definition: axoverlay.h:174
-
gfloat x
Definition: axoverlay.h:172
+
Definition: axoverlay.h:93
+
void(* axoverlay_adjustment_function)(gint id, struct axoverlay_stream_data *stream, enum axoverlay_position_type *postype, gfloat *overlay_x, gfloat *overlay_y, gint *overlay_width, gint *overlay_height, gpointer user_data)
Definition: axoverlay.h:249
+
Definition: axoverlay.h:92
+
Definition: axoverlay.h:80
+
gint height
Definition: axoverlay.h:146
+
gfloat y
Definition: axoverlay.h:167
+
gfloat x
Definition: axoverlay.h:165
gint axoverlay_get_max_resolution_width(gint camera, GError **error)
-
Definition: axoverlay.h:297
-
gint height
Definition: axoverlay.h:180
-
Definition: axoverlay.h:147
-
gint width
Definition: axoverlay.h:176
+
Definition: axoverlay.h:320
+
gint height
Definition: axoverlay.h:173
+
Definition: axoverlay.h:140
+
gint width
Definition: axoverlay.h:169
void axoverlay_get_palette_color(gint index, struct axoverlay_palette_color *color, GError **error)
-
gboolean pixelate
Definition: axoverlay.h:211
-
axoverlay_error_code
Definition: axoverlay.h:42
+
void axoverlay_enable_cpu_mem_sync(gboolean sync)
+
gboolean pixelate
Definition: axoverlay.h:204
+
axoverlay_error_code
Definition: axoverlay.h:35
gint axoverlay_create_overlay(struct axoverlay_overlay_data *data, gpointer user_data, GError **error)
-
Definition: axoverlay.h:47
-
Definition: axoverlay.h:83
-
Definition: axoverlay.h:66
+
Definition: axoverlay.h:40
+
Definition: axoverlay.h:76
+
Definition: axoverlay.h:59
void axoverlay_set_palette_color(gint index, struct axoverlay_palette_color *color, GError **error)
-
Definition: axoverlay.h:52
+
Definition: axoverlay.h:45
void axoverlay_init_axoverlay_settings(struct axoverlay_settings *axoverlay_settings)
gint axoverlay_get_max_resolution_height(gint camera, GError **error)
-
Definition: axoverlay.h:89
-
Definition: axoverlay.h:98
-
gboolean scale_to_stream
Definition: axoverlay.h:197
-
axoverlay_stream_select_function select_callback
Definition: axoverlay.h:314
-
Definition: axoverlay.h:45
-
guchar blue
Definition: axoverlay.h:209
-
guchar alpha
Definition: axoverlay.h:210
-
gint width
Definition: axoverlay.h:150
-
gint rotation
Definition: axoverlay.h:156
+
Definition: axoverlay.h:82
+
Definition: axoverlay.h:91
+
void axoverlay_set_backend(const char *backend)
+
void axoverlay_set_adjustment_callback(axoverlay_adjustment_function adjustment_callback)
+
gboolean scale_to_stream
Definition: axoverlay.h:190
+
axoverlay_stream_select_function select_callback
Definition: axoverlay.h:340
+
Definition: axoverlay.h:38
+
guchar blue
Definition: axoverlay.h:202
+
guchar alpha
Definition: axoverlay.h:203
+
gint width
Definition: axoverlay.h:143
+
gint rotation
Definition: axoverlay.h:149
void axoverlay_redraw(GError **error)
-
axoverlay_colorspace
Definition: axoverlay.h:63
-
gint camera
Definition: axoverlay.h:149
-
Definition: axoverlay.h:46
-
axoverlay_render_function render_callback
Definition: axoverlay.h:298
+
axoverlay_colorspace
Definition: axoverlay.h:56
+
gint camera
Definition: axoverlay.h:142
+
Definition: axoverlay.h:39
+
axoverlay_render_function render_callback
Definition: axoverlay.h:321
diff --git a/docs/api/src/api/axoverlay/html/axoverlaypage.html b/docs/api/src/api/axoverlay/html/axoverlaypage.html index f4d10a9f..bfdddee7 100644 --- a/docs/api/src/api/axoverlay/html/axoverlaypage.html +++ b/docs/api/src/api/axoverlay/html/axoverlaypage.html @@ -5,7 +5,7 @@ -Axoverlay Library: Axoverlay C API +Axoverlay Library: Axoverlay C API version 1.0 @@ -82,10 +82,10 @@
-
Axoverlay C API
+
Axoverlay C API version 1.0
-

This manual documents the Axoverlay C API.

+

This manual documents the legacy Axoverlay C API.

The purpose of this library is to make it easier to create and render custom overlays.

diff --git a/docs/api/src/api/axoverlay/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/docs/api/src/api/axoverlay/html/dir_5f95f37867742e27eef5ba25b7140943.html similarity index 90% rename from docs/api/src/api/axoverlay/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html rename to docs/api/src/api/axoverlay/html/dir_5f95f37867742e27eef5ba25b7140943.html index ed12b4f2..97af67b3 100644 --- a/docs/api/src/api/axoverlay/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html +++ b/docs/api/src/api/axoverlay/html/dir_5f95f37867742e27eef5ba25b7140943.html @@ -5,7 +5,7 @@ -Axoverlay Library: src Directory Reference +Axoverlay Library: include Directory Reference @@ -63,7 +63,7 @@
@@ -82,7 +82,7 @@
-
src Directory Reference
+
include Directory Reference
@@ -98,7 +98,7 @@ diff --git a/docs/api/src/api/axoverlay/html/dir_68267d1309a1af8e8297ef4c3efbcdba.js b/docs/api/src/api/axoverlay/html/dir_68267d1309a1af8e8297ef4c3efbcdba.js deleted file mode 100644 index 9332709e..00000000 --- a/docs/api/src/api/axoverlay/html/dir_68267d1309a1af8e8297ef4c3efbcdba.js +++ /dev/null @@ -1,4 +0,0 @@ -var dir_68267d1309a1af8e8297ef4c3efbcdba = -[ - [ "axoverlay.h", "axoverlay_8h.html", "axoverlay_8h" ] -]; \ No newline at end of file diff --git a/docs/api/src/api/axoverlay/html/dir_a6e26b83e1cc01163d742a8b70e154d1.html b/docs/api/src/api/axoverlay/html/dir_a6e26b83e1cc01163d742a8b70e154d1.html new file mode 100644 index 00000000..4dc60045 --- /dev/null +++ b/docs/api/src/api/axoverlay/html/dir_a6e26b83e1cc01163d742a8b70e154d1.html @@ -0,0 +1,103 @@ + + + + + + + +Axoverlay Library: v1 Directory Reference + + + + + + + + + + + + + + + +
+
+
+ + + + + + +
+
Axoverlay Library +
+
+
+ + + + + + + + +
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
v1 Directory Reference
+
+
+ + +

+Directories

+
+
+ + + + + diff --git a/docs/api/src/api/axoverlay/html/files.html b/docs/api/src/api/axoverlay/html/files.html index bc2e3ff2..e067b61b 100644 --- a/docs/api/src/api/axoverlay/html/files.html +++ b/docs/api/src/api/axoverlay/html/files.html @@ -86,9 +86,8 @@
Here is a list of all documented files with brief descriptions:
-
[detail level 12]
- - +
  src
 axoverlay.hOverlay helper library for creating and rendering custom overlays
+
 axoverlay.hOverlay helper library for creating and rendering custom overlays
diff --git a/docs/api/src/api/axoverlay/html/files.js b/docs/api/src/api/axoverlay/html/files.js index 04b0a8ee..a79b530c 100644 --- a/docs/api/src/api/axoverlay/html/files.js +++ b/docs/api/src/api/axoverlay/html/files.js @@ -1,4 +1,4 @@ var files = [ - [ "src", "dir_68267d1309a1af8e8297ef4c3efbcdba.html", "dir_68267d1309a1af8e8297ef4c3efbcdba" ] + [ "axoverlay.h", "axoverlay_8h.html", "axoverlay_8h" ] ]; \ No newline at end of file diff --git a/docs/api/src/api/axoverlay/html/globals.html b/docs/api/src/api/axoverlay/html/globals.html index 106ec858..6d8f3654 100644 --- a/docs/api/src/api/axoverlay/html/globals.html +++ b/docs/api/src/api/axoverlay/html/globals.html @@ -141,6 +141,9 @@

- a -

  • axoverlay_destroy_overlay() : axoverlay.h
  • +
  • axoverlay_enable_cpu_mem_sync() +: axoverlay.h +
  • AXOVERLAY_ERROR_BACKEND : axoverlay.h
  • @@ -210,6 +213,12 @@

    - a -

    • axoverlay_render_function : axoverlay.h
    • +
    • axoverlay_set_adjustment_callback() +: axoverlay.h +
    • +
    • axoverlay_set_backend() +: axoverlay.h +
    • axoverlay_set_overlay_position() : axoverlay.h
    • @@ -219,9 +228,21 @@

      - a -

      • axoverlay_set_palette_color() : axoverlay.h
      • +
      • axoverlay_set_render_callback() +: axoverlay.h +
      • +
      • axoverlay_set_stream_select_callback() +: axoverlay.h +
      • +
      • axoverlay_set_synced_render_callback() +: axoverlay.h +
      • axoverlay_stream_select_function : axoverlay.h
      • +
      • axoverlay_synced_render_function +: axoverlay.h +
      • AXOVERLAY_TOP_LEFT : axoverlay.h
      • diff --git a/docs/api/src/api/axoverlay/html/globals_func.html b/docs/api/src/api/axoverlay/html/globals_func.html index 035cec11..0adf8cf6 100644 --- a/docs/api/src/api/axoverlay/html/globals_func.html +++ b/docs/api/src/api/axoverlay/html/globals_func.html @@ -91,6 +91,9 @@
      • axoverlay_destroy_overlay() : axoverlay.h
      • +
      • axoverlay_enable_cpu_mem_sync() +: axoverlay.h +
      • axoverlay_get_max_resolution_height() : axoverlay.h
      • @@ -121,6 +124,12 @@
      • axoverlay_reload_streams() : axoverlay.h
      • +
      • axoverlay_set_adjustment_callback() +: axoverlay.h +
      • +
      • axoverlay_set_backend() +: axoverlay.h +
      • axoverlay_set_overlay_position() : axoverlay.h
      • @@ -130,6 +139,15 @@
      • axoverlay_set_palette_color() : axoverlay.h
      • +
      • axoverlay_set_render_callback() +: axoverlay.h +
      • +
      • axoverlay_set_stream_select_callback() +: axoverlay.h +
      • +
      • axoverlay_set_synced_render_callback() +: axoverlay.h +
      diff --git a/docs/api/src/api/axoverlay/html/globals_type.html b/docs/api/src/api/axoverlay/html/globals_type.html index d0e5df0c..ed31f583 100644 --- a/docs/api/src/api/axoverlay/html/globals_type.html +++ b/docs/api/src/api/axoverlay/html/globals_type.html @@ -91,6 +91,9 @@
    • axoverlay_stream_select_function : axoverlay.h
    • +
    • axoverlay_synced_render_function +: axoverlay.h +
    diff --git a/docs/api/src/api/axoverlay/html/index.html b/docs/api/src/api/axoverlay/html/index.html index 4d23af5e..daa460e1 100644 --- a/docs/api/src/api/axoverlay/html/index.html +++ b/docs/api/src/api/axoverlay/html/index.html @@ -5,7 +5,7 @@ -Axoverlay Library: Documentation +Axoverlay Library: Main Page @@ -82,12 +82,10 @@
    -
    Documentation
    +
    Axoverlay Library Documentation
    -

    This manual documents the C API for the Axoverlay library.

    -

    Axoverlay C API contains functions to manage overlays

    -
    + diff --git a/docs/api/src/api/axoverlay/html/navtreedata.js b/docs/api/src/api/axoverlay/html/navtreedata.js index afad269a..8c88b868 100644 --- a/docs/api/src/api/axoverlay/html/navtreedata.js +++ b/docs/api/src/api/axoverlay/html/navtreedata.js @@ -1,8 +1,7 @@ var NAVTREE = [ [ "Axoverlay Library", "index.html", [ - [ "Documentation", "index.html", null ], - [ "Axoverlay C API", "axoverlaypage.html", null ], + [ "Axoverlay C API version 1.0", "axoverlaypage.html", null ], [ "Data Structures", "annotated.html", [ [ "Data Structures", "annotated.html", "annotated_dup" ], [ "Data Structure Index", "classes.html", null ], diff --git a/docs/api/src/api/axoverlay/html/navtreeindex0.js b/docs/api/src/api/axoverlay/html/navtreeindex0.js index dd9f6898..a8947e51 100644 --- a/docs/api/src/api/axoverlay/html/navtreeindex0.js +++ b/docs/api/src/api/axoverlay/html/navtreeindex0.js @@ -1,112 +1,117 @@ var NAVTREEINDEX0 = { -"../../../main/html/acap3_api.html":[6], -"../../../main/html/index.html":[4], -"../../../sdk/html/index.html":[5], -"annotated.html":[2,0], -"axoverlay_8h.html":[3,0,0,0], -"axoverlay_8h.html#a0479f50dd4fab27a3e2812e2f9c33ecf":[3,0,0,0,6], -"axoverlay_8h.html#a05e917b3d92ca3b5e38dd074aeb7d80c":[3,0,0,0,31], -"axoverlay_8h.html#a12c15b65d51e7a59600531d1d5c81e92":[3,0,0,0,14], -"axoverlay_8h.html#a12c15b65d51e7a59600531d1d5c81e92a383d3cc6dd17b2c89011ecddd26b2658":[3,0,0,0,14,2], -"axoverlay_8h.html#a12c15b65d51e7a59600531d1d5c81e92a77beab5289aa322ce600eaa329ad138c":[3,0,0,0,14,1], -"axoverlay_8h.html#a12c15b65d51e7a59600531d1d5c81e92ac6f3615a8c70061239d8de38f945ebba":[3,0,0,0,14,0], -"axoverlay_8h.html#a1c41cacf9e4a49827169a0e42d032bf0":[3,0,0,0,4], -"axoverlay_8h.html#a2081f1e63d1ccefe40e36b7328d07b05":[3,0,0,0,23], -"axoverlay_8h.html#a2d6236ddb190f1c5f30035c238f78b6b":[3,0,0,0,28], -"axoverlay_8h.html#a3510c0ea4e04846864603505b3994cf5":[3,0,0,0,19], -"axoverlay_8h.html#a3564acf79f48af97e2414127696f82d7":[3,0,0,0,27], -"axoverlay_8h.html#a3d9bc98f846c4fa067a5d32e7c86e60c":[3,0,0,0,17], -"axoverlay_8h.html#a3d9bc98f846c4fa067a5d32e7c86e60ca4e2e8dff710303da53f9984e5d6d2d2d":[3,0,0,0,17,1], -"axoverlay_8h.html#a3d9bc98f846c4fa067a5d32e7c86e60ca5b422692c040dcfe7054ab4187907543":[3,0,0,0,17,2], -"axoverlay_8h.html#a3d9bc98f846c4fa067a5d32e7c86e60ca9d75b57391dd41ef324a2f9a8eb3fd0f":[3,0,0,0,17,0], -"axoverlay_8h.html#a3d9bc98f846c4fa067a5d32e7c86e60cac88c862b0d51cf8b4edf7ec7945dec9a":[3,0,0,0,17,5], -"axoverlay_8h.html#a3d9bc98f846c4fa067a5d32e7c86e60cae68566e8f6ec53b269eb4aa7e9553af4":[3,0,0,0,17,4], -"axoverlay_8h.html#a3d9bc98f846c4fa067a5d32e7c86e60cae7abd117533b3596c9857dfb6f035346":[3,0,0,0,17,3], -"axoverlay_8h.html#a51fd42bb071d82e3973c86a10a8fe8ba":[3,0,0,0,7], -"axoverlay_8h.html#a5fd4ab19e72943126ce728ba5eed79df":[3,0,0,0,9], -"axoverlay_8h.html#a63b90552971c0a0e467093ff3418cbd6":[3,0,0,0,15], -"axoverlay_8h.html#a63b90552971c0a0e467093ff3418cbd6a11f43c73718917f1305588ce9bb9461a":[3,0,0,0,15,3], -"axoverlay_8h.html#a63b90552971c0a0e467093ff3418cbd6a24f2d5da13ccea3f24c9285daa3d5806":[3,0,0,0,15,0], -"axoverlay_8h.html#a63b90552971c0a0e467093ff3418cbd6a5c0fd09e24c9823121befe7f02c9d9a6":[3,0,0,0,15,2], -"axoverlay_8h.html#a63b90552971c0a0e467093ff3418cbd6ae4321f158a3ce91d40e9dd2533011fe9":[3,0,0,0,15,1], -"axoverlay_8h.html#a69680654ad920dd63825debf80db1835":[3,0,0,0,12], -"axoverlay_8h.html#a79534991a1ffa36aa47493e703795f60":[3,0,0,0,18], -"axoverlay_8h.html#a79534991a1ffa36aa47493e703795f60a1fb9c962db18f76ff0c572a8d117b58d":[3,0,0,0,18,4], -"axoverlay_8h.html#a79534991a1ffa36aa47493e703795f60a6337608f3d6a7faea5ad26ca5b6152a3":[3,0,0,0,18,5], -"axoverlay_8h.html#a79534991a1ffa36aa47493e703795f60a6a6b9b1ce8a9709b91a1bd177b42b4ac":[3,0,0,0,18,1], -"axoverlay_8h.html#a79534991a1ffa36aa47493e703795f60a8a8d4f5e31404d48fc1cbd0b8670c966":[3,0,0,0,18,0], -"axoverlay_8h.html#a79534991a1ffa36aa47493e703795f60aeca66fbd45e07d9e0b72428483c05ea0":[3,0,0,0,18,2], -"axoverlay_8h.html#a79534991a1ffa36aa47493e703795f60afcb5c81e97977cc40382446a21eb2aa3":[3,0,0,0,18,3], -"axoverlay_8h.html#a9039e46539a8ed3e23754e9261b0e793":[3,0,0,0,24], -"axoverlay_8h.html#a95a791a9f63d0c5bad2d403b0d8c7ba3":[3,0,0,0,20], -"axoverlay_8h.html#a99b3dcd1441c0c3b28aab30680146dbf":[3,0,0,0,25], -"axoverlay_8h.html#aa9f8d7e0652223e43d0d80b35fb1b017":[3,0,0,0,13], -"axoverlay_8h.html#aa9f8d7e0652223e43d0d80b35fb1b017a364bf6dd30ca9c71e5e3cb711befd6fc":[3,0,0,0,13,1], -"axoverlay_8h.html#aa9f8d7e0652223e43d0d80b35fb1b017a8d67dcee72751fc14aa2d1bce7600efe":[3,0,0,0,13,0], -"axoverlay_8h.html#aadef178b4a74eb601c095fcb9a0875b3":[3,0,0,0,33], -"axoverlay_8h.html#aba18305ff424cfe2dd8c88974da6c700":[3,0,0,0,22], -"axoverlay_8h.html#abcee514e8d556934e857fd594a471865":[3,0,0,0,26], -"axoverlay_8h.html#ac73bea732951f6bdcead8ee248b35b0a":[3,0,0,0,30], -"axoverlay_8h.html#ac95c0f4c11509dfae12707aff79eedb8":[3,0,0,0,34], -"axoverlay_8h.html#acd597540ddc493c361cf49d425527c9b":[3,0,0,0,10], -"axoverlay_8h.html#ad150141c6187fb915ea263c9824e2114":[3,0,0,0,29], -"axoverlay_8h.html#ad1ba0477e427afaa3c42637c442ffc21":[3,0,0,0,16], -"axoverlay_8h.html#ad1ba0477e427afaa3c42637c442ffc21a2c94311e80ff3f31edf89f0e402d8851":[3,0,0,0,16,4], -"axoverlay_8h.html#ad1ba0477e427afaa3c42637c442ffc21a51424a18510a24d1ba8874a8b5075845":[3,0,0,0,16,3], -"axoverlay_8h.html#ad1ba0477e427afaa3c42637c442ffc21a64ae96167826e297a008237b342a1474":[3,0,0,0,16,1], -"axoverlay_8h.html#ad1ba0477e427afaa3c42637c442ffc21a786851c992cfe9c3c515620ecbdc9943":[3,0,0,0,16,0], -"axoverlay_8h.html#ad1ba0477e427afaa3c42637c442ffc21ab6162de2f1b5a2e34b181e67de5b97b5":[3,0,0,0,16,6], -"axoverlay_8h.html#ad1ba0477e427afaa3c42637c442ffc21abd05ba5ae91988339ab9639fd9ceb624":[3,0,0,0,16,2], -"axoverlay_8h.html#ad1ba0477e427afaa3c42637c442ffc21ae8da7833aa75886b72719fda5c3355e2":[3,0,0,0,16,5], -"axoverlay_8h.html#ad484b29c95580bfacf74efbc7e4848d6":[3,0,0,0,8], -"axoverlay_8h.html#ade3ed3d327deba171eb679416a28af6e":[3,0,0,0,32], -"axoverlay_8h.html#ae39d6ff9a957a1da895c494104161b4c":[3,0,0,0,5], -"axoverlay_8h.html#aef2581df55e0b9adef9fcb795336c902":[3,0,0,0,21], -"axoverlay_8h.html#af8cda33355d9b1345b4bc97836324a6e":[3,0,0,0,11], -"axoverlay_8h_source.html":[3,0,0,0], -"axoverlaypage.html":[1], -"classes.html":[2,1], -"dir_68267d1309a1af8e8297ef4c3efbcdba.html":[3,0,0], -"files.html":[3,0], -"functions.html":[2,2,0], -"functions_vars.html":[2,2,1], -"globals.html":[3,1,0], -"globals_defs.html":[3,1,5], -"globals_enum.html":[3,1,3], -"globals_eval.html":[3,1,4], -"globals_func.html":[3,1,1], -"globals_type.html":[3,1,2], +"../../../main/html/acap3_api.html":[5], +"../../../main/html/index.html":[3], +"../../../sdk/html/index.html":[4], +"annotated.html":[1,0], +"axoverlay_8h.html":[2,0,0], +"axoverlay_8h.html#a0479f50dd4fab27a3e2812e2f9c33ecf":[2,0,0,6], +"axoverlay_8h.html#a05e917b3d92ca3b5e38dd074aeb7d80c":[2,0,0,33], +"axoverlay_8h.html#a12c15b65d51e7a59600531d1d5c81e92":[2,0,0,15], +"axoverlay_8h.html#a12c15b65d51e7a59600531d1d5c81e92a383d3cc6dd17b2c89011ecddd26b2658":[2,0,0,15,2], +"axoverlay_8h.html#a12c15b65d51e7a59600531d1d5c81e92a77beab5289aa322ce600eaa329ad138c":[2,0,0,15,1], +"axoverlay_8h.html#a12c15b65d51e7a59600531d1d5c81e92ac6f3615a8c70061239d8de38f945ebba":[2,0,0,15,0], +"axoverlay_8h.html#a14986c555fe904ad27e9cee09c5793b1":[2,0,0,40], +"axoverlay_8h.html#a1c41cacf9e4a49827169a0e42d032bf0":[2,0,0,4], +"axoverlay_8h.html#a2081f1e63d1ccefe40e36b7328d07b05":[2,0,0,25], +"axoverlay_8h.html#a2d6236ddb190f1c5f30035c238f78b6b":[2,0,0,30], +"axoverlay_8h.html#a3510c0ea4e04846864603505b3994cf5":[2,0,0,20], +"axoverlay_8h.html#a3564acf79f48af97e2414127696f82d7":[2,0,0,29], +"axoverlay_8h.html#a3d9bc98f846c4fa067a5d32e7c86e60c":[2,0,0,18], +"axoverlay_8h.html#a3d9bc98f846c4fa067a5d32e7c86e60ca4e2e8dff710303da53f9984e5d6d2d2d":[2,0,0,18,1], +"axoverlay_8h.html#a3d9bc98f846c4fa067a5d32e7c86e60ca5b422692c040dcfe7054ab4187907543":[2,0,0,18,2], +"axoverlay_8h.html#a3d9bc98f846c4fa067a5d32e7c86e60ca9d75b57391dd41ef324a2f9a8eb3fd0f":[2,0,0,18,0], +"axoverlay_8h.html#a3d9bc98f846c4fa067a5d32e7c86e60cac88c862b0d51cf8b4edf7ec7945dec9a":[2,0,0,18,5], +"axoverlay_8h.html#a3d9bc98f846c4fa067a5d32e7c86e60cae68566e8f6ec53b269eb4aa7e9553af4":[2,0,0,18,4], +"axoverlay_8h.html#a3d9bc98f846c4fa067a5d32e7c86e60cae7abd117533b3596c9857dfb6f035346":[2,0,0,18,3], +"axoverlay_8h.html#a41f1b95d6f4a76bda3795196bee97a2c":[2,0,0,39], +"axoverlay_8h.html#a4f313b61885df524cefe3242527ef1cd":[2,0,0,23], +"axoverlay_8h.html#a51fd42bb071d82e3973c86a10a8fe8ba":[2,0,0,7], +"axoverlay_8h.html#a5fd4ab19e72943126ce728ba5eed79df":[2,0,0,9], +"axoverlay_8h.html#a63b90552971c0a0e467093ff3418cbd6":[2,0,0,16], +"axoverlay_8h.html#a63b90552971c0a0e467093ff3418cbd6a11f43c73718917f1305588ce9bb9461a":[2,0,0,16,3], +"axoverlay_8h.html#a63b90552971c0a0e467093ff3418cbd6a24f2d5da13ccea3f24c9285daa3d5806":[2,0,0,16,0], +"axoverlay_8h.html#a63b90552971c0a0e467093ff3418cbd6a5c0fd09e24c9823121befe7f02c9d9a6":[2,0,0,16,2], +"axoverlay_8h.html#a63b90552971c0a0e467093ff3418cbd6ae4321f158a3ce91d40e9dd2533011fe9":[2,0,0,16,1], +"axoverlay_8h.html#a69680654ad920dd63825debf80db1835":[2,0,0,12], +"axoverlay_8h.html#a79534991a1ffa36aa47493e703795f60":[2,0,0,19], +"axoverlay_8h.html#a79534991a1ffa36aa47493e703795f60a1fb9c962db18f76ff0c572a8d117b58d":[2,0,0,19,4], +"axoverlay_8h.html#a79534991a1ffa36aa47493e703795f60a6337608f3d6a7faea5ad26ca5b6152a3":[2,0,0,19,5], +"axoverlay_8h.html#a79534991a1ffa36aa47493e703795f60a6a6b9b1ce8a9709b91a1bd177b42b4ac":[2,0,0,19,1], +"axoverlay_8h.html#a79534991a1ffa36aa47493e703795f60a8a8d4f5e31404d48fc1cbd0b8670c966":[2,0,0,19,0], +"axoverlay_8h.html#a79534991a1ffa36aa47493e703795f60aeca66fbd45e07d9e0b72428483c05ea0":[2,0,0,19,2], +"axoverlay_8h.html#a79534991a1ffa36aa47493e703795f60afcb5c81e97977cc40382446a21eb2aa3":[2,0,0,19,3], +"axoverlay_8h.html#a837c18c9e89496b8e59c23c9320439aa":[2,0,0,13], +"axoverlay_8h.html#a9039e46539a8ed3e23754e9261b0e793":[2,0,0,26], +"axoverlay_8h.html#a95a791a9f63d0c5bad2d403b0d8c7ba3":[2,0,0,21], +"axoverlay_8h.html#a99b3dcd1441c0c3b28aab30680146dbf":[2,0,0,27], +"axoverlay_8h.html#aa8ef90e6f67e0523c50f70e195b923e9":[2,0,0,41], +"axoverlay_8h.html#aa9f8d7e0652223e43d0d80b35fb1b017":[2,0,0,14], +"axoverlay_8h.html#aa9f8d7e0652223e43d0d80b35fb1b017a364bf6dd30ca9c71e5e3cb711befd6fc":[2,0,0,14,1], +"axoverlay_8h.html#aa9f8d7e0652223e43d0d80b35fb1b017a8d67dcee72751fc14aa2d1bce7600efe":[2,0,0,14,0], +"axoverlay_8h.html#aadef178b4a74eb601c095fcb9a0875b3":[2,0,0,37], +"axoverlay_8h.html#aba18305ff424cfe2dd8c88974da6c700":[2,0,0,24], +"axoverlay_8h.html#abcee514e8d556934e857fd594a471865":[2,0,0,28], +"axoverlay_8h.html#ac73bea732951f6bdcead8ee248b35b0a":[2,0,0,32], +"axoverlay_8h.html#ac95c0f4c11509dfae12707aff79eedb8":[2,0,0,38], +"axoverlay_8h.html#acd597540ddc493c361cf49d425527c9b":[2,0,0,10], +"axoverlay_8h.html#ad150141c6187fb915ea263c9824e2114":[2,0,0,31], +"axoverlay_8h.html#ad1ba0477e427afaa3c42637c442ffc21":[2,0,0,17], +"axoverlay_8h.html#ad1ba0477e427afaa3c42637c442ffc21a2c94311e80ff3f31edf89f0e402d8851":[2,0,0,17,4], +"axoverlay_8h.html#ad1ba0477e427afaa3c42637c442ffc21a51424a18510a24d1ba8874a8b5075845":[2,0,0,17,3], +"axoverlay_8h.html#ad1ba0477e427afaa3c42637c442ffc21a64ae96167826e297a008237b342a1474":[2,0,0,17,1], +"axoverlay_8h.html#ad1ba0477e427afaa3c42637c442ffc21a786851c992cfe9c3c515620ecbdc9943":[2,0,0,17,0], +"axoverlay_8h.html#ad1ba0477e427afaa3c42637c442ffc21ab6162de2f1b5a2e34b181e67de5b97b5":[2,0,0,17,6], +"axoverlay_8h.html#ad1ba0477e427afaa3c42637c442ffc21abd05ba5ae91988339ab9639fd9ceb624":[2,0,0,17,2], +"axoverlay_8h.html#ad1ba0477e427afaa3c42637c442ffc21ae8da7833aa75886b72719fda5c3355e2":[2,0,0,17,5], +"axoverlay_8h.html#ad484b29c95580bfacf74efbc7e4848d6":[2,0,0,8], +"axoverlay_8h.html#ade3ed3d327deba171eb679416a28af6e":[2,0,0,36], +"axoverlay_8h.html#ae39d6ff9a957a1da895c494104161b4c":[2,0,0,5], +"axoverlay_8h.html#aef2581df55e0b9adef9fcb795336c902":[2,0,0,22], +"axoverlay_8h.html#af78f0b190338d56da5c6491dfff596d3":[2,0,0,34], +"axoverlay_8h.html#af8cda33355d9b1345b4bc97836324a6e":[2,0,0,11], +"axoverlay_8h.html#af9c9390f00f72ac40793d35f0e4392fd":[2,0,0,35], +"axoverlay_8h_source.html":[2,0,0], +"axoverlaypage.html":[0], +"classes.html":[1,1], +"files.html":[2,0], +"functions.html":[1,2,0], +"functions_vars.html":[1,2,1], +"globals.html":[2,1,0], +"globals_defs.html":[2,1,5], +"globals_enum.html":[2,1,3], +"globals_eval.html":[2,1,4], +"globals_func.html":[2,1,1], +"globals_type.html":[2,1,2], "index.html":[], -"index.html":[0], "pages.html":[], -"structaxoverlay__overlay__data.html":[2,0,0], -"structaxoverlay__overlay__data.html#a0b35d31c6fb144ae4696c52e5be668d1":[2,0,0,0], -"structaxoverlay__overlay__data.html#a0d4653fec3b723a920cd2e73eb80a728":[2,0,0,4], -"structaxoverlay__overlay__data.html#a22fa3d552594bb3849a18616d6ccfdcb":[2,0,0,6], -"structaxoverlay__overlay__data.html#a24bfa7a9ed82734edc160a57f1ed49fe":[2,0,0,5], -"structaxoverlay__overlay__data.html#a2aa5d3212f383f449e3974287761d97f":[2,0,0,3], -"structaxoverlay__overlay__data.html#a46ba082e753d485adab2336ae52b5582":[2,0,0,2], -"structaxoverlay__overlay__data.html#a9b62dfea0dbb98102fdcc4544e5a6013":[2,0,0,7], -"structaxoverlay__overlay__data.html#a9fc5a3ae54574aa9a104c46f11d9c19b":[2,0,0,8], -"structaxoverlay__overlay__data.html#af592d09a5eabb50821c18fec1627a5b4":[2,0,0,1], -"structaxoverlay__palette__color.html":[2,0,1], -"structaxoverlay__palette__color.html#a0802a40275a8ebe7dcfad6b02cac648d":[2,0,1,1], -"structaxoverlay__palette__color.html#a31adfa586bd42b64bc7b3e325cfcb577":[2,0,1,2], -"structaxoverlay__palette__color.html#a5ec6048413456ac23a8ff5e727cb141e":[2,0,1,3], -"structaxoverlay__palette__color.html#a7478e3688c1a8fe2b1fd60a6b1d3880f":[2,0,1,4], -"structaxoverlay__palette__color.html#aa1657a8276538422d872b40c7f87a69e":[2,0,1,0], -"structaxoverlay__settings.html":[2,0,2], -"structaxoverlay__settings.html#a20c62ceccae952713b7a503cec0c3cb6":[2,0,2,1], -"structaxoverlay__settings.html#a2a05cf0530b75e544c405f7ac2815d6f":[2,0,2,2], -"structaxoverlay__settings.html#a3af89cc57be8e494a8ef473494f71bea":[2,0,2,3], -"structaxoverlay__settings.html#a7046259754ff077dc8fd06e696f3f4f8":[2,0,2,0], -"structaxoverlay__stream__data.html":[2,0,3], -"structaxoverlay__stream__data.html#a0e628c5b303daa0606b40e1ad8185d96":[2,0,3,5], -"structaxoverlay__stream__data.html#a347956f69ef6dd2d9999ed96c213870e":[2,0,3,2], -"structaxoverlay__stream__data.html#a5ca0ccfbf0a3ee8d702e8f36571d7e84":[2,0,3,4], -"structaxoverlay__stream__data.html#a8e8231382e1cdfcb1b18181d6b449b0e":[2,0,3,3], -"structaxoverlay__stream__data.html#a9a23ef4cefd4dc279ded96480d2daf93":[2,0,3,6], -"structaxoverlay__stream__data.html#aa940c45118672a025580471a37f271d3":[2,0,3,1], -"structaxoverlay__stream__data.html#ab53ec280815a284af8bacec918be5156":[2,0,3,0] +"structaxoverlay__overlay__data.html":[1,0,0], +"structaxoverlay__overlay__data.html#a0b35d31c6fb144ae4696c52e5be668d1":[1,0,0,0], +"structaxoverlay__overlay__data.html#a0d4653fec3b723a920cd2e73eb80a728":[1,0,0,4], +"structaxoverlay__overlay__data.html#a22fa3d552594bb3849a18616d6ccfdcb":[1,0,0,6], +"structaxoverlay__overlay__data.html#a24bfa7a9ed82734edc160a57f1ed49fe":[1,0,0,5], +"structaxoverlay__overlay__data.html#a2aa5d3212f383f449e3974287761d97f":[1,0,0,3], +"structaxoverlay__overlay__data.html#a46ba082e753d485adab2336ae52b5582":[1,0,0,2], +"structaxoverlay__overlay__data.html#a9b62dfea0dbb98102fdcc4544e5a6013":[1,0,0,7], +"structaxoverlay__overlay__data.html#a9fc5a3ae54574aa9a104c46f11d9c19b":[1,0,0,8], +"structaxoverlay__overlay__data.html#af592d09a5eabb50821c18fec1627a5b4":[1,0,0,1], +"structaxoverlay__palette__color.html":[1,0,1], +"structaxoverlay__palette__color.html#a0802a40275a8ebe7dcfad6b02cac648d":[1,0,1,1], +"structaxoverlay__palette__color.html#a31adfa586bd42b64bc7b3e325cfcb577":[1,0,1,2], +"structaxoverlay__palette__color.html#a5ec6048413456ac23a8ff5e727cb141e":[1,0,1,3], +"structaxoverlay__palette__color.html#a7478e3688c1a8fe2b1fd60a6b1d3880f":[1,0,1,4], +"structaxoverlay__palette__color.html#aa1657a8276538422d872b40c7f87a69e":[1,0,1,0], +"structaxoverlay__settings.html":[1,0,2], +"structaxoverlay__settings.html#a20c62ceccae952713b7a503cec0c3cb6":[1,0,2,1], +"structaxoverlay__settings.html#a2a05cf0530b75e544c405f7ac2815d6f":[1,0,2,2], +"structaxoverlay__settings.html#a3af89cc57be8e494a8ef473494f71bea":[1,0,2,3], +"structaxoverlay__settings.html#a7046259754ff077dc8fd06e696f3f4f8":[1,0,2,0], +"structaxoverlay__stream__data.html":[1,0,3], +"structaxoverlay__stream__data.html#a0e628c5b303daa0606b40e1ad8185d96":[1,0,3,5], +"structaxoverlay__stream__data.html#a347956f69ef6dd2d9999ed96c213870e":[1,0,3,2], +"structaxoverlay__stream__data.html#a5ca0ccfbf0a3ee8d702e8f36571d7e84":[1,0,3,4], +"structaxoverlay__stream__data.html#a8e8231382e1cdfcb1b18181d6b449b0e":[1,0,3,3], +"structaxoverlay__stream__data.html#a9a23ef4cefd4dc279ded96480d2daf93":[1,0,3,6], +"structaxoverlay__stream__data.html#aa940c45118672a025580471a37f271d3":[1,0,3,1], +"structaxoverlay__stream__data.html#ab53ec280815a284af8bacec918be5156":[1,0,3,0] }; diff --git a/docs/api/src/api/axoverlay/html/pages.html b/docs/api/src/api/axoverlay/html/pages.html index 935dc0b5..1b428a16 100644 --- a/docs/api/src/api/axoverlay/html/pages.html +++ b/docs/api/src/api/axoverlay/html/pages.html @@ -87,7 +87,7 @@
    Here is a list of all related documentation pages:
    diff --git a/docs/api/src/api/axoverlay/html/search/all_0.js b/docs/api/src/api/axoverlay/html/search/all_0.js index e3859e5d..2cd9956d 100644 --- a/docs/api/src/api/axoverlay/html/search/all_0.js +++ b/docs/api/src/api/axoverlay/html/search/all_0.js @@ -23,6 +23,7 @@ var searchData= ['axoverlay_5fcustom_5fsource',['AXOVERLAY_CUSTOM_SOURCE',['../axoverlay_8h.html#a3d9bc98f846c4fa067a5d32e7c86e60cac88c862b0d51cf8b4edf7ec7945dec9a',1,'axoverlay.h']]], ['axoverlay_5fdefault_5fcamera_5fid',['AXOVERLAY_DEFAULT_CAMERA_ID',['../axoverlay_8h.html#a1c41cacf9e4a49827169a0e42d032bf0',1,'axoverlay.h']]], ['axoverlay_5fdestroy_5foverlay',['axoverlay_destroy_overlay',['../axoverlay_8h.html#aef2581df55e0b9adef9fcb795336c902',1,'axoverlay.h']]], + ['axoverlay_5fenable_5fcpu_5fmem_5fsync',['axoverlay_enable_cpu_mem_sync',['../axoverlay_8h.html#a4f313b61885df524cefe3242527ef1cd',1,'axoverlay.h']]], ['axoverlay_5ferror_5fbackend',['AXOVERLAY_ERROR_BACKEND',['../axoverlay_8h.html#ad1ba0477e427afaa3c42637c442ffc21ab6162de2f1b5a2e34b181e67de5b97b5',1,'axoverlay.h']]], ['axoverlay_5ferror_5fcode',['axoverlay_error_code',['../axoverlay_8h.html#ad1ba0477e427afaa3c42637c442ffc21',1,'axoverlay.h']]], ['axoverlay_5ferror_5fgeneric',['AXOVERLAY_ERROR_GENERIC',['../axoverlay_8h.html#ad1ba0477e427afaa3c42637c442ffc21a51424a18510a24d1ba8874a8b5075845',1,'axoverlay.h']]], @@ -48,17 +49,23 @@ var searchData= ['axoverlay_5fredraw',['axoverlay_redraw',['../axoverlay_8h.html#ac73bea732951f6bdcead8ee248b35b0a',1,'axoverlay.h']]], ['axoverlay_5freload_5fstreams',['axoverlay_reload_streams',['../axoverlay_8h.html#a05e917b3d92ca3b5e38dd074aeb7d80c',1,'axoverlay.h']]], ['axoverlay_5frender_5ffunction',['axoverlay_render_function',['../axoverlay_8h.html#af8cda33355d9b1345b4bc97836324a6e',1,'axoverlay.h']]], + ['axoverlay_5fset_5fadjustment_5fcallback',['axoverlay_set_adjustment_callback',['../axoverlay_8h.html#af78f0b190338d56da5c6491dfff596d3',1,'axoverlay.h']]], + ['axoverlay_5fset_5fbackend',['axoverlay_set_backend',['../axoverlay_8h.html#af9c9390f00f72ac40793d35f0e4392fd',1,'axoverlay.h']]], ['axoverlay_5fset_5foverlay_5fposition',['axoverlay_set_overlay_position',['../axoverlay_8h.html#ade3ed3d327deba171eb679416a28af6e',1,'axoverlay.h']]], ['axoverlay_5fset_5foverlay_5fsize',['axoverlay_set_overlay_size',['../axoverlay_8h.html#aadef178b4a74eb601c095fcb9a0875b3',1,'axoverlay.h']]], ['axoverlay_5fset_5fpalette_5fcolor',['axoverlay_set_palette_color',['../axoverlay_8h.html#ac95c0f4c11509dfae12707aff79eedb8',1,'axoverlay.h']]], + ['axoverlay_5fset_5frender_5fcallback',['axoverlay_set_render_callback',['../axoverlay_8h.html#a41f1b95d6f4a76bda3795196bee97a2c',1,'axoverlay.h']]], + ['axoverlay_5fset_5fstream_5fselect_5fcallback',['axoverlay_set_stream_select_callback',['../axoverlay_8h.html#a14986c555fe904ad27e9cee09c5793b1',1,'axoverlay.h']]], + ['axoverlay_5fset_5fsynced_5frender_5fcallback',['axoverlay_set_synced_render_callback',['../axoverlay_8h.html#aa8ef90e6f67e0523c50f70e195b923e9',1,'axoverlay.h']]], ['axoverlay_5fsettings',['axoverlay_settings',['../structaxoverlay__settings.html',1,'']]], ['axoverlay_5fstream_5fdata',['axoverlay_stream_data',['../structaxoverlay__stream__data.html',1,'']]], ['axoverlay_5fstream_5fselect_5ffunction',['axoverlay_stream_select_function',['../axoverlay_8h.html#a69680654ad920dd63825debf80db1835',1,'axoverlay.h']]], + ['axoverlay_5fsynced_5frender_5ffunction',['axoverlay_synced_render_function',['../axoverlay_8h.html#a837c18c9e89496b8e59c23c9320439aa',1,'axoverlay.h']]], ['axoverlay_5ftop_5fleft',['AXOVERLAY_TOP_LEFT',['../axoverlay_8h.html#a3d9bc98f846c4fa067a5d32e7c86e60ca9d75b57391dd41ef324a2f9a8eb3fd0f',1,'axoverlay.h']]], ['axoverlay_5ftop_5fright',['AXOVERLAY_TOP_RIGHT',['../axoverlay_8h.html#a3d9bc98f846c4fa067a5d32e7c86e60ca4e2e8dff710303da53f9984e5d6d2d2d',1,'axoverlay.h']]], ['axoverlay_5fz_5fprio_5fhigh',['AXOVERLAY_Z_PRIO_HIGH',['../axoverlay_8h.html#a0479f50dd4fab27a3e2812e2f9c33ecf',1,'axoverlay.h']]], ['axoverlay_5fz_5fprio_5flow',['AXOVERLAY_Z_PRIO_LOW',['../axoverlay_8h.html#a51fd42bb071d82e3973c86a10a8fe8ba',1,'axoverlay.h']]], ['axoverlay_5fz_5fprio_5fmedium',['AXOVERLAY_Z_PRIO_MEDIUM',['../axoverlay_8h.html#ad484b29c95580bfacf74efbc7e4848d6',1,'axoverlay.h']]], ['axoverlay_5fz_5fprio_5fvery_5fhigh',['AXOVERLAY_Z_PRIO_VERY_HIGH',['../axoverlay_8h.html#a5fd4ab19e72943126ce728ba5eed79df',1,'axoverlay.h']]], - ['axoverlay_20c_20api',['Axoverlay C API',['../axoverlaypage.html',1,'']]] + ['axoverlay_20c_20api_20version_201_2e0',['Axoverlay C API version 1.0',['../axoverlaypage.html',1,'']]] ]; diff --git a/docs/api/src/api/axoverlay/html/search/all_3.js b/docs/api/src/api/axoverlay/html/search/all_3.js index 1983e651..fa26134a 100644 --- a/docs/api/src/api/axoverlay/html/search/all_3.js +++ b/docs/api/src/api/axoverlay/html/search/all_3.js @@ -1,4 +1,4 @@ var searchData= [ - ['documentation',['Documentation',['../index.html',1,'']]] + ['green',['green',['../structaxoverlay__palette__color.html#a31adfa586bd42b64bc7b3e325cfcb577',1,'axoverlay_palette_color']]] ]; diff --git a/docs/api/src/api/axoverlay/html/search/all_4.js b/docs/api/src/api/axoverlay/html/search/all_4.js index fa26134a..65171f59 100644 --- a/docs/api/src/api/axoverlay/html/search/all_4.js +++ b/docs/api/src/api/axoverlay/html/search/all_4.js @@ -1,4 +1,4 @@ var searchData= [ - ['green',['green',['../structaxoverlay__palette__color.html#a31adfa586bd42b64bc7b3e325cfcb577',1,'axoverlay_palette_color']]] + ['height',['height',['../structaxoverlay__stream__data.html#aa940c45118672a025580471a37f271d3',1,'axoverlay_stream_data::height()'],['../structaxoverlay__overlay__data.html#a46ba082e753d485adab2336ae52b5582',1,'axoverlay_overlay_data::height()']]] ]; diff --git a/docs/api/src/api/axoverlay/html/search/all_5.js b/docs/api/src/api/axoverlay/html/search/all_5.js index 65171f59..1332b05c 100644 --- a/docs/api/src/api/axoverlay/html/search/all_5.js +++ b/docs/api/src/api/axoverlay/html/search/all_5.js @@ -1,4 +1,5 @@ var searchData= [ - ['height',['height',['../structaxoverlay__stream__data.html#aa940c45118672a025580471a37f271d3',1,'axoverlay_stream_data::height()'],['../structaxoverlay__overlay__data.html#a46ba082e753d485adab2336ae52b5582',1,'axoverlay_overlay_data::height()']]] + ['id',['id',['../structaxoverlay__stream__data.html#a347956f69ef6dd2d9999ed96c213870e',1,'axoverlay_stream_data']]], + ['is_5fmirrored',['is_mirrored',['../structaxoverlay__stream__data.html#a8e8231382e1cdfcb1b18181d6b449b0e',1,'axoverlay_stream_data']]] ]; diff --git a/docs/api/src/api/axoverlay/html/search/all_6.js b/docs/api/src/api/axoverlay/html/search/all_6.js index 1332b05c..c08424f3 100644 --- a/docs/api/src/api/axoverlay/html/search/all_6.js +++ b/docs/api/src/api/axoverlay/html/search/all_6.js @@ -1,5 +1,5 @@ var searchData= [ - ['id',['id',['../structaxoverlay__stream__data.html#a347956f69ef6dd2d9999ed96c213870e',1,'axoverlay_stream_data']]], - ['is_5fmirrored',['is_mirrored',['../structaxoverlay__stream__data.html#a8e8231382e1cdfcb1b18181d6b449b0e',1,'axoverlay_stream_data']]] + ['pixelate',['pixelate',['../structaxoverlay__palette__color.html#a5ec6048413456ac23a8ff5e727cb141e',1,'axoverlay_palette_color']]], + ['postype',['postype',['../structaxoverlay__overlay__data.html#a2aa5d3212f383f449e3974287761d97f',1,'axoverlay_overlay_data']]] ]; diff --git a/docs/api/src/api/axoverlay/html/search/all_7.js b/docs/api/src/api/axoverlay/html/search/all_7.js index c08424f3..1d55c2a8 100644 --- a/docs/api/src/api/axoverlay/html/search/all_7.js +++ b/docs/api/src/api/axoverlay/html/search/all_7.js @@ -1,5 +1,6 @@ var searchData= [ - ['pixelate',['pixelate',['../structaxoverlay__palette__color.html#a5ec6048413456ac23a8ff5e727cb141e',1,'axoverlay_palette_color']]], - ['postype',['postype',['../structaxoverlay__overlay__data.html#a2aa5d3212f383f449e3974287761d97f',1,'axoverlay_overlay_data']]] + ['red',['red',['../structaxoverlay__palette__color.html#a7478e3688c1a8fe2b1fd60a6b1d3880f',1,'axoverlay_palette_color']]], + ['render_5fcallback',['render_callback',['../structaxoverlay__settings.html#a2a05cf0530b75e544c405f7ac2815d6f',1,'axoverlay_settings']]], + ['rotation',['rotation',['../structaxoverlay__stream__data.html#a5ca0ccfbf0a3ee8d702e8f36571d7e84',1,'axoverlay_stream_data']]] ]; diff --git a/docs/api/src/api/axoverlay/html/search/all_8.js b/docs/api/src/api/axoverlay/html/search/all_8.js index 1d55c2a8..3e4af52d 100644 --- a/docs/api/src/api/axoverlay/html/search/all_8.js +++ b/docs/api/src/api/axoverlay/html/search/all_8.js @@ -1,6 +1,5 @@ var searchData= [ - ['red',['red',['../structaxoverlay__palette__color.html#a7478e3688c1a8fe2b1fd60a6b1d3880f',1,'axoverlay_palette_color']]], - ['render_5fcallback',['render_callback',['../structaxoverlay__settings.html#a2a05cf0530b75e544c405f7ac2815d6f',1,'axoverlay_settings']]], - ['rotation',['rotation',['../structaxoverlay__stream__data.html#a5ca0ccfbf0a3ee8d702e8f36571d7e84',1,'axoverlay_stream_data']]] + ['scale_5fto_5fstream',['scale_to_stream',['../structaxoverlay__overlay__data.html#a0d4653fec3b723a920cd2e73eb80a728',1,'axoverlay_overlay_data']]], + ['select_5fcallback',['select_callback',['../structaxoverlay__settings.html#a3af89cc57be8e494a8ef473494f71bea',1,'axoverlay_settings']]] ]; diff --git a/docs/api/src/api/axoverlay/html/search/all_9.js b/docs/api/src/api/axoverlay/html/search/all_9.js index 3e4af52d..1707ea90 100644 --- a/docs/api/src/api/axoverlay/html/search/all_9.js +++ b/docs/api/src/api/axoverlay/html/search/all_9.js @@ -1,5 +1,4 @@ var searchData= [ - ['scale_5fto_5fstream',['scale_to_stream',['../structaxoverlay__overlay__data.html#a0d4653fec3b723a920cd2e73eb80a728',1,'axoverlay_overlay_data']]], - ['select_5fcallback',['select_callback',['../structaxoverlay__settings.html#a3af89cc57be8e494a8ef473494f71bea',1,'axoverlay_settings']]] + ['width',['width',['../structaxoverlay__stream__data.html#a9a23ef4cefd4dc279ded96480d2daf93',1,'axoverlay_stream_data::width()'],['../structaxoverlay__overlay__data.html#a24bfa7a9ed82734edc160a57f1ed49fe',1,'axoverlay_overlay_data::width()']]] ]; diff --git a/docs/api/src/api/axoverlay/html/search/all_a.js b/docs/api/src/api/axoverlay/html/search/all_a.js index 1707ea90..c0b1fbeb 100644 --- a/docs/api/src/api/axoverlay/html/search/all_a.js +++ b/docs/api/src/api/axoverlay/html/search/all_a.js @@ -1,4 +1,4 @@ var searchData= [ - ['width',['width',['../structaxoverlay__stream__data.html#a9a23ef4cefd4dc279ded96480d2daf93',1,'axoverlay_stream_data::width()'],['../structaxoverlay__overlay__data.html#a24bfa7a9ed82734edc160a57f1ed49fe',1,'axoverlay_overlay_data::width()']]] + ['x',['x',['../structaxoverlay__overlay__data.html#a22fa3d552594bb3849a18616d6ccfdcb',1,'axoverlay_overlay_data']]] ]; diff --git a/docs/api/src/api/axoverlay/html/search/all_b.js b/docs/api/src/api/axoverlay/html/search/all_b.js index c0b1fbeb..3673fc95 100644 --- a/docs/api/src/api/axoverlay/html/search/all_b.js +++ b/docs/api/src/api/axoverlay/html/search/all_b.js @@ -1,4 +1,4 @@ var searchData= [ - ['x',['x',['../structaxoverlay__overlay__data.html#a22fa3d552594bb3849a18616d6ccfdcb',1,'axoverlay_overlay_data']]] + ['y',['y',['../structaxoverlay__overlay__data.html#a9b62dfea0dbb98102fdcc4544e5a6013',1,'axoverlay_overlay_data']]] ]; diff --git a/docs/api/src/api/axoverlay/html/search/all_c.js b/docs/api/src/api/axoverlay/html/search/all_c.js index 3673fc95..8773a17f 100644 --- a/docs/api/src/api/axoverlay/html/search/all_c.js +++ b/docs/api/src/api/axoverlay/html/search/all_c.js @@ -1,4 +1,4 @@ var searchData= [ - ['y',['y',['../structaxoverlay__overlay__data.html#a9b62dfea0dbb98102fdcc4544e5a6013',1,'axoverlay_overlay_data']]] + ['z_5fpriority',['z_priority',['../structaxoverlay__overlay__data.html#a9fc5a3ae54574aa9a104c46f11d9c19b',1,'axoverlay_overlay_data']]] ]; diff --git a/docs/api/src/api/axoverlay/html/search/all_d.html b/docs/api/src/api/axoverlay/html/search/all_d.html deleted file mode 100644 index 9986c9cb..00000000 --- a/docs/api/src/api/axoverlay/html/search/all_d.html +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/docs/api/src/api/axoverlay/html/search/all_d.js b/docs/api/src/api/axoverlay/html/search/all_d.js deleted file mode 100644 index 8773a17f..00000000 --- a/docs/api/src/api/axoverlay/html/search/all_d.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['z_5fpriority',['z_priority',['../structaxoverlay__overlay__data.html#a9fc5a3ae54574aa9a104c46f11d9c19b',1,'axoverlay_overlay_data']]] -]; diff --git a/docs/api/src/api/axoverlay/html/search/functions_0.js b/docs/api/src/api/axoverlay/html/search/functions_0.js index 552139dc..83dfdd63 100644 --- a/docs/api/src/api/axoverlay/html/search/functions_0.js +++ b/docs/api/src/api/axoverlay/html/search/functions_0.js @@ -3,6 +3,7 @@ var searchData= ['axoverlay_5fcleanup',['axoverlay_cleanup',['../axoverlay_8h.html#a3510c0ea4e04846864603505b3994cf5',1,'axoverlay.h']]], ['axoverlay_5fcreate_5foverlay',['axoverlay_create_overlay',['../axoverlay_8h.html#a95a791a9f63d0c5bad2d403b0d8c7ba3',1,'axoverlay.h']]], ['axoverlay_5fdestroy_5foverlay',['axoverlay_destroy_overlay',['../axoverlay_8h.html#aef2581df55e0b9adef9fcb795336c902',1,'axoverlay.h']]], + ['axoverlay_5fenable_5fcpu_5fmem_5fsync',['axoverlay_enable_cpu_mem_sync',['../axoverlay_8h.html#a4f313b61885df524cefe3242527ef1cd',1,'axoverlay.h']]], ['axoverlay_5fget_5fmax_5fresolution_5fheight',['axoverlay_get_max_resolution_height',['../axoverlay_8h.html#aba18305ff424cfe2dd8c88974da6c700',1,'axoverlay.h']]], ['axoverlay_5fget_5fmax_5fresolution_5fwidth',['axoverlay_get_max_resolution_width',['../axoverlay_8h.html#a2081f1e63d1ccefe40e36b7328d07b05',1,'axoverlay.h']]], ['axoverlay_5fget_5fnumber_5fof_5fpalette_5fcolors',['axoverlay_get_number_of_palette_colors',['../axoverlay_8h.html#a9039e46539a8ed3e23754e9261b0e793',1,'axoverlay.h']]], @@ -13,7 +14,12 @@ var searchData= ['axoverlay_5fis_5fbackend_5fsupported',['axoverlay_is_backend_supported',['../axoverlay_8h.html#ad150141c6187fb915ea263c9824e2114',1,'axoverlay.h']]], ['axoverlay_5fredraw',['axoverlay_redraw',['../axoverlay_8h.html#ac73bea732951f6bdcead8ee248b35b0a',1,'axoverlay.h']]], ['axoverlay_5freload_5fstreams',['axoverlay_reload_streams',['../axoverlay_8h.html#a05e917b3d92ca3b5e38dd074aeb7d80c',1,'axoverlay.h']]], + ['axoverlay_5fset_5fadjustment_5fcallback',['axoverlay_set_adjustment_callback',['../axoverlay_8h.html#af78f0b190338d56da5c6491dfff596d3',1,'axoverlay.h']]], + ['axoverlay_5fset_5fbackend',['axoverlay_set_backend',['../axoverlay_8h.html#af9c9390f00f72ac40793d35f0e4392fd',1,'axoverlay.h']]], ['axoverlay_5fset_5foverlay_5fposition',['axoverlay_set_overlay_position',['../axoverlay_8h.html#ade3ed3d327deba171eb679416a28af6e',1,'axoverlay.h']]], ['axoverlay_5fset_5foverlay_5fsize',['axoverlay_set_overlay_size',['../axoverlay_8h.html#aadef178b4a74eb601c095fcb9a0875b3',1,'axoverlay.h']]], - ['axoverlay_5fset_5fpalette_5fcolor',['axoverlay_set_palette_color',['../axoverlay_8h.html#ac95c0f4c11509dfae12707aff79eedb8',1,'axoverlay.h']]] + ['axoverlay_5fset_5fpalette_5fcolor',['axoverlay_set_palette_color',['../axoverlay_8h.html#ac95c0f4c11509dfae12707aff79eedb8',1,'axoverlay.h']]], + ['axoverlay_5fset_5frender_5fcallback',['axoverlay_set_render_callback',['../axoverlay_8h.html#a41f1b95d6f4a76bda3795196bee97a2c',1,'axoverlay.h']]], + ['axoverlay_5fset_5fstream_5fselect_5fcallback',['axoverlay_set_stream_select_callback',['../axoverlay_8h.html#a14986c555fe904ad27e9cee09c5793b1',1,'axoverlay.h']]], + ['axoverlay_5fset_5fsynced_5frender_5fcallback',['axoverlay_set_synced_render_callback',['../axoverlay_8h.html#aa8ef90e6f67e0523c50f70e195b923e9',1,'axoverlay.h']]] ]; diff --git a/docs/api/src/api/axoverlay/html/search/pages_0.js b/docs/api/src/api/axoverlay/html/search/pages_0.js index c12e83ad..b19988a3 100644 --- a/docs/api/src/api/axoverlay/html/search/pages_0.js +++ b/docs/api/src/api/axoverlay/html/search/pages_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['axoverlay_20c_20api',['Axoverlay C API',['../axoverlaypage.html',1,'']]] + ['axoverlay_20c_20api_20version_201_2e0',['Axoverlay C API version 1.0',['../axoverlaypage.html',1,'']]] ]; diff --git a/docs/api/src/api/axoverlay/html/search/pages_1.html b/docs/api/src/api/axoverlay/html/search/pages_1.html deleted file mode 100644 index aedb14ee..00000000 --- a/docs/api/src/api/axoverlay/html/search/pages_1.html +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/docs/api/src/api/axoverlay/html/search/pages_1.js b/docs/api/src/api/axoverlay/html/search/pages_1.js deleted file mode 100644 index 1983e651..00000000 --- a/docs/api/src/api/axoverlay/html/search/pages_1.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['documentation',['Documentation',['../index.html',1,'']]] -]; diff --git a/docs/api/src/api/axoverlay/html/search/searchdata.js b/docs/api/src/api/axoverlay/html/search/searchdata.js index 05dd6291..17e25d86 100644 --- a/docs/api/src/api/axoverlay/html/search/searchdata.js +++ b/docs/api/src/api/axoverlay/html/search/searchdata.js @@ -1,6 +1,6 @@ var indexSectionsWithContent = { - 0: "abcdghiprswxyz", + 0: "abcghiprswxyz", 1: "a", 2: "a", 3: "a", @@ -9,7 +9,7 @@ var indexSectionsWithContent = 6: "a", 7: "a", 8: "a", - 9: "ad" + 9: "a" }; var indexSectionNames = diff --git a/docs/api/src/api/axoverlay/html/search/typedefs_0.js b/docs/api/src/api/axoverlay/html/search/typedefs_0.js index 85c10ad2..467285ed 100644 --- a/docs/api/src/api/axoverlay/html/search/typedefs_0.js +++ b/docs/api/src/api/axoverlay/html/search/typedefs_0.js @@ -2,5 +2,6 @@ var searchData= [ ['axoverlay_5fadjustment_5ffunction',['axoverlay_adjustment_function',['../axoverlay_8h.html#acd597540ddc493c361cf49d425527c9b',1,'axoverlay.h']]], ['axoverlay_5frender_5ffunction',['axoverlay_render_function',['../axoverlay_8h.html#af8cda33355d9b1345b4bc97836324a6e',1,'axoverlay.h']]], - ['axoverlay_5fstream_5fselect_5ffunction',['axoverlay_stream_select_function',['../axoverlay_8h.html#a69680654ad920dd63825debf80db1835',1,'axoverlay.h']]] + ['axoverlay_5fstream_5fselect_5ffunction',['axoverlay_stream_select_function',['../axoverlay_8h.html#a69680654ad920dd63825debf80db1835',1,'axoverlay.h']]], + ['axoverlay_5fsynced_5frender_5ffunction',['axoverlay_synced_render_function',['../axoverlay_8h.html#a837c18c9e89496b8e59c23c9320439aa',1,'axoverlay.h']]] ]; diff --git a/docs/api/src/api/axoverlay/html/structaxoverlay__overlay__data.html b/docs/api/src/api/axoverlay/html/structaxoverlay__overlay__data.html index a5d91c78..91bda6db 100644 --- a/docs/api/src/api/axoverlay/html/structaxoverlay__overlay__data.html +++ b/docs/api/src/api/axoverlay/html/structaxoverlay__overlay__data.html @@ -250,7 +250,7 @@

    axoverlay.h +
  • axoverlay.h
diff --git a/docs/api/src/api/axoverlay/html/structaxoverlay__palette__color.html b/docs/api/src/api/axoverlay/html/structaxoverlay__palette__color.html index f1e036a9..2011ac7c 100644 --- a/docs/api/src/api/axoverlay/html/structaxoverlay__palette__color.html +++ b/docs/api/src/api/axoverlay/html/structaxoverlay__palette__color.html @@ -182,7 +182,7 @@

axoverlay.h +
  • axoverlay.h
  • diff --git a/docs/api/src/api/axoverlay/html/structaxoverlay__settings.html b/docs/api/src/api/axoverlay/html/structaxoverlay__settings.html index aa94aa9f..6d074568 100644 --- a/docs/api/src/api/axoverlay/html/structaxoverlay__settings.html +++ b/docs/api/src/api/axoverlay/html/structaxoverlay__settings.html @@ -152,7 +152,7 @@

    -

    A function called when an overlay needs to be drawn. It can be called manually via axoverlay_redraw() but is also called from the system, for example when a new stream appears. Not nullable.

    +

    A function called when an overlay needs to be drawn. It can be called manually via axoverlay_redraw() but is also called from the system, for example when a new stream appears. Nullable with condition. Either this one or the render_callback_ts has to be set to non-NULL.

    @@ -172,7 +172,7 @@

    axoverlay.h +
  • axoverlay.h
  • diff --git a/docs/api/src/api/axoverlay/html/structaxoverlay__stream__data.html b/docs/api/src/api/axoverlay/html/structaxoverlay__stream__data.html index 489f1385..e9a447de 100644 --- a/docs/api/src/api/axoverlay/html/structaxoverlay__stream__data.html +++ b/docs/api/src/api/axoverlay/html/structaxoverlay__stream__data.html @@ -202,7 +202,7 @@

    axoverlay.h +
  • axoverlay.h
  • diff --git a/docs/api/src/api/larod/html/annotated.html b/docs/api/src/api/larod/html/annotated.html index 13ab395b..1d58d89a 100644 --- a/docs/api/src/api/larod/html/annotated.html +++ b/docs/api/src/api/larod/html/annotated.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/classes.html b/docs/api/src/api/larod/html/classes.html index ee8f471d..9805a2c2 100644 --- a/docs/api/src/api/larod/html/classes.html +++ b/docs/api/src/api/larod/html/classes.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/deprecated.html b/docs/api/src/api/larod/html/deprecated.html index 17f84e01..e7d11db4 100644 --- a/docs/api/src/api/larod/html/deprecated.html +++ b/docs/api/src/api/larod/html/deprecated.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/dir_97aefd0d527b934f1d99a682da8fe6a9.html b/docs/api/src/api/larod/html/dir_97aefd0d527b934f1d99a682da8fe6a9.html index 32242fc3..18c60707 100644 --- a/docs/api/src/api/larod/html/dir_97aefd0d527b934f1d99a682da8fe6a9.html +++ b/docs/api/src/api/larod/html/dir_97aefd0d527b934f1d99a682da8fe6a9.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/files.html b/docs/api/src/api/larod/html/files.html index c04661c5..a53f1701 100644 --- a/docs/api/src/api/larod/html/files.html +++ b/docs/api/src/api/larod/html/files.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/functions.html b/docs/api/src/api/larod/html/functions.html index 56be25d4..c802a2b0 100644 --- a/docs/api/src/api/larod/html/functions.html +++ b/docs/api/src/api/larod/html/functions.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/functions_vars.html b/docs/api/src/api/larod/html/functions_vars.html index 4ee4f01e..99c4e716 100644 --- a/docs/api/src/api/larod/html/functions_vars.html +++ b/docs/api/src/api/larod/html/functions_vars.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/globals.html b/docs/api/src/api/larod/html/globals.html index f68da2dd..2c4b5652 100644 --- a/docs/api/src/api/larod/html/globals.html +++ b/docs/api/src/api/larod/html/globals.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/globals_defs.html b/docs/api/src/api/larod/html/globals_defs.html index 110d2742..7ee85ac5 100644 --- a/docs/api/src/api/larod/html/globals_defs.html +++ b/docs/api/src/api/larod/html/globals_defs.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/globals_enum.html b/docs/api/src/api/larod/html/globals_enum.html index 80ae1b6d..f58e509d 100644 --- a/docs/api/src/api/larod/html/globals_enum.html +++ b/docs/api/src/api/larod/html/globals_enum.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/globals_eval.html b/docs/api/src/api/larod/html/globals_eval.html index 53ea6705..472ea27f 100644 --- a/docs/api/src/api/larod/html/globals_eval.html +++ b/docs/api/src/api/larod/html/globals_eval.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/globals_func.html b/docs/api/src/api/larod/html/globals_func.html index d1eb4e01..40c972bd 100644 --- a/docs/api/src/api/larod/html/globals_func.html +++ b/docs/api/src/api/larod/html/globals_func.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/globals_type.html b/docs/api/src/api/larod/html/globals_type.html index 1e3913e1..a5e2594a 100644 --- a/docs/api/src/api/larod/html/globals_type.html +++ b/docs/api/src/api/larod/html/globals_type.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/index.html b/docs/api/src/api/larod/html/index.html index 1c8a6142..b567fdf4 100644 --- a/docs/api/src/api/larod/html/index.html +++ b/docs/api/src/api/larod/html/index.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/larod_8h.html b/docs/api/src/api/larod/html/larod_8h.html index daa519e3..a9b03534 100644 --- a/docs/api/src/api/larod/html/larod_8h.html +++ b/docs/api/src/api/larod/html/larod_8h.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/larod_8h_source.html b/docs/api/src/api/larod/html/larod_8h_source.html index c603027d..e4060e5b 100644 --- a/docs/api/src/api/larod/html/larod_8h_source.html +++ b/docs/api/src/api/larod/html/larod_8h_source.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_api-changes.html b/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_api-changes.html index 055ba85d..4880d9a3 100644 --- a/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_api-changes.html +++ b/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_api-changes.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_architecture.html b/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_architecture.html index 39d7cb14..7d5c1a5d 100644 --- a/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_architecture.html +++ b/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_architecture.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_dma-buf.html b/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_dma-buf.html index 6e816243..8746b7c3 100644 --- a/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_dma-buf.html +++ b/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_dma-buf.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_how-to-setup-larod-to-use-powerd.html b/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_how-to-setup-larod-to-use-powerd.html index 6e17390f..2c68e323 100644 --- a/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_how-to-setup-larod-to-use-powerd.html +++ b/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_how-to-setup-larod-to-use-powerd.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_introduction-for-app-developers.html b/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_introduction-for-app-developers.html index 116bef34..f8c33ea1 100644 --- a/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_introduction-for-app-developers.html +++ b/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_introduction-for-app-developers.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_larod-client.html b/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_larod-client.html index d74fdda0..2b873d4d 100644 --- a/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_larod-client.html +++ b/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_larod-client.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_model-formats.html b/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_model-formats.html index 159355ee..f6838286 100644 --- a/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_model-formats.html +++ b/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_model-formats.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_nn-inference.html b/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_nn-inference.html index 60dc9210..f7521102 100644 --- a/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_nn-inference.html +++ b/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_nn-inference.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    @@ -182,7 +182,7 @@

    Allocation support

    Tensors allocated using the calls larodAllocModelInputs() and larodAllocModelOutputs() with a model loaded to this backend will have file descriptors that are readable, writable and mappable. Accordingly the tensors will have the fd props LAROD_FD_PROP_READWRITE and LAROD_FD_PROP_MAP set.

    Model compilation and caching

    When a model is loaded on the ARTPEC-8 DLPU it is compiled into a different format native to the accelerator, the .nb format, also referred to NBG. Since this conversion takes a lot of time, sometimes up to several minutes depending on the model, the .nb files are subsequently cached in flash after the compilation is complete. Once a file is cached the corresponding .tflite model will be loaded substantially faster, as the entire compilation step will be skipped.

    -

    The cached NBG files are stored in /var/lib/larod/nbg-cache. This cache storage is limited to 30,000 KiB and 10 files. Whenever a new model file is compiled a new NBG file will be created in this location. If the maximum number of models is exceeded, or if the accumulated size of all the cached models exceeds the storage limit, older models will be removed to make space for the new one.

    +

    The cached NBG files are stored in /var/lib/larod/nbg-cache. This cache storage is limited to 64 MiB and 16 files. Whenever a new model file is compiled a new NBG file will be created in this location. If the maximum number of models is exceeded, or if the accumulated size of all the cached models exceeds the storage limit, older models will be removed to make space for the new one.

    Skipping recompilation of models after flashing a camera

    When a new firmware is flashed onto an Axis camera there will be no cached models. By default this implies that when a model is loaded it will once again have to be compiled, resulting in a long load time. This can be bypassed by placing a previously compiled .nb file corresponding to the desired model into /var/lib/larod/nbg-cache/. If everything works correctly the .nb file will be correctly identified and no compilation should be required. This is a good way to reduce development cycle times.

    NOTE This method of skipping recompiling a model when flashing the firmware assumes that the firmware is the same version as the one that originally compiled the model. There is no guarantee that the .nb format remains the same throughout firmware versions, or that a newer firmware will be backwards compatible with a model compiled on an older firmware.

    diff --git a/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_preprocessing.html b/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_preprocessing.html index 81b58198..2e9dfe9c 100644 --- a/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_preprocessing.html +++ b/docs/api/src/api/larod/html/md__opt_builder-doc_larod_doc_preprocessing.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/md__opt_builder-doc_larod_tools_model-converter_README.html b/docs/api/src/api/larod/html/md__opt_builder-doc_larod_tools_model-converter_README.html index 941e456f..d124b54e 100644 --- a/docs/api/src/api/larod/html/md__opt_builder-doc_larod_tools_model-converter_README.html +++ b/docs/api/src/api/larod/html/md__opt_builder-doc_larod_tools_model-converter_README.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/pages.html b/docs/api/src/api/larod/html/pages.html index 9a0b390a..2edcbe0d 100644 --- a/docs/api/src/api/larod/html/pages.html +++ b/docs/api/src/api/larod/html/pages.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/structlarodError.html b/docs/api/src/api/larod/html/structlarodError.html index 9ffdf9f7..ef1d3079 100644 --- a/docs/api/src/api/larod/html/structlarodError.html +++ b/docs/api/src/api/larod/html/structlarodError.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/structlarodTensorDims.html b/docs/api/src/api/larod/html/structlarodTensorDims.html index 4363b87a..74c57abc 100644 --- a/docs/api/src/api/larod/html/structlarodTensorDims.html +++ b/docs/api/src/api/larod/html/structlarodTensorDims.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/larod/html/structlarodTensorPitches.html b/docs/api/src/api/larod/html/structlarodTensorPitches.html index b2037a41..7e5b2c0f 100644 --- a/docs/api/src/api/larod/html/structlarodTensorPitches.html +++ b/docs/api/src/api/larod/html/structlarodTensorPitches.html @@ -24,7 +24,7 @@ Logo
    liblarod -  3.2.47-dirty +  3.2.59-dirty
    diff --git a/docs/api/src/api/vdostream/html/globals.html b/docs/api/src/api/vdostream/html/globals.html index ab2b5875..7eeffdf4 100644 --- a/docs/api/src/api/vdostream/html/globals.html +++ b/docs/api/src/api/vdostream/html/globals.html @@ -755,6 +755,9 @@

    - v -