diff options
Diffstat (limited to 'doc/c')
-rw-r--r-- | doc/c/Doxyfile.in | 1 | ||||
-rw-r--r-- | doc/c/api/meson.build | 6 | ||||
-rw-r--r-- | doc/c/event-loop.rst | 5 | ||||
-rw-r--r-- | doc/c/meson.build | 6 | ||||
-rw-r--r-- | doc/c/view.rst | 4 | ||||
-rw-r--r-- | doc/c/xml/meson.build | 4 |
6 files changed, 12 insertions, 14 deletions
diff --git a/doc/c/Doxyfile.in b/doc/c/Doxyfile.in index 4bf1b42..f6990af 100644 --- a/doc/c/Doxyfile.in +++ b/doc/c/Doxyfile.in @@ -26,7 +26,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/c/api/meson.build b/doc/c/api/meson.build index 6b21aae..846dc94 100644 --- a/doc/c/api/meson.build +++ b/doc/c/api/meson.build @@ -1,9 +1,9 @@ -# Copyright 2021 David Robillard <d@drobilla.net> +# Copyright 2021-2024 David Robillard <d@drobilla.net> # SPDX-License-Identifier: 0BSD OR ISC c_pugl_rst = custom_target( - 'C API ReST Documentation', - command: [sphinxygen, '-f', '@INPUT0@', 'doc/c/api'], + 'c_pugl.rst', + command: [sphinxygen, '-f', '@INPUT0@', '@OUTDIR@'], input: [c_index_xml] + c_rst_files, output: 'pugl.rst', ) diff --git a/doc/c/event-loop.rst b/doc/c/event-loop.rst index be4e315..7bee397 100644 --- a/doc/c/event-loop.rst +++ b/doc/c/event-loop.rst @@ -23,12 +23,11 @@ while those that draw continuously may use a significant fraction of the frame p Redrawing ********* -Occasional redrawing can be requested by calling :func:`puglPostRedisplay` or :func:`puglPostRedisplayRect`. +Occasional redrawing can be requested by calling :func:`puglObscureView` or :func:`puglObscureRegion`. After these are called, a :struct:`PuglExposeEvent` will be dispatched on the next call to :func:`puglUpdate`. -For continuous redrawing, -call :func:`puglPostRedisplay` while handling a :struct:`PuglUpdateEvent` event. +For continuous redrawing, obscure the view while handling a :struct:`PuglUpdateEvent` event. 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/c/meson.build b/doc/c/meson.build index 1401aa3..ba14ca9 100644 --- a/doc/c/meson.build +++ b/doc/c/meson.build @@ -1,4 +1,4 @@ -# Copyright 2021-2022 David Robillard <d@drobilla.net> +# Copyright 2021-2024 David Robillard <d@drobilla.net> # SPDX-License-Identifier: 0BSD OR ISC config = configuration_data() @@ -43,7 +43,7 @@ subdir('xml') subdir('api') docs = custom_target( - 'singlehtml', + 'c_singlehtml', build_by_default: true, command: [ sphinx_build, @@ -61,7 +61,7 @@ docs = custom_target( ) docs = custom_target( - 'html', + 'c_html', build_by_default: true, command: [ sphinx_build, diff --git a/doc/c/view.rst b/doc/c/view.rst index 31eab21..8c74ca1 100644 --- a/doc/c/view.rst +++ b/doc/c/view.rst @@ -50,14 +50,14 @@ Embedding To embed the view in another window, you will need to somehow get the :type:`native view handle <PuglNativeView>` for the parent, -then set it with :func:`puglSetParentWindow`. +then set it with :func:`puglSetParent`. If the parent is a Pugl view, the native handle can be accessed with :func:`puglGetNativeView`. For example: .. code-block:: c - puglSetParentWindow(view, puglGetNativeView(parent)); + puglSetParent(view, puglGetNativeView(parent)); ************************ Setting an Event Handler diff --git a/doc/c/xml/meson.build b/doc/c/xml/meson.build index 8b5e0e2..3e371dc 100644 --- a/doc/c/xml/meson.build +++ b/doc/c/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 @@ c_doxyfile = configure_file( ) c_index_xml = custom_target( - 'c-index.xml', + 'c_index.xml', command: [doxygen, '@INPUT0@'], input: [c_doxyfile] + c_headers, output: 'index.xml', |