diff options
40 files changed, 49 insertions, 224 deletions
diff --git a/bindings/cxx/include/pugl/cairo.hpp b/bindings/cxx/include/pugl/cairo.hpp index d321b0b..7416589 100644 --- a/bindings/cxx/include/pugl/cairo.hpp +++ b/bindings/cxx/include/pugl/cairo.hpp @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file cairo.hpp - @brief Declaration of Cairo backend accessor for C++. -*/ - #ifndef PUGL_CAIRO_HPP #define PUGL_CAIRO_HPP diff --git a/bindings/cxx/include/pugl/gl.hpp b/bindings/cxx/include/pugl/gl.hpp index 529babb..d8459a8 100644 --- a/bindings/cxx/include/pugl/gl.hpp +++ b/bindings/cxx/include/pugl/gl.hpp @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file gl.hpp - @brief OpenGL-specific C++ API. -*/ - #ifndef PUGL_GL_HPP #define PUGL_GL_HPP diff --git a/bindings/cxx/include/pugl/pugl.hpp b/bindings/cxx/include/pugl/pugl.hpp index 9e391fa..83aa4a0 100644 --- a/bindings/cxx/include/pugl/pugl.hpp +++ b/bindings/cxx/include/pugl/pugl.hpp @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file pugl.hpp - @brief Pugl C++ API wrapper. -*/ - #ifndef PUGL_PUGL_HPP #define PUGL_PUGL_HPP diff --git a/bindings/cxx/include/pugl/stub.hpp b/bindings/cxx/include/pugl/stub.hpp index 02a8dc2..8b37da4 100644 --- a/bindings/cxx/include/pugl/stub.hpp +++ b/bindings/cxx/include/pugl/stub.hpp @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file stub.hpp - @brief Declaration of Stub backend accessor for C++. -*/ - #ifndef PUGL_STUB_HPP #define PUGL_STUB_HPP diff --git a/bindings/cxx/include/pugl/vulkan.hpp b/bindings/cxx/include/pugl/vulkan.hpp index aaa221f..e50cbd6 100644 --- a/bindings/cxx/include/pugl/vulkan.hpp +++ b/bindings/cxx/include/pugl/vulkan.hpp @@ -14,12 +14,10 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file vulkan.hpp Vulkan-specific C++ API. - - Note that this header includes Vulkan headers, so if you are writing a - program or plugin that dynamically loads vulkan, you should first define - `VK_NO_PROTOTYPES` before including it. +/* + Note that this header includes Vulkan headers, so if you are writing a + program or plugin that dynamically loads vulkan, you should first define + `VK_NO_PROTOTYPES` before including it. */ #ifndef PUGL_VULKAN_HPP @@ -39,10 +37,10 @@ namespace pugl { @defgroup vulkanxx Vulkan Vulkan graphics support. - Note that the Pugl C++ wrapper does not use vulkan.hpp because it is a + Note that the Pugl C++ wrapper does not use vulkan-hpp because it is a heavyweight dependency which not everyone uses, and its design is not very friendly to dynamic loading in plugins anyway. However, if you do use - vulkan.hpp smart handles, it is relatively straightforward to wrap the + vulkan-hpp smart handles, it is relatively straightforward to wrap the result of createSurface() manually. @ingroup pugl_cxx diff --git a/examples/pugl_cairo_demo.c b/examples/pugl_cairo_demo.c index c143c3c..48a02db 100644 --- a/examples/pugl_cairo_demo.c +++ b/examples/pugl_cairo_demo.c @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file pugl_cairo_demo.c - @brief An example of drawing with Cairo. -*/ - #include "demo_utils.h" #include "test/test_utils.h" diff --git a/examples/pugl_cursor_demo.c b/examples/pugl_cursor_demo.c index 916460a..f20b0ea 100644 --- a/examples/pugl_cursor_demo.c +++ b/examples/pugl_cursor_demo.c @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file pugl_cursor_demo.c - @brief An example of changing the mouse cursor. -*/ - #include "test/test_utils.h" #include "pugl/gl.h" diff --git a/examples/pugl_cxx_demo.cpp b/examples/pugl_cxx_demo.cpp index 0aa66ad..8269ae4 100644 --- a/examples/pugl_cxx_demo.cpp +++ b/examples/pugl_cxx_demo.cpp @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file pugl_cxx_demo.cpp - @brief A simple demo of the Pugl C++ API. -*/ - #include "cube_view.h" #include "demo_utils.h" #include "test/test_utils.h" diff --git a/examples/pugl_embed_demo.c b/examples/pugl_embed_demo.c index 5acef73..55480f6 100644 --- a/examples/pugl_embed_demo.c +++ b/examples/pugl_embed_demo.c @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file pugl_embed_demo.c - @brief An example of embedding a view in another. -*/ - #include "cube_view.h" #include "demo_utils.h" #include "test/test_utils.h" diff --git a/examples/pugl_print_events.c b/examples/pugl_print_events.c index 3f6bb06..8f8874b 100644 --- a/examples/pugl_print_events.c +++ b/examples/pugl_print_events.c @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file pugl_print_events.c - @brief A utility program that prints view events. -*/ - #include "test/test_utils.h" #include "pugl/pugl.h" diff --git a/examples/pugl_shader_demo.c b/examples/pugl_shader_demo.c index 3f5e7f3..800b8f0 100644 --- a/examples/pugl_shader_demo.c +++ b/examples/pugl_shader_demo.c @@ -14,25 +14,24 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file pugl_shader_demo.c - @brief An example of drawing with OpenGL 3/4. - - This is an example of using OpenGL for pixel-perfect 2D drawing. It uses - pixel coordinates for positions and sizes so that things work roughly like a - typical 2D graphics API. - - The program draws a bunch of rectangles with borders, using instancing. - Each rectangle has origin, size, and fill color attributes, which are shared - for all four vertices. On each frame, a single buffer with all the - rectangle data is sent to the GPU, and everything is drawn with a single - draw call. - - This is not particularly realistic or optimal, but serves as a decent rough - benchmark for how much simple geometry you can draw. The number of - rectangles can be given on the command line. For reference, it begins to - struggle to maintain 60 FPS on my machine (1950x + Vega64) with more than - about 100000 rectangles. +/* + An example of drawing with OpenGL 3/4. + + This is an example of using OpenGL for pixel-perfect 2D drawing. It uses + pixel coordinates for positions and sizes so that things work roughly like a + typical 2D graphics API. + + The program draws a bunch of rectangles with borders, using instancing. + Each rectangle has origin, size, and fill color attributes, which are shared + for all four vertices. On each frame, a single buffer with all the + rectangle data is sent to the GPU, and everything is drawn with a single + draw call. + + This is not particularly realistic or optimal, but serves as a decent rough + benchmark for how much simple geometry you can draw. The number of + rectangles can be given on the command line. For reference, it begins to + struggle to maintain 60 FPS on my machine (1950x + Vega64) with more than + about 100000 rectangles. */ #include "demo_utils.h" diff --git a/examples/pugl_vulkan_cxx_demo.cpp b/examples/pugl_vulkan_cxx_demo.cpp index 677750f..632f784 100644 --- a/examples/pugl_vulkan_cxx_demo.cpp +++ b/examples/pugl_vulkan_cxx_demo.cpp @@ -14,18 +14,17 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file pugl_vulkan_cxx_demo.cpp - @brief An example of drawing with Vulkan. - - This is an example of using Vulkan for pixel-perfect 2D drawing. It uses - the same data and shaders as pugl_shader_demo.c and attempts to draw the - same thing, except using Vulkan. - - Since Vulkan is a complicated and very verbose API, this example is - unfortunately much larger than the others. You should not use this as a - resource to learn Vulkan, but it provides a decent demo of using Vulkan with - Pugl that works nicely on all supported platforms. +/* + An example of drawing with Vulkan. + + This is an example of using Vulkan for pixel-perfect 2D drawing. It uses + the same data and shaders as pugl_shader_demo.c and attempts to draw the + same thing, except using Vulkan. + + Since Vulkan is a complicated and very verbose API, this example is + unfortunately much larger than the others. You should not use this as a + resource to learn Vulkan, but it provides a decent demo of using Vulkan with + Pugl that works nicely on all supported platforms. */ #include "demo_utils.h" diff --git a/examples/pugl_vulkan_demo.c b/examples/pugl_vulkan_demo.c index c609d10..ec96ec3 100644 --- a/examples/pugl_vulkan_demo.c +++ b/examples/pugl_vulkan_demo.c @@ -15,9 +15,11 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file pugl_vulkan_demo.c - @brief A simple example of drawing with Vulkan. +/* + A simple example of drawing with Vulkan. + + For a more advanced demo that actually draws something interesting, see + pugl_vulkan_cxx_demo.cpp. */ #include "demo_utils.h" diff --git a/examples/pugl_window_demo.c b/examples/pugl_window_demo.c index 080d23b..3dfc39a 100644 --- a/examples/pugl_window_demo.c +++ b/examples/pugl_window_demo.c @@ -14,9 +14,8 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file pugl_window_demo.c - @brief A demonstration of multiple Pugl windows. +/* + A demonstration of using multiple top-level windows. */ #include "cube_view.h" diff --git a/examples/rects.h b/examples/rects.h index f53698c..3537a5b 100644 --- a/examples/rects.h +++ b/examples/rects.h @@ -14,14 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file rects.h - @brief Utilities for rectangle animation demos. - - This file contains common definitions for demos that show an animation of - many 2D rectangles. -*/ - #ifndef EXAMPLES_RECTS_H #define EXAMPLES_RECTS_H diff --git a/include/pugl/cairo.h b/include/pugl/cairo.h index da9f724..d72580d 100644 --- a/include/pugl/cairo.h +++ b/include/pugl/cairo.h @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file cairo.h - @brief Declaration of Cairo backend accessor. -*/ - #ifndef PUGL_CAIRO_H #define PUGL_CAIRO_H diff --git a/include/pugl/gl.h b/include/pugl/gl.h index 79cb6e9..eb86c3d 100644 --- a/include/pugl/gl.h +++ b/include/pugl/gl.h @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file gl.h - @brief OpenGL-specific API. -*/ - #ifndef PUGL_GL_H #define PUGL_GL_H diff --git a/include/pugl/pugl.h b/include/pugl/pugl.h index d04c76f..a8f6d82 100644 --- a/include/pugl/pugl.h +++ b/include/pugl/pugl.h @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file pugl.h - @brief Pugl API. -*/ - #ifndef PUGL_PUGL_H #define PUGL_PUGL_H @@ -862,9 +857,9 @@ puglGetHandle(PuglView* view); Pugl includes the following backends: - - puglCairoBackend(), declared in pugl/cairo.h - - puglGlBackend(), declared in pugl/gl.h - - puglVulkanBackend(), declared in pugl/vulkan.h + - puglCairoBackend() + - puglGlBackend() + - puglVulkanBackend() Note that backends are modular and not compiled into the main Pugl library to avoid unnecessary dependencies. To use a particular backend, diff --git a/include/pugl/stub.h b/include/pugl/stub.h index 61791fd..d2d1236 100644 --- a/include/pugl/stub.h +++ b/include/pugl/stub.h @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file stub.h - @brief Stub backend functions and accessor declaration. -*/ - #ifndef PUGL_STUB_H #define PUGL_STUB_H diff --git a/include/pugl/vulkan.h b/include/pugl/vulkan.h index 05e13e2..bd4ad8e 100644 --- a/include/pugl/vulkan.h +++ b/include/pugl/vulkan.h @@ -14,12 +14,10 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file vulkan.h Vulkan-specific API. - - Note that this header includes Vulkan headers, so if you are writing a - program or plugin that dynamically loads vulkan, you should first define - `VK_NO_PROTOTYPES` before including it. +/* + Note that this header includes Vulkan headers, so if you are writing a + program or plugin that dynamically loads vulkan, you should first define + `VK_NO_PROTOTYPES` before including it. */ #ifndef PUGL_VULKAN_H diff --git a/src/implementation.c b/src/implementation.c index 23bfbde..e842e13 100644 --- a/src/implementation.c +++ b/src/implementation.c @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file implementation.c - @brief Platform-independent implementation. -*/ - #include "implementation.h" #include "pugl/pugl.h" diff --git a/src/implementation.h b/src/implementation.h index 6d961a8..8c5398c 100644 --- a/src/implementation.h +++ b/src/implementation.h @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file implementation.h - @brief Shared declarations for implementation. -*/ - #ifndef PUGL_IMPLEMENTATION_H #define PUGL_IMPLEMENTATION_H @@ -15,11 +15,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file mac.h - @brief Shared definitions for MacOS implementation. -*/ - #ifndef PUGL_DETAIL_MAC_H #define PUGL_DETAIL_MAC_H @@ -15,11 +15,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file mac.m - @brief MacOS implementation. -*/ - #define GL_SILENCE_DEPRECATION 1 #include "mac.h" diff --git a/src/mac_cairo.m b/src/mac_cairo.m index 1b5c667..9a46037 100644 --- a/src/mac_cairo.m +++ b/src/mac_cairo.m @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file mac_cairo.m - @brief Cairo graphics backend for MacOS. -*/ - #include "implementation.h" #include "mac.h" #include "stub.h" diff --git a/src/mac_gl.m b/src/mac_gl.m index 8a48578..b29221f 100644 --- a/src/mac_gl.m +++ b/src/mac_gl.m @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file mac_gl.m - @brief OpenGL graphics backend for MacOS. -*/ - #include "implementation.h" #include "mac.h" #include "stub.h" diff --git a/src/mac_stub.m b/src/mac_stub.m index 576734f..404d295 100644 --- a/src/mac_stub.m +++ b/src/mac_stub.m @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file mac_stub.m - @brief Stub graphics backend for MacOS. -*/ - #include "implementation.h" #include "mac.h" #include "stub.h" diff --git a/src/mac_vulkan.m b/src/mac_vulkan.m index 2d01fd4..c56346c 100644 --- a/src/mac_vulkan.m +++ b/src/mac_vulkan.m @@ -14,10 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file mac_vulkan.m Vulkan graphics backend for MacOS. -*/ - #define VK_NO_PROTOTYPES 1 #include "implementation.h" @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file stub.h - @brief Definition of generic stub backend functions. -*/ - #ifndef PUGL_DETAIL_STUB_H #define PUGL_DETAIL_STUB_H diff --git a/src/types.h b/src/types.h index a7c029a..4e63d43 100644 --- a/src/types.h +++ b/src/types.h @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file types.h - @brief Shared internal type definitions. -*/ - #ifndef PUGL_DETAIL_TYPES_H #define PUGL_DETAIL_TYPES_H @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file win.c - @brief Windows implementation. -*/ - #include "win.h" #include "implementation.h" @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file win.h - @brief Shared definitions for Windows implementation. -*/ - #ifndef PUGL_DETAIL_WIN_H #define PUGL_DETAIL_WIN_H diff --git a/src/win_cairo.c b/src/win_cairo.c index 5b6a738..bab8ea0 100644 --- a/src/win_cairo.c +++ b/src/win_cairo.c @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file win_cairo.c - @brief Cairo graphics backend for Windows. -*/ - #include "stub.h" #include "types.h" #include "win.h" diff --git a/src/win_gl.c b/src/win_gl.c index 662baef..fcf511b 100644 --- a/src/win_gl.c +++ b/src/win_gl.c @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file win_gl.c - @brief OpenGL graphics backend for Windows. -*/ - #include "stub.h" #include "types.h" #include "win.h" diff --git a/src/win_vulkan.c b/src/win_vulkan.c index 3d6934a..f862716 100644 --- a/src/win_vulkan.c +++ b/src/win_vulkan.c @@ -14,10 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file win_vulkan.c Vulkan graphics backend for Windows. -*/ - #define VK_NO_PROTOTYPES 1 #include "stub.h" @@ -16,11 +16,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file x11.c - @brief X11 implementation. -*/ - #define _POSIX_C_SOURCE 199309L #include "x11.h" @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file x11.h - @brief Shared definitions for X11 implementation. -*/ - #ifndef PUGL_DETAIL_X11_H #define PUGL_DETAIL_X11_H diff --git a/src/x11_cairo.c b/src/x11_cairo.c index abfabff..3147266 100644 --- a/src/x11_cairo.c +++ b/src/x11_cairo.c @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file x11_cairo.c - @brief Cairo graphics backend for X11. -*/ - #include "types.h" #include "x11.h" diff --git a/src/x11_gl.c b/src/x11_gl.c index 64061d1..50b37b8 100644 --- a/src/x11_gl.c +++ b/src/x11_gl.c @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file x11_gl.c - @brief OpenGL graphics backend for X11. -*/ - #include "stub.h" #include "types.h" #include "x11.h" diff --git a/src/x11_vulkan.c b/src/x11_vulkan.c index c7ae1b0..b32111c 100644 --- a/src/x11_vulkan.c +++ b/src/x11_vulkan.c @@ -14,10 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file x11_vulkan.c Vulkan graphics backend for X11. -*/ - #define VK_NO_PROTOTYPES 1 #include "stub.h" |