aboutsummaryrefslogtreecommitdiffstats
path: root/include/pugl/pugl.h
AgeCommit message (Collapse)AuthorFilesLines
2021-01-06Fix documentation formatting issuesDavid Robillard1-15/+12
2021-01-02Add PUGL_CONST_APIDavid Robillard1-2/+5
Just a convenience macro to make declarations a little more readable.
2021-01-02Simplify visibility boilerplateDavid Robillard1-13/+6
2021-01-02Simplify clang-format configuration and format all codeDavid Robillard1-346/+416
2020-11-26Use named groups to group documentationDavid Robillard1-13/+11
We'll need identifiers for these to refer to them in the Sphinx documentation.
2020-11-26Remove top-level documentation groupDavid Robillard1-5/+0
This will not be used in Sphinx.
2020-11-26Use consistent spelling in documentationDavid Robillard1-4/+4
2020-11-26Remove file documentationDavid Robillard1-8/+3
These will not be used in the Sphinx documentation, and most were self-explanatory and only there to make the Doxygen index look nice anyway. Where there was actually useful information, it has been preserved as regular comments.
2020-11-26Don't use lists in return documentationDavid Robillard1-17/+14
This causes some annoying typesetting issues it's simpler to just avoid.
2020-11-25Rename puglShowWindow and puglHideWindow to puglShow an puglHideDavid Robillard1-2/+8
These names were confusing because a view is not necessarily a window. Since there's no room for ambiguity here, simply drop the superfluous word.
2020-11-25Move puglEnterContext and puglLeaveContext to GL backendsDavid Robillard1-30/+0
These only do anything for OpenGL, and it seems unlikely that they will ever be used for anything else. So, move them to the GL headers to remove clutter from the core API, and ensure that they are only used in GL applications that include the appropriate headers and link with a GL backend. Also add missing C++ bindings.
2020-11-01Add missing documentation for VulkanDavid Robillard1-1/+5
2020-10-30Remove logging APIDavid Robillard1-36/+0
This was missing from the C++ bindings and barely used anyway, so just remove it for now in the interests of simplicity and finalizing a stable API. The information previously logged in the X11 GL backend is now available programatically, so applications can print the same information portably if they like.
2020-10-30Clean up installed man pagesDavid Robillard1-3/+3
2020-10-30Simplify header namesDavid Robillard1-2/+2
2020-10-24Replace live resize with loop eventsDavid Robillard1-0/+34
This allows the application to control how recursive loops are handled rather than have Pugl impose behavior which can get in the way. For example, an application may not want to continuously animate while being resized, or set up its rendering differently in this situation. For example, with Vulkan, setting up a different swapchain can be necessary for smooth performance while live resizing on Windows, and Pugl has no ability to do this. I think it was a mistake to add this timer to Pugl itself, because it was always a bit of a leaky abstraction, and not very appropriate for a library that is supposed to be a thin abstraction layer. Though it almost seemed like things ran as usual while resizing on Windows and MacOS, the main event loop being stalled can be confusing, and there was no way to detect this. This way, applications must explicitly handle this situation and can implement the behavior they want without Pugl getting in the way. This also simplifies the Pugl implementation a bit, which is always nice.
2020-10-24Fix documentation typoDavid Robillard1-1/+1
2020-10-24Use single-line doc comments where possibleDavid Robillard1-90/+30
2020-10-22Resurrect puglEnterContext() and puglLeaveContext()David Robillard1-33/+28
Even though loading is now better handled with create events, there are still situations with OpenGL where it's difficult to avoid explicitly entering and leaving the context. So, resurrect these functions, but remove the drawing parameter to make it clear that they must never be used for drawing. This breaks the deprecated API since the drawing parameter would be inappropriate for the stable API, and a decent alternative name isn't available.
2020-10-21Simplify documentation structureDavid Robillard1-11/+8
2020-10-21Cleanup: Use consistent style for preprocessor conditionalsDavid Robillard1-2/+2
2020-10-21Move includes to a separate directoryDavid Robillard1-0/+1624
This is more conventional and directories named "include" are specially understood by some tooling like clang-tidy.