diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/c/event-loop.rst | 5 | ||||
| -rw-r--r-- | doc/c/view.rst | 4 | ||||
| -rw-r--r-- | doc/cpp/event-loop.rst | 5 | ||||
| -rw-r--r-- | doc/cpp/view.rst | 4 |
4 files changed, 8 insertions, 10 deletions
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/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/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/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 |