Commit graph

8 commits

Author SHA1 Message Date
Kieran Bingham
e89d8c7e50 Documentation: application-developer: Fix up spelling error
Fix a minor spelling error.

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
2021-08-25 21:35:03 +01:00
Kieran Bingham
6b9645d894 Documentation: application-developer: Fix reference to cam BufferWriter
The BufferWriter class has been replaced by the FileSink.

Adapt the reference, to match the source code.

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
2021-08-25 21:35:03 +01:00
Kieran Bingham
e590ca3004 Documentation: application-developer: Recommend unique_ptr for CameraManager
The CameraManager object should be deleted when it is no longer used to
prevent it from leaking.

When the application closes, the memory will be released, but it would
show up in reports from memory validation tools such as valgrind if not
handled correctly.

Recommend best-practices in the guide and ensure it is automatically
cleaned up when the CameraManager goes out of scope.

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
2021-08-25 21:35:03 +01:00
Kieran Bingham
d2783171dd Documentation: application-developer: Clean up build instructions
The build and run instructions read as if meson is the only way to
compile the application. Although this is recommended, it is not
required - adapt the language to fit better.

While here, fix the naming of the simple_cam meson object to match
the other usages of 'simple-cam'.

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
2021-08-25 21:35:03 +01:00
Kieran Bingham
fe8b72a595 Documentation: application-developer: Remove irrelevant TODO
This TODO has no real meaning, and isn't an action. Remove it.

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
2021-08-25 21:35:03 +01:00
Laurent Pinchart
a48a000a33 libcamera: Rename 'method' to 'function'
Usage of 'method' to refer to member functions comes from Java. The C++
standard uses the term 'function' only. Replace 'method' with 'function'
or 'member function' through the whole code base and documentation.
While at it, fix two typos (s/backeng/backend/).

The BoundMethod and Object::invokeMethod() are left as-is here, and will
be addressed separately.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Paul Elder <paul.elder@ideasonboard.com>
Acked-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
2021-08-09 15:40:32 +03:00
Paul Elder
5468048b68 Documentation: guides: application-developer: update pkgconfig name
The pkgconfig name was changed from camera to libcamera, but the
application developer guide wasn't updated. Update it to refer to the
new name.

Bug: https://bugs.libcamera.org/show_bug.cgi?id=65
Fixes: ec7afef6 ("libcamera: Rename libcamera pkg-config generation")
Signed-off-by: Paul Elder <paul.elder@ideasonboard.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
2021-07-21 19:35:55 +09:00
Chris Chinchilla
b704efeb86 Documentation: Guides: Application Writer's Guide
Provide a tutorial and walk through guide for writing an applications
with libcamera.

Signed-off-by: Chris Chinchilla <chris@gregariousmammal.com>
[Reflow/Rework, update to mainline API]
Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>
[Further reworks and review]
Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
Acked-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
2020-08-20 16:56:13 +01:00