aboutsummaryrefslogtreecommitdiff
path: root/subprojects/d2tk/pugl/doc
diff options
context:
space:
mode:
authorHanspeter Portner <dev@open-music-kontrollers.ch>2020-03-29 20:58:30 +0200
committerHanspeter Portner <dev@open-music-kontrollers.ch>2020-03-29 20:58:30 +0200
commitb57ad6ab9de36037cf6379a0d603ff21d2f8eb3b (patch)
treeb513cd95da9129f82ba781c0646ab099f7c84f70 /subprojects/d2tk/pugl/doc
parentf73a698a92369d1bfaa26ad46764b1b5810d1a2a (diff)
parent8de920f2eddc7eb5648fef7e966bd1b39c21911c (diff)
downloadmephisto.lv2-b57ad6ab9de36037cf6379a0d603ff21d2f8eb3b.tar.xz
Merge commit '8de920f2eddc7eb5648fef7e966bd1b39c21911c'
Diffstat (limited to 'subprojects/d2tk/pugl/doc')
-rw-r--r--subprojects/d2tk/pugl/doc/header.html2
-rw-r--r--subprojects/d2tk/pugl/doc/layout.xml2
-rw-r--r--subprojects/d2tk/pugl/doc/mainpage.md76
-rw-r--r--subprojects/d2tk/pugl/doc/reference.doxygen.in8
-rw-r--r--subprojects/d2tk/pugl/doc/style.css822
5 files changed, 503 insertions, 407 deletions
diff --git a/subprojects/d2tk/pugl/doc/header.html b/subprojects/d2tk/pugl/doc/header.html
index 07d4076..54c25b0 100644
--- a/subprojects/d2tk/pugl/doc/header.html
+++ b/subprojects/d2tk/pugl/doc/header.html
@@ -41,7 +41,9 @@
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
+ <li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
+ <li><a href="functions.html"><span>Symbols</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
diff --git a/subprojects/d2tk/pugl/doc/layout.xml b/subprojects/d2tk/pugl/doc/layout.xml
index f752de1..1889302 100644
--- a/subprojects/d2tk/pugl/doc/layout.xml
+++ b/subprojects/d2tk/pugl/doc/layout.xml
@@ -83,6 +83,7 @@
<!-- Layout definition for a namespace page -->
<namespace>
<briefdescription visible="yes"/>
+ <detaileddescription title=""/>
<memberdecl>
<nestednamespaces visible="yes" title=""/>
<constantgroups visible="yes" title=""/>
@@ -93,7 +94,6 @@
<variables title=""/>
<membergroups visible="yes"/>
</memberdecl>
- <detaileddescription title=""/>
<memberdef>
<inlineclasses title=""/>
<typedefs title=""/>
diff --git a/subprojects/d2tk/pugl/doc/mainpage.md b/subprojects/d2tk/pugl/doc/mainpage.md
index b16551a..d7a96fa 100644
--- a/subprojects/d2tk/pugl/doc/mainpage.md
+++ b/subprojects/d2tk/pugl/doc/mainpage.md
@@ -1,43 +1,73 @@
This is the API documentation for Pugl.
-The complete C API is documented in the [Pugl](@ref pugl) group,
-and the C++ wrapper in the [Puglmm](@ref puglmm) group.
+This documentation is based around the [C API](@ref pugl_api),
+there is also a [C++ API](@ref pugl) in the `pugl` namespace.
The Pugl API revolves around two main objects:
the [World](@ref world) and the [View](@ref view).
-An application creates a single world to manage system-level state,
+An application creates a single world to manage top-level state,
then creates one or more views to display.
-## View creation
+## World
+
+The [World](@ref world) contains all top-level state,
+and manages views and the event loop.
+
+A world must be [created](@ref puglNewWorld) before any views,
+and it must outlive all views.
+
+## View
+
+A [View](@ref view) is a drawable region that receives events.
Creating a visible view is a multi-step process.
-A new view allocated with #puglNewView does not yet represent a "real" system window.
-To display, it must first have a [backend set](@ref puglSetBackend),
+When a new view is [created](@ref puglNewView),
+it does not yet represent a real system view or window.
+To display, it must first have a [backend](@ref puglSetBackend)
+and [event handler](@ref puglSetEventFunc) set,
and be configured by [setting hints](@ref puglSetViewHint)
-and [configuring the frame](@ref frame).
+and optionally [adjusting the frame](@ref frame).
+
+The [Backend](@ref PuglBackend) controls drawing for a view.
+Pugl includes [Cairo](@ref cairo) and [OpenGL](@ref gl) backends,
+as well as a [stub](@ref stub) backend that creates a native window with no drawing context.
-Once the view is configured,
-the corresponding window can be [created](@ref puglCreateWindow)
-and [shown](@ref puglShowWindow).
-Note that a view does not necessary correspond to a top-level system window.
+Once the view is configured,
+it can be [created](@ref puglCreateWindow) and [shown](@ref puglShowWindow).
+By default a view will correspond to a top-level system window.
To create a view within another window,
-call #puglSetParentWindow before #puglCreateWindow.
+it must have a [parent window set](@ref puglSetParentWindow) before being created.
+
+
+## Events
-## Interaction
+[Events](@ref events) are sent to a view when it has received user input or must be drawn.
-Interaction with the user and system happens via [events](@ref interaction).
-Before creating a window,
-a view must have an [event handler](@ref PuglEventFunc) set with #puglSetEventFunc.
-This handler is called whenever something happens that the view must respond to.
+Events are handled by the [event handler](@ref PuglEventFunc) set during initialisation.
+This function is called whenever something happens that the view must respond to.
This includes user interaction like mouse and keyboard input,
-and system events like window resizing and exposure (drawing).
+and system events like window resizing and exposure.
## Event Loop
-Two functions are used to drive the event loop:
+The event loop is driven by repeatedly calling #puglUpdate which processes events from the window system,
+and dispatches them to views when necessary.
+
+Typically, a plugin calls #puglUpdate with timeout 0 in some callback driven by the host.
+A program can use whatever timeout is appropriate:
+event-driven applications may wait forever,
+or for continuous animation,
+use a timeout that is a significant fraction of the frame period
+(with enough time left over to render).
+
+Redrawing can be requested by calling #puglPostRedisplay or #puglPostRedisplayRect,
+which post expose events to the queue.
+Note, however, that this will not wake up a blocked #puglUpdate call on MacOS
+(which does not handle drawing via events).
+For continuous redrawing, call #puglPostRedisplay when a #PUGL_UPDATE event is received.
+This event is sent before views are redrawn,
+so can be used as a hook to expand the update region right before the view is exposed.
- * #puglPollEvents waits for events to become available.
- * #puglDispatchEvents processes all pending events.
+## Error Handling
-Redrawing is accomplished by calling #puglPostRedisplay,
-which posts an expose event to the queue.
+Most functions return a [Status](@ref status) which should be checked to detect failure.
diff --git a/subprojects/d2tk/pugl/doc/reference.doxygen.in b/subprojects/d2tk/pugl/doc/reference.doxygen.in
index eb64d58..1357fe4 100644
--- a/subprojects/d2tk/pugl/doc/reference.doxygen.in
+++ b/subprojects/d2tk/pugl/doc/reference.doxygen.in
@@ -379,7 +379,7 @@ DISTRIBUTE_GROUP_DOC = NO
# is disabled and one has to add nested compounds explicitly via \ingroup.
# The default value is: NO.
-GROUP_NESTED_COMPOUNDS = YES
+GROUP_NESTED_COMPOUNDS = NO
# Set the SUBGROUPING tag to YES to allow class member groups of the same type
# (for instance a group of public functions) to be put as a subgroup of that
@@ -692,7 +692,7 @@ SHOW_FILES = YES
# Folder Tree View (if specified).
# The default value is: YES.
-SHOW_NAMESPACES = NO
+SHOW_NAMESPACES = YES
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from
@@ -1451,7 +1451,7 @@ GENERATE_TREEVIEW = NO
# Minimum value: 0, maximum value: 20, default value: 4.
# This tag requires that the tag GENERATE_HTML is set to YES.
-ENUM_VALUES_PER_LINE = 1
+ENUM_VALUES_PER_LINE = 0
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
# to set the initial width (in pixels) of the frame in which the tree is shown.
@@ -2090,7 +2090,7 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
-PREDEFINED = PUGL_API PUGL_DEPRECATED_BY
+PREDEFINED = PUGL_API PUGL_DISABLE_DEPRECATED
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
diff --git a/subprojects/d2tk/pugl/doc/style.css b/subprojects/d2tk/pugl/doc/style.css
index fa366af..dba66b3 100644
--- a/subprojects/d2tk/pugl/doc/style.css
+++ b/subprojects/d2tk/pugl/doc/style.css
@@ -1,744 +1,808 @@
body {
- background: #FFF;
- color: #222;
- font-style: normal;
- line-height: 1.6em;
- margin-left: auto;
- margin-right: auto;
- padding: 1em;
- max-width: 60em;
- font-family: "DejaVu Serif",Palatino,serif;
- text-rendering: optimizeLegibility;
+ background: #FFF;
+ color: #222;
+ font-style: normal;
+ line-height: 1.6em;
+ margin-left: auto;
+ margin-right: auto;
+ padding: 1em;
+ max-width: 60em;
+ font-family: "SF Pro Text", Verdana, "DejaVu Sans", sans-serif;
+ text-rendering: optimizeLegibility;
+}
+
+h1 {
+ font-size: 1.68em;
+ font-weight: 500;
+ font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif;
+ line-height: 2em;
+ margin: 0 0 0.25em 0;
}
-h1, .title, #projectname, h2, h3, h4, h5, h6 {
- line-height: 1.0125em;
- color: #444;
- font-family: "DejaVu Sans",Helvetica,Arial,sans-serif;
- margin: 1em 0 0.5em 0;
+h2 {
+ line-height: 1.68em;
+ font-size: 1.41em;
+ font-weight: 600;
+ font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif;
+ margin: 1.25em 0 0.5em 0;
}
-h1, .titlearea .header .titlebox, #projectname {
- font-size: 300%;
- font-weight: 400;
- margin-bottom: 0.25em;
- margin-top: 0;
+h3 {
+ line-height: 1.41em;
+ font-size: 1.18em;
+ font-weight: 600;
+ font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif;
+ margin: 1.25em 0 0.5em 0;
}
-.header .headertitle .title {
- font-size: 180%;
- font-weight: 400;
- margin: 0.75em 0.25em 0.5em 0;
+h4 {
+ line-height: 1.18em;
+ font-size: 1em;
+ font-weight: 600;
+ font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif;
+ margin: 1.25em 0 0.5em 0;
}
-.ingroups {
- display: inline;
+h5, h6 {
+ font-size: 0.7em;
+ font-weight: 600;
+ font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif;
+ margin: 1.25em 0 0.5em 0;
}
-.title .ingroups a {
- font-size: small;
- margin-left: 1em;
+
+a {
+ color: #546E00;
+ text-decoration: none;
}
-#titlebox, #metabox {
- display: inline-block;
+h1 a, h2 a, h3 a, h4 a, h5 a, h6 a {
+ color: #444;
}
-#titlebox{
- display: inline-block;
- width: 75%;
- left: 0;
- top: 0;
+
+a:hover {
+ text-decoration: underline;
}
-#title {
- margin-bottom: 0.25em;
+h1 a:link, h2 a:link, h3 a:link, h4 a:link, h5 a:link, h6 a:link {
+ color: #444;
}
-#shortdesc {
- margin: 0;
- color: #666;
- display: inline-block;
- font-style: italic;
- padding: 0;
+h1 a:visited, h2 a:visited, h3 a:visited, h4 a:visited, h5 a:visited, h6 a:visited {
+ color: #444;
}
-#titlearea {
- margin: 0.25em auto 0.25em auto;
- padding: 0;
- position: relative;
- clear: both;
- line-height: 1.0em;
+p {
+ margin: 0.5em 0 0.5em 0;
}
-h2 {
- font-size: 160%;
- font-weight: 400;
+dt {
+ font-weight: 600;
}
-h3 {
- font-size: 140%;
- font-weight: 400;
+dd {
+ margin-left: 2em;
}
-h4 {
- font-size: 120%;
- font-weight: 500;
+caption {
+ font-weight: 700;
}
-h5, h6 {
- font-size: 110%;
- font-weight: 600;
+.title, #projectname {
+ line-height: 1.0125em;
+ margin: 0.75em 0 0 0;
}
-h1 a, h1 a:link, h1 a:visited ,
-h2 a, h2 a:link, h2 a:visited ,
-h3 a, h3 a:link, h3 a:visited ,
-h4 a, h4 a:link, h4 a:visited ,
-h5 a, h5 a:link, h5 a:visited ,
-h6 a, h6 a:link, h6 a:visited {
- color: #444;
+.titlearea .header .titlebox, #projectname {
+ font-size: 1.68em;
+ font-weight: 400;
+ margin-bottom: 0.25em;
+ margin-top: 0;
}
-p {
- margin: 0.5em 0 0.5em 0;
+#header {
+ padding: 0 0 0.5em 0;
+ border-bottom: 1px solid #EEE;
}
-dt {
- font-weight: 700;
+.header .headertitle .title {
+ line-height: 1.68em;
+ font-size: 1.68em;
+ font-weight: 600;
+ font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif;
}
-dd {
- margin-left: 2em;
+.ingroups {
+ display: none;
}
-caption {
- font-weight: 700;
+.title .ingroups a {
+ font-size: small;
+ margin-left: 1em;
}
-span.legend {
- font-size: small;
- text-align: center;
+#titlebox, #metabox {
+ display: inline-block;
}
-h3.version {
- font-size: small;
- text-align: center;
+#titlebox {
+ display: inline-block;
+ width: 75%;
+ left: 0;
+ top: 0;
}
-div.qindex,div.navtab {
- background-color: #EBEFF6;
- border: 1px solid #A3B4D7;
- text-align: center;
- margin: 2px;
- padding: 2px;
+#title {
+ margin-bottom: 0.25em;
+ line-height: 1.25em;
+ font-size: 2.5em;
+ color: #333;
+ font-weight: 600;
}
-div.navtab {
- margin-right: 15px;
+.PageDoc {
+ margin-top: 1.5em;
}
-/* @group Link Styling */
-a {
- color: #546E00;
- text-decoration: none;
+.PageDoc .header .headertitle .title {
+ display: none;
}
-.contents a:visited {
- color: #344E00;
+#shortdesc {
+ margin: 0;
+ color: #666;
+ display: inline-block;
+ font-style: italic;
+ font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif;
+ padding: 0;
}
-a:hover {
- text-decoration: underline;
+#titlearea {
+ margin: 0.25em auto 0 auto;
+ padding: 0;
+ position: relative;
+ clear: both;
+ line-height: 1em;
+}
+
+.legend {
+ font-size: small;
+ text-align: center;
+}
+
+.version {
+ font-size: small;
+ text-align: center;
+}
+
+div.qindex,div.navtab {
+ background-color: #EBEFF6;
+ border: 1px solid #A3B4D7;
+ text-align: center;
+ margin: 2px;
+ padding: 2px;
+}
+
+div.navtab {
+ margin-right: 15px;
+}
+
+.contents a:visited {
+ color: #344E00;
}
a.qindexHL {
- background-color: #9CAFD4;
- color: #FFF;
- border: 1px double #869DCA;
+ background-color: #9CAFD4;
+ color: #FFF;
+ border: 1px double #869DCA;
}
code {
- color: #444;
+ color: #444;
+ font-family: "SF Mono", Menlo, Consolas, "DejaVu Sans Mono", monospace, fixed;
}
-/* @end */
dl.el {
- margin-left: -1cm;
+ margin-left: -1cm;
}
.fragment {
- font-family: "DejaVu Sans Mono",monospace,fixed;
+ font-family: "SF Mono", Menlo, Consolas, "DejaVu Sans Mono", monospace, fixed;
}
pre.fragment {
- border: 1px solid #C4C4C4;
- background-color: #F9F9F9;
- padding: 0.5em;
- overflow: auto;
+ border: 1px solid #C4C4C4;
+ background-color: #F9F9F9;
+ padding: 0.5em;
+ overflow: auto;
}
div.ah {
- background-color: #000;
- font-weight: 700;
- color: #FFF;
- margin-bottom: 3px;
- margin-top: 3px;
- padding: .2em;
- border: thin solid #333;
+ background-color: #000;
+ font-weight: 700;
+ color: #FFF;
+ margin-bottom: 3px;
+ margin-top: 3px;
+ padding: 0.2em;
+ border: thin solid #333;
}
div.groupHeader {
- margin-left: 16px;
- margin-top: 12px;
- margin-bottom: 6px;
- font-weight: 700;
+ margin-left: 16px;
+ margin-top: 12px;
+ margin-bottom: 6px;
+ font-weight: 700;
}
a + h2.groupheader {
- display: none;
+ display: none;
}
div.groupText {
- margin-left: 16px;
- font-style: italic;
+ margin-left: 16px;
+ font-style: italic;
}
div.contents, #content {
- padding: 0 0.25em 0 0.25em;
- max-width: 60em;
- margin-left: auto;
- margin-right: auto;
+ max-width: 60em;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.groupheader + p {
+ font-style: italic;
+ color: #666;
+ margin: 0 0 1em 0;
}
td.indexkey {
- background-color: #EBEFF6;
- font-weight: 700;
- border: 1px solid #C4CFE5;
- margin: 2px 0;
- padding: 2px 10px;
+ background-color: #EBEFF6;
+ font-weight: 700;
+ border: 1px solid #C4CFE5;
+ margin: 2px 0;
+ padding: 2px 10px;
}
td.indexvalue {
- background-color: #EBEFF6;
- border: 1px solid #C4CFE5;
- padding: 2px 10px;
- margin: 2px 0;
+ background-color: #EBEFF6;
+ border: 1px solid #C4CFE5;
+ padding: 2px 10px;
+ margin: 2px 0;
}
table.memname {
- font-family: "DejaVu Sans Mono",monospace,fixed;
+ font-family: "SF Mono", Menlo, Consolas, "DejaVu Sans Mono", monospace, fixed;
+ border-spacing: 0;
+}
+
+table.memname tbody tr:last-child {
+ display: none;
+}
+
+table.memname tbody tr:only-child {
+ display: table-cell;
+}
+
+table.memname tbody tr:nth-last-child(2)::after {
+ content: ")";
}
tr.memlist {
- background-color: #EEF1F7;
+ background-color: #EEF1F7;
}
p.formulaDsp {
- text-align: center;
+ text-align: center;
}
img.formulaInl {
- vertical-align: middle;
+ vertical-align: middle;
}
div.center {
- text-align: center;
- margin-top: 0;
- margin-bottom: 0;
- padding: 0;
+ text-align: center;
+ margin-top: 0;
+ margin-bottom: 0;
+ padding: 0;
}
div.center img {
- border: 0;
+ border: 0;
}
address.footer {
- text-align: right;
+ text-align: right;
}
img.footer {
- border: 0;
- vertical-align: middle;
+ border: 0;
+ vertical-align: middle;
}
-/* @group Code Colorization */
span.keyword {
- color: #586E75;
+ color: #586E75;
}
span.keywordtype {
- color: #546E00;
+ color: #546E00;
}
span.keywordflow {
- color: #586E75;
+ color: #586E75;
}
span.comment {
- color: #6C71C4;
+ color: #6C71C4;
}
span.preprocessor {
- color: #D33682;
+ color: #D33682;
}
span.stringliteral {
- color: #CB4B16;
+ color: #CB4B16;
}
span.charliteral {
- color: #CB4B16;
+ color: #CB4B16;
}
-/* @end */
td.tiny {
- font-size: x-small;
+ font-size: x-small;
}
.dirtab {
- padding: 4px;
- border-collapse: collapse;
- border: 1px solid #A3B4D7;
+ padding: 4px;
+ border-collapse: collapse;
+ border: 1px solid #A3B4D7;
}
th.dirtab {
- background: #EBEFF6;
- font-weight: 700;
+ background: #EBEFF6;
+ font-weight: 700;
}
hr {
- height: 0;
- border: none;
- border-top: 1px solid #DDD;
- margin: 2em 0 1em;
+ height: 0;
+ border: none;
+ border-top: 1px solid #DDD;
+ margin: 2em 0;
}
#footer {
- bottom: 0;
- clear: both;
- font-size: x-small;
- margin: 2em 0 0;
- padding: 0 1em 1em 1em;
- vertical-align: top;
- color: #888;
+ bottom: 0;
+ clear: both;
+ font-size: x-small;
+ margin: 2em 0 0;
+ padding: 0 1em 1em 1em;
+ vertical-align: top;
+ color: #888;
+}
+
+td.ititle {
+ padding-bottom: 0.75em;
}
-/* @group Member Descriptions */
table.memberdecls {
- border-spacing: 0.125em;
- line-height: 1.3em;
+ border-spacing: 0.125em;
+ line-height: 1.3em;
}
.mdescLeft,.mdescRight,.memItemLeft,.memItemRight,.memTemplItemLeft,.memTemplItemRight,.memTemplParams {
- margin: 0;
- padding: 0;
+ margin: 0;
+ padding: 0;
}
.mdescLeft,.mdescRight {
- color: #555;
+ color: #555;
}
.memItemLeft,.memItemRight,.memTemplParams {
- border: 0;
- font-family: "DejaVu Sans Mono",monospace,fixed;
+ border: 0;
+ font-family: "SF Mono", Menlo, Consolas, "DejaVu Sans Mono", monospace, fixed;
}
.memItemLeft,.memTemplItemLeft {
- white-space: nowrap;
- padding-left: 2em;
- padding-right: 1em;
+ white-space: nowrap;
+ padding-left: 2em;
}
.memItemLeft a.el {
- font-weight: bold;
+ font-weight: bold;
}
.memTemplParams {
- color: #464646;
- white-space: nowrap;
+ color: #464646;
+ white-space: nowrap;
}
td.memSeparator {
- display: none;
+ display: none;
}
td.mlabels-right {
- vertical-align: top;
- padding-top: 4px;
- color: #B4C342;
+ vertical-align: top;
+ padding-top: 4px;
+ color: #B4C342;
}
.memtitle {
- display: none;
+ display: none;
}
-/* @end */
-/* @group Member Details */
-/* Styles for detailed member documentation */
.memtemplate {
- color: #888;
- font-style: italic;
- font-family: "DejaVu Sans Mono",monospace,fixed;
- font-size: small;
+ color: #888;
+ font-style: italic;
+ font-family: "SF Mono", Menlo, Consolas, "DejaVu Sans Mono", monospace, fixed;
+ font-size: small;
}
.memnav {
- background-color: #EEE;
- border: 1px solid #B4C342;
- text-align: center;
- margin: 2px;
- margin-right: 15px;
- padding: 2px;
+ background-color: #EEE;
+ border: 1px solid #B4C342;
+ text-align: center;
+ margin: 2px;
+ margin-right: 15px;
+ padding: 2px;
}
.memitem {
- padding: 0.25em 0.5em 0.25em 0.5em;
- margin: 0 0 1em 0;
- border-radius: 6px;
- border: 1px solid #DDD;
+ padding: 0.5em 0.5em 0.25em 0.5em;
+ margin: 1em 0 2em 0;
}
.memproto {
- font-size: 110%;
- font-weight: 400;
- line-height: 1em;
- color: #000;
+ border-bottom: 1px solid #EEE;
+ font-family: "SF Mono", Menlo, Consolas, "DejaVu Sans Mono", monospace, fixed;
+ font-size: 1.09em;
+ font-weight: 600;
+ line-height: 1.41em;
+ margin-bottom: 0.25em;
+ padding-bottom: 0.125em;
}
.memproto .paramname {
- font-style: normal;
+ font-style: normal;
+ padding-right: 0.25em;
}
.memdoc {
- padding: 0 0.25em 0 0.25em;
+ padding: 0;
+}
+
+.memdoc > p:first-child, .memdoc .textblock > p:first-child {
+ font-style: italic;
+ color: #444;
+ margin-bottom: 0.75em;
}
.paramkey {
- text-align: right;
+ text-align: right;
}
.paramtype {
- color: #666;
- padding-right: 0.5em;
- white-space: nowrap;
+ color: #666;
+ padding: 0 0.25em 0 0.25em;
+ white-space: nowrap;
}
-.paramname {
- color: #111;
- white-space: nowrap;
- font-family: "DejaVu Sans Mono",monospace,fixed;
- font-style: italic;
- padding-right: 0.5em;
+.params .paramname {
+ color: #111;
+ white-space: nowrap;
+ font-family: "SF Mono", Menlo, Consolas, "DejaVu Sans Mono", monospace, fixed;
+ font-style: italic;
+ padding-right: 0.5em;
+ vertical-align: top;
}
.fieldname {
- color: #000;
+ color: #000;
}
.fieldtable {
- padding-top: 0.25em;
- border-top: 1px dashed #DDD;
+ margin-top: 0.5em;
+ border-collapse: collapse;
}
.fieldtable tbody tr:first-child {
- display: none;
+ display: none;
}
td.fieldname {
- padding: 0 0.5em 0 0.25em;
- vertical-align: top;
- font-family: "DejaVu Sans Mono",monospace,fixed;
+ vertical-align: top;
+ font-family: "SF Mono", Menlo, Consolas, "DejaVu Sans Mono", monospace, fixed;
+}
+
+td.fielddoc {
+ padding: 0.125em 0.5em 0 0.25em;
+ vertical-align: top;
+}
+
+.fieldtable tbody tr td {
+ border-top: 1px dashed #DDD;
+ border-bottom: 1px dashed #DDD;
}
td.fieldtype {
- color: #666;
- padding: 0 0.5em 0 0;
- vertical-align: top;
- font-family: "DejaVu Sans Mono",monospace,fixed;
+ color: #666;
+ padding: 0 0.5em 0 0;
+ vertical-align: top;
+ font-family: "SF Mono", Menlo, Consolas, "DejaVu Sans Mono", monospace, fixed;
}
td.fielddoc p {
- margin: 0;
- vertical-align: top;
- padding: 0 0.5em 0 0;
+ margin: 0;
+ padding: 0 0.5em 0 0;
}
p.reference {
- font-size: x-small;
- font-style: italic;
+ font-size: x-small;
+ font-style: italic;
}
-/* @end */
-/* @group Directory (tree) */
-/* for the tree view */
.ftvtree {
- font-family: sans-serif;
- margin: 0;
+ font-family: "DejaVu Sans", Verdana, Helvetica, Arial, sans-serif;
+ margin: 0;
}
-/* these are for tree view when used as main index */
.directory {
- font-size: small;
- margin: 0.5em;
+ margin: 0.5em;
}
.directory h3 {
- margin: 0;
- margin-top: 1em;
- font-size: 11pt;
+ margin: 0;
+ margin-top: 1em;
+ font-size: 11pt;
}
.directory > h3 {
- margin-top: 0;
+ margin-top: 0;
}
.directory p {
- margin: 0;
- white-space: nowrap;
+ margin: 0;
+ white-space: nowrap;
}
.directory div {
- display: none;
- margin: 0;
+ display: none;
+ margin: 0;
}
.directory img {
- vertical-align: -30%;
+ vertical-align: -30%;
}
td.entry {
- font-family: "DejaVu Sans",Helvetica,Arial,sans-serif;
- font-weight: 400;
- padding-right: 1em;
+ font-family: "DejaVu Sans", Verdana, Helvetica, Arial, sans-serif;
+ font-weight: 400;
+ padding-right: 1em;
}
-td.entry .arrow {
- display: none;
+.arrow {
+ color: #CCC;
+ user-select: none;
+ font-size: 80%;
+ display: inline-block;
+ width: 16px;
+ height: 22px;
+ vertical-align: top;
}
td.entry b {
- font-family: "DejaVu Sans",Helvetica,Arial,sans-serif;
- font-weight: 400;
- font-size: 130%;
+ font-family: "DejaVu Sans", Verdana, Helvetica, Arial, sans-serif;
+ font-weight: 400;
+ font-size: 130%;
}
-/* these are for tree view when not used as main index */
.directory-alt {
- font-size: 100%;
- font-weight: bold;
+ font-size: 100%;
+ font-weight: bold;
}
.directory-alt h3 {
- margin: 0;
- margin-top: 1em;
- font-size: 11pt;
+ margin: 0;
+ margin-top: 1em;
+ font-size: 11pt;
}
.directory-alt > h3 {
- margin-top: 0;
+ margin-top: 0;
}
.directory-alt p {
- margin: 0;
- white-space: nowrap;
+ margin: 0;
+ white-space: nowrap;
}
.directory-alt div {
- display: none;
- margin: 0;
+ display: none;
+ margin: 0;
}
.directory-alt img {
- vertical-align: -30%;
+ vertical-align: -30%;
}
-/* @end */
div.dynheader {
- margin-top: 8px;
+ margin-top: 8px;
}
address {
- font-style: normal;
- color: #444;
+ font-style: normal;
+ color: #444;
}
table.doxtable {
- border-collapse: collapse;
- margin: 0.5em;
+ border-collapse: collapse;
+ margin: 0.5em;
}
table.doxtable td,table.doxtable th {
- border: 1px solid #DDD;
- padding: 3px 7px 2px;
+ border: 1px solid #DDD;
+ padding: 3px 7px 2px;
}
table.doxtable th {
- background-color: #F3F3F3;
- color: #000;
- padding-bottom: 4px;
- padding-top: 5px;
- text-align: left;
- font-weight: bold;
+ background-color: #F3F3F3;
+ color: #000;
+ padding-bottom: 4px;
+ padding-top: 5px;
+ text-align: left;
+ font-weight: bold;
}
.tabsearch {
- top: 0;
- left: 10px;
- height: 36px;
- z-index: 101;
- overflow: hidden;
- font-size: 13px;
+ top: 0;
+ left: 10px;
+ height: 36px;
+ z-index: 101;
+ overflow: hidden;
+ font-size: 13px;
}
div.navpath {
- color: #DDD;
+ color: #DDD;
}
.navpath ul {
- overflow: hidden;
- margin: 0;
- padding: 0;
+ overflow: hidden;
+ margin: 0;
+ padding: 0;
}
.navpath li {
- float: left;
- padding-left: 0;
- margin-left: 0.5em;
- padding-right: 1em;
+ float: left;
+ padding-left: 0;
+ margin-left: 0.5em;
+ padding-right: 1em;
}
.navpath a {
- display: block;
- text-decoration: none;
- outline: none;
+ display: block;
+ text-decoration: none;
+ outline: none;
}
div.summary {
- font-size: small;
- font-family: "DejaVu Sans",Helvetica,Arial,sans-serif;
- margin: 0;
- color: #FFF; /* Hide separator bars */
- border-bottom: 1px solid #DDD;
- padding: 0.25em 0;
+ font-size: small;
+ font-family: "DejaVu Sans", Verdana, Helvetica, Arial, sans-serif;
+ margin: 0;
+ padding: 0.25em 0;
+ display: none;
}
div.summary a {
- white-space: nowrap;
+ white-space: nowrap;
}
-/* Metadata box (right aligned next to title) */
-
#metabox {
- display: inline-block;
- font-size: x-small;
- margin: 0 0 0.25em 0;
- position: absolute;
- right: 0;
- top: 0;
- color: #666;
- font-style: italic;
- padding: 0 1em;
+ display: inline-block;
+ font-size: x-small;
+ font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif;
+ position: absolute;
+ right: 0;
+ bottom: 0.25em;
+ color: #666;
+ font-style: italic;
}
#meta {
- border-style: hidden;
- margin-right: 0.25em;
+ border-style: hidden;
+ margin-right: 0.25em;
}
#meta tr, #meta th, #meta td {
- background-color: transparent;
- border: 0;
- margin: 0;
- font-weight: normal;
+ background-color: transparent;
+ border: 0;
+ margin: 0;
+ font-weight: normal;
}
#meta th {
- text-align: right;
+ text-align: right;
}
-#meta th:after {
- content: ":";
+#meta th::after {
+ content: ":";
}
div.line {
- font-family: "DejaVu Sans Mono",monospace,fixed;
- line-height: 1.4em;
- white-space: pre-wrap;
+ font-family: "SF Mono", Menlo, Consolas, "DejaVu Sans Mono", monospace, fixed;
+ line-height: 1.4em;
+ white-space: pre-wrap;
}
.glow {
- background-color: #2AA198;
- box-shadow: 0 0 10px #2AA198;
+ background-color: #2AA198;
+ box-shadow: 0 0 10px #2AA198;
}
span.lineno {
- padding-right: 4px;
- text-align: right;
- border-right: 2px solid #546E00;
- background-color: #E8E8E8;
- white-space: pre;
+ padding-right: 4px;
+ text-align: right;
+ border-right: 2px solid #546E00;
+ background-color: #E8E8E8;
+ white-space: pre;
}
+
span.lineno a {
- background-color: #D8D8D8;
+ background-color: #D8D8D8;
}
span.lineno a:hover {
- background-color: #C8C8C8;
+ background-color: #C8C8C8;
}
.tabs, .tabs2, .navpath {
- padding: 0.25em 0;
- border-bottom: 1px solid #DDD;
- font-size: small;
- font-family: "DejaVu Sans",Helvetica,Arial,sans-serif;
- margin: 0;
+ padding: 0.25em 0;
+ font-size: small;
+ font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif;
+ margin: 0;
}
th {
- text-align: left;
- font-size: 110%;
- font-weight: 500;
+ text-align: left;
+ font-size: 110%;
+ font-weight: 500;
}
.mlabel {
- padding: 0.125em;
+ padding: 0.125em;
}
-#navrow1 {
- /* Disable menu from Doxygen 1.8.15, it is faked in the template */
- display: none;
+#navrow1, #navrow2 {
+ /* Disable menu from Doxygen 1.8.15, it is faked in the template */
+ display: none;
}
-/* tabs*/
-
.tablist {
- margin: 0;
- padding: 0;
- display: table;
+ margin: 0;
+ padding: 0;
+ display: table;
}
.tablist li {
- display: table-cell;
- line-height: 2em;
- list-style: none;
- border-bottom: 0;
+ display: table-cell;
+ line-height: 2em;
+ list-style: none;
+ border-bottom: 0;
}
.tablist a {
- display: block;
- padding: 0 1em 0 0;
- font-family: "DejaVu Sans",Helvetica,Arial,sans-serif;
- text-decoration: none;
- outline: none;
+ display: block;
+ padding: 0 1em 0 0;
+ text-decoration: none;
+ outline: none;
}
.tabs3 .tablist a {
- padding: 0 10px;
+ padding: 0 10px;
}
.tablist li.current a {
- color: #222;
+ color: #222;
}
span.icon {
- display: none;
+ display: none;
}