diff options
author | David Robillard <d@drobilla.net> | 2020-05-16 21:18:00 +0200 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2020-05-16 21:18:00 +0200 |
commit | a4ac15c1ee94e3a41f2bd799f6d1779428109a76 (patch) | |
tree | 2ae131e1ea45eca3f518496fba225397159469ea /pugl/detail/types.h | |
parent | ceded7cf5ec0e2bbd140899ea7d5169d7fc30a51 (diff) | |
download | pugl-a4ac15c1ee94e3a41f2bd799f6d1779428109a76.tar.gz pugl-a4ac15c1ee94e3a41f2bd799f6d1779428109a76.tar.bz2 pugl-a4ac15c1ee94e3a41f2bd799f6d1779428109a76.zip |
Use line comments where appropriate
Diffstat (limited to 'pugl/detail/types.h')
-rw-r--r-- | pugl/detail/types.h | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/pugl/detail/types.h b/pugl/detail/types.h index ee1d83d..7b15053 100644 --- a/pugl/detail/types.h +++ b/pugl/detail/types.h @@ -37,22 +37,22 @@ # define PUGL_UNUSED(name) name #endif -/** Platform-specific world internals. */ +/// Platform-specific world internals typedef struct PuglWorldInternalsImpl PuglWorldInternals; -/** Platform-specific view internals. */ +/// Platform-specific view internals typedef struct PuglInternalsImpl PuglInternals; -/** View hints. */ +/// View hints typedef int PuglHints[PUGL_NUM_VIEW_HINTS]; -/** Blob of arbitrary data. */ +/// Blob of arbitrary data typedef struct { - void* data; //!< Dynamically allocated data - size_t len; //!< Length of data in bytes + void* data; ///< Dynamically allocated data + size_t len; ///< Length of data in bytes } PuglBlob; -/** Cross-platform view definition. */ +/// Cross-platform view definition struct PuglViewImpl { PuglWorld* world; const PuglBackend* backend; @@ -75,7 +75,7 @@ struct PuglViewImpl { bool visible; }; -/** Cross-platform world definition. */ +/// Cross-platform world definition struct PuglWorldImpl { PuglWorldInternals* impl; PuglWorldHandle handle; @@ -87,27 +87,27 @@ struct PuglWorldImpl { PuglLogLevel logLevel; }; -/** Opaque surface used by graphics backend. */ +/// Opaque surface used by graphics backend typedef void PuglSurface; -/** Graphics backend interface. */ +/// Graphics backend interface struct PuglBackendImpl { - /** Get visual information from display and setup view as necessary. */ + /// Get visual information from display and setup view as necessary PuglStatus (*configure)(PuglView*); - /** Create surface and drawing context. */ + /// Create surface and drawing context PuglStatus (*create)(PuglView*); - /** Destroy surface and drawing context. */ + /// Destroy surface and drawing context PuglStatus (*destroy)(PuglView*); - /** Enter drawing context, for drawing if expose is non-null. */ + /// Enter drawing context, for drawing if expose is non-null PuglStatus (*enter)(PuglView*, const PuglEventExpose*); - /** Leave drawing context, after drawing if expose is non-null. */ + /// Leave drawing context, after drawing if expose is non-null PuglStatus (*leave)(PuglView*, const PuglEventExpose*); - /** Return the puglGetContext() handle for the application, if any. */ + /// Return the puglGetContext() handle for the application, if any void* (*getContext)(PuglView*); }; |