Mirror/libcamera
1
0
Fork 0
mirror of https://git.libcamera.org/libcamera/libcamera.git synced 2025-07-25 17:45:06 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

libcamera: Rename 'method' to 'function'

Browse source 
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>
This commit is contained in:
Laurent Pinchart 2021-04-07 15:48:59 +03:00
parent 0536a9aa71
commit a48a000a33
53 changed files with 314 additions and 309 deletions
Download patch file Download diff file Expand all files Collapse all files

2
include/libcamera/ipa/core.mojom
View file

@ -291,7 +291,7 @@ struct IPASettings {
* \brief Stream configuration for the IPA interface
*
* The IPAStream structure stores stream configuration parameters needed by the
* IPAInterface::configure() method. It mirrors the StreamConfiguration class
* IPAInterface::configure() function. It mirrors the StreamConfiguration class
* that is not suitable for this purpose due to not being serializable.
*/

31
include/libcamera/ipa/raspberrypi.mojom
View file

@ -58,7 +58,7 @@ interface IPARPiInterface {
* \param[in] ipaConfig Pipeline-handler-specific configuration data
* \param[out] controls Controls to apply by the pipeline entity
*
* This method shall be called when the camera is configured to inform
* This function shall be called when the camera is configured to inform
* the IPA of the camera's streams and the sensor settings.
*
* The \a sensorInfo conveys information about the camera sensor settings that
@ -78,20 +78,21 @@ interface IPARPiInterface {
* \brief Map buffers shared between the pipeline handler and the IPA
* \param[in] buffers List of buffers to map
*
* This method informs the IPA module of memory buffers set up by the pipeline
* handler that the IPA needs to access. It provides dmabuf file handles for
* each buffer, and associates the buffers with unique numerical IDs.
* This function informs the IPA module of memory buffers set up by the
* pipeline handler that the IPA needs to access. It provides dmabuf
* file handles for each buffer, and associates the buffers with unique
* numerical IDs.
*
* IPAs shall map the dmabuf file handles to their address space and keep a
* cache of the mappings, indexed by the buffer numerical IDs. The IDs are used
* in all other IPA interface methods to refer to buffers, including the
* unmapBuffers() method.
* IPAs shall map the dmabuf file handles to their address space and
* keep a cache of the mappings, indexed by the buffer numerical IDs.
* The IDs are used in all other IPA interface functions to refer to
* buffers, including the unmapBuffers() function.
*
* All buffers that the pipeline handler wishes to share with an IPA shall be
* mapped with this method. Buffers may be mapped all at once with a single
* call, or mapped and unmapped dynamically at runtime, depending on the IPA
* protocol. Regardless of the protocol, all buffers mapped at a given time
* shall have unique numerical IDs.
* All buffers that the pipeline handler wishes to share with an IPA
* shall be mapped with this function. Buffers may be mapped all at once
* with a single call, or mapped and unmapped dynamically at runtime,
* depending on the IPA protocol. Regardless of the protocol, all
* buffers mapped at a given time shall have unique numerical IDs.
*
* The numerical IDs have no meaning defined by the IPA interface, and
* should be treated as opaque handles by IPAs, with the only exception
@ -106,8 +107,8 @@ interface IPARPiInterface {
* \brief Unmap buffers shared by the pipeline to the IPA
* \param[in] ids List of buffer IDs to unmap
*
* This method removes mappings set up with mapBuffers(). Numerical IDs
* of unmapped buffers may be reused when mapping new buffers.
* This function removes mappings set up with mapBuffers(). Numerical
* IDs of unmapped buffers may be reused when mapping new buffers.
*
* \sa mapBuffers()
*/