diff options
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/Doxyfile-common.in | 3 | ||||
| -rw-r--r-- | Documentation/guides/pipeline-handler.rst | 10 |
2 files changed, 7 insertions, 6 deletions
diff --git a/Documentation/Doxyfile-common.in b/Documentation/Doxyfile-common.in index 045c19dd..58afea1c 100644 --- a/Documentation/Doxyfile-common.in +++ b/Documentation/Doxyfile-common.in @@ -57,7 +57,8 @@ GENERATE_LATEX = NO MACRO_EXPANSION = YES EXPAND_ONLY_PREDEF = YES -INCLUDE_PATH = "@TOP_SRCDIR@/include/libcamera" +INCLUDE_PATH = "@TOP_BUILDDIR@/include" \ + "@TOP_SRCDIR@/include" INCLUDE_FILE_PATTERNS = *.h IMAGE_PATH = "@TOP_SRCDIR@/Documentation/images" diff --git a/Documentation/guides/pipeline-handler.rst b/Documentation/guides/pipeline-handler.rst index fe752975..0d5df726 100644 --- a/Documentation/guides/pipeline-handler.rst +++ b/Documentation/guides/pipeline-handler.rst @@ -213,7 +213,7 @@ implementations for the overridden class members. std::vector<std::unique_ptr<FrameBuffer>> *buffers) override; int start(Camera *camera, const ControlList *controls) override; - void stop(Camera *camera) override; + void stopDevice(Camera *camera) override; int queueRequestDevice(Camera *camera, Request *request) override; @@ -247,7 +247,7 @@ implementations for the overridden class members. return -1; } - void PipelineHandlerVivid::stop(Camera *camera) + void PipelineHandlerVivid::stopDevice(Camera *camera) { } @@ -1152,7 +1152,7 @@ available to the devices which have to be started and ready to produce images. At the end of a capture session the ``Camera`` device needs to be stopped, to gracefully clean up any allocated memory and stop the hardware devices. Pipeline handlers implement two functions for these purposes, the -``start()`` and ``stop()`` functions. +``start()`` and ``stopDevice()`` functions. The memory initialization phase that happens at ``start()`` time serves to configure video devices to be able to use memory buffers exported as dma-buf @@ -1255,8 +1255,8 @@ algorithms, or other devices you should also stop them. .. _releaseBuffers: https://libcamera.org/api-html/classlibcamera_1_1V4L2VideoDevice.html#a191619c152f764e03bc461611f3fcd35 Of course we also need to handle the corresponding actions to stop streaming on -a device, Add the following to the ``stop`` function, to stop the stream with -the `streamOff`_ function and release all buffers. +a device, Add the following to the ``stopDevice()`` function, to stop the +stream with the `streamOff`_ function and release all buffers. .. _streamOff: https://libcamera.org/api-html/classlibcamera_1_1V4L2VideoDevice.html#a61998710615bdf7aa25a046c8565ed66 |