summaryrefslogtreecommitdiff
path: root/Documentation/mainpage.dox
blob: d5a57653ca93920b6e7ae8d7a1869b1ccc2918ee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
/**
\mainpage libcamera API reference

Welcome to the API reference for <a href="https://libcamera.org/">libcamera</a>,
a complex camera support library for Linux, Android and ChromeOS. These pages
are automatically generated from the libcamera source code and describe the API
in detail - if this is your first interaction with libcamera then you may find
it useful to visit the [developer's guide](../html/guides/introduction.html) in
the first instance, which can provide a more generic introduction to the
library's concepts.

\if internal

As a follow-on to the developer's guide, to assist you in adding support for
your platform the [pipeline handler writer's guide](../html/guides/pipeline-handler.html)
and the [ipa module writer's guide](../html/guides/ipa.html) should be helpful.

The full libcamera API is documented here. If you wish to see only the public
part of the API you can use [these pages](../api-html/index.html) instead.

\else

As a follow-on to the developer's guide, to assist you in using libcamera within
your project the [application developer's guide](../html/guides/application-developer.html)
gives an overview on how to achieve that.

Only the public part of the libcamera API is documented here; if you are a
developer seeking to add support for your hardware to the library or make other
improvements, you should switch to the internal API
[reference pages](../internal-api-html/index.html) instead.

\endif
*/