diff options
Diffstat (limited to 'doc/cpp')
| -rw-r--r-- | doc/cpp/Doxyfile.in | 1 | ||||
| -rw-r--r-- | doc/cpp/api/meson.build | 2 | ||||
| -rw-r--r-- | doc/cpp/event-loop.rst | 5 | ||||
| -rw-r--r-- | doc/cpp/meson.build | 6 | ||||
| -rw-r--r-- | doc/cpp/view.rst | 4 | ||||
| -rw-r--r-- | doc/cpp/xml/meson.build | 4 |
6 files changed, 10 insertions, 12 deletions
diff --git a/doc/cpp/Doxyfile.in b/doc/cpp/Doxyfile.in index 05deae7..3d0d45f 100644 --- a/doc/cpp/Doxyfile.in +++ b/doc/cpp/Doxyfile.in @@ -31,7 +31,6 @@ MACRO_EXPANSION = YES PREDEFINED = PUGL_API \ PUGL_CONST_API= \ PUGL_CONST_FUNC= \ - PUGL_DISABLE_DEPRECATED \ PUGL_MALLOC_API= \ PUGL_MALLOC_FUNC= diff --git a/doc/cpp/api/meson.build b/doc/cpp/api/meson.build index 9b2f7e6..7f05f42 100644 --- a/doc/cpp/api/meson.build +++ b/doc/cpp/api/meson.build @@ -2,7 +2,7 @@ # SPDX-License-Identifier: 0BSD OR ISC cpp_pugl_rst = custom_target( - 'C++ API ReST Documentation', + 'cpp_pugl.rst', command: [sphinxygen, '-l', 'cpp', '-f', '@INPUT@', '@OUTDIR@'], input: cpp_index_xml, output: 'pugl.rst', diff --git a/doc/cpp/event-loop.rst b/doc/cpp/event-loop.rst index 1d2ac41..3223069 100644 --- a/doc/cpp/event-loop.rst +++ b/doc/cpp/event-loop.rst @@ -24,14 +24,13 @@ while those that draw continuously may use a significant fraction of the frame p Redrawing ********* -Occasional redrawing can be requested by calling :func:`View::postRedisplay` or :func:`View::postRedisplayRect`. +Occasional redrawing can be requested by calling :func:`View::obscure`. After these are called, a :type:`ExposeEvent` will be dispatched on the next call to :func:`World::update`. Note, however, that this will not wake up a blocked :func:`World::update` call on MacOS (which does not handle drawing via events). -For continuous redrawing, -call :func:`View::postRedisplay` while handling a :type:`UpdateEvent`. +For continuous redrawing, obscure the view while handling a :type:`UpdateEvent`. This event is sent just before views are redrawn, so it can be used as a hook to expand the update region right before the view is exposed. Anything else that needs to be done every frame can be handled similarly. diff --git a/doc/cpp/meson.build b/doc/cpp/meson.build index ca6bc5b..723510b 100644 --- a/doc/cpp/meson.build +++ b/doc/cpp/meson.build @@ -1,4 +1,4 @@ -# Copyright 2021 David Robillard <d@drobilla.net> +# Copyright 2021-2024 David Robillard <d@drobilla.net> # SPDX-License-Identifier: 0BSD OR ISC config = configuration_data() @@ -30,7 +30,7 @@ subdir('xml') subdir('api') docs = custom_target( - 'singlehtml', + 'cpp_singlehtml', build_by_default: true, command: [ sphinx_build, @@ -48,7 +48,7 @@ docs = custom_target( ) docs = custom_target( - 'html', + 'cpp_html', command: [ sphinx_build, '-M', 'html', diff --git a/doc/cpp/view.rst b/doc/cpp/view.rst index 49940c9..e2fc994 100644 --- a/doc/cpp/view.rst +++ b/doc/cpp/view.rst @@ -90,14 +90,14 @@ Embedding To embed the view in another window, you will need to somehow get the :type:`native view handle <pugl::NativeView>` for the parent, -then set it with :func:`View::setParentWindow`. +then set it with :func:`View::setParent`. If the parent is a Pugl view, the native handle can be accessed with :func:`View::nativeView`. For example: .. code-block:: cpp - view.setParentWindow(view, parent.getNativeView()); + view.setParent(view, parent.nativeView()); ***************** Setting a Backend diff --git a/doc/cpp/xml/meson.build b/doc/cpp/xml/meson.build index 72bb8ee..083a6cc 100644 --- a/doc/cpp/xml/meson.build +++ b/doc/cpp/xml/meson.build @@ -1,4 +1,4 @@ -# Copyright 2021 David Robillard <d@drobilla.net> +# Copyright 2021-2024 David Robillard <d@drobilla.net> # SPDX-License-Identifier: 0BSD OR ISC config = configuration_data() @@ -12,7 +12,7 @@ cpp_doxyfile = configure_file( ) cpp_index_xml = custom_target( - 'cpp-index.xml', + 'cpp_index.xml', command: [doxygen, '@INPUT0@'], input: [cpp_doxyfile] + c_headers + cpp_headers, output: 'index.xml', |