diff options
author | David Robillard <d@drobilla.net> | 2021-05-25 12:07:17 -0400 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2021-05-25 12:12:59 -0400 |
commit | e6183b3dbe6b83d642cad1dfb296083ce8c53360 (patch) | |
tree | 60ec2f11586489bcd81364654d6964d399484596 /doc/c/shutting-down.rst | |
parent | 040e94b26395451b78f5cbe0b7f208afcf28af1b (diff) | |
download | pugl-e6183b3dbe6b83d642cad1dfb296083ce8c53360.tar.gz pugl-e6183b3dbe6b83d642cad1dfb296083ce8c53360.tar.bz2 pugl-e6183b3dbe6b83d642cad1dfb296083ce8c53360.zip |
Rename event structs in a more readable style
Aside from reading more naturally, this avoids clashes with types that are not
events, like PuglEventFlags. This is also more consistent with the C++
bindings, where "EventExpose" would be quite strange, for example.
Apologies for the noise. Aliases to the old names will be preserved in the
deprecated API like other things for a short while.
Diffstat (limited to 'doc/c/shutting-down.rst')
-rw-r--r-- | doc/c/shutting-down.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/c/shutting-down.rst b/doc/c/shutting-down.rst index dfb56cd..a04c771 100644 --- a/doc/c/shutting-down.rst +++ b/doc/c/shutting-down.rst @@ -6,7 +6,7 @@ Shutting Down ############# When a view is closed, -it will receive a :struct:`PuglEventClose`. +it will receive a :struct:`PuglCloseEvent`. An application may also set a flag based on user input or other conditions, which can be used to break out of the main loop and stop calling :func:`puglUpdate`. |