prymula/com: DPF-Prymula-audioplugins/dpf/dgl/src/pugl-upstream/include/pugl/pugl.h annotate

annotate DPF-Prymula-audioplugins/dpf/dgl/src/pugl-upstream/include/pugl/pugl.h @ 3:84e66ea83026

DPF-Prymula-audioplugins-0.231015-2

author	prymula <prymula76@outlook.com>
date	Mon, 16 Oct 2023 21:53:34 +0200
parents
children

rev	line source
3 84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1 // Copyright 2012-2022 David Robillard <d@drobilla.net>
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	2 // SPDX-License-Identifier: ISC
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	3
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	4 #ifndef PUGL_PUGL_H
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	5 #define PUGL_PUGL_H
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	6
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	7 #include <stddef.h>
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	8 #include <stdint.h>
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	9
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	10 #ifndef __cplusplus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	11 # include <stdbool.h>
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	12 #endif
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	13
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	14 #ifndef PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	15 # if defined(_WIN32) && !defined(PUGL_STATIC) && defined(PUGL_INTERNAL)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	16 # define PUGL_API __declspec(dllexport)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	17 # elif defined(_WIN32) && !defined(PUGL_STATIC)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	18 # define PUGL_API __declspec(dllimport)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	19 # elif defined(__GNUC__)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	20 # define PUGL_API __attribute__((visibility("default")))
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	21 # else
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	22 # define PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	23 # endif
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	24 #endif
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	25
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	26 #ifndef PUGL_DISABLE_DEPRECATED
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	27 # if defined(__clang__)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	28 # define PUGL_DEPRECATED_BY(rep) __attribute__((deprecated("", rep)))
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	29 # elif defined(__GNUC__)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	30 # define PUGL_DEPRECATED_BY(rep) __attribute__((deprecated("Use " rep)))
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	31 # else
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	32 # define PUGL_DEPRECATED_BY(rep)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	33 # endif
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	34 #endif
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	35
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	36 #if defined(__GNUC__)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	37 # define PUGL_CONST_FUNC __attribute__((const))
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	38 #else
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	39 # define PUGL_CONST_FUNC
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	40 #endif
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	41
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	42 #define PUGL_CONST_API \
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	43 PUGL_API \
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	44 PUGL_CONST_FUNC
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	45
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	46 #define PUGL_BEGIN_DECLS
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	47 #define PUGL_END_DECLS
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	48
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	49 PUGL_BEGIN_DECLS
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	50
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	51 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	52 @defgroup pugl Pugl C API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	53 Pugl C API.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	54 @{
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	55 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	56
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	57 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	58 A pixel coordinate within/of a view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	59
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	60 This is relative to the top left corner of the view's parent, or to the top
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	61 left corner of the view itself, depending on the context.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	62
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	63 There are platform-imposed limits on window positions. For portability,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	64 applications should keep coordinates between -16000 and 16000. Note that
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	65 negative frame coordinates are possible, for example with multiple screens.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	66 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	67 typedef int16_t PuglCoord;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	68
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	69 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	70 A pixel span (width or height) within/of a view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	71
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	72 Due to platform limits, the span of a view in either dimension should be
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	73 between 1 and 10000.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	74 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	75 typedef uint16_t PuglSpan;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	76
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	77 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	78 A rectangle in a view or on the screen.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	79
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	80 This type is used to describe two things: the position and size of a view
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	81 (for configuring), or a rectangle within a view (for exposing).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	82
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	83 The coordinate (0, 0) represents the top-left pixel of the parent window (or
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	84 display if there isn't one), or the top-left pixel of the view,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	85 respectively.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	86 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	87 typedef struct {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	88 PuglCoord x;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	89 PuglCoord y;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	90 PuglSpan width;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	91 PuglSpan height;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	92 } PuglRect;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	93
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	94 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	95 @defgroup events Events
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	96
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	97 All updates to the view happen via events, which are dispatched to the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	98 view's event function. Most events map directly to one from the underlying
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	99 window system, but some are constructed by Pugl itself so there is not
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	100 necessarily a direct correspondence.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	101
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	102 @{
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	103 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	104
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	105 /// Keyboard modifier flags
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	106 typedef enum {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	107 PUGL_MOD_SHIFT = 1u << 0u, ///< Shift key
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	108 PUGL_MOD_CTRL = 1u << 1u, ///< Control key
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	109 PUGL_MOD_ALT = 1u << 2u, ///< Alt/Option key
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	110 PUGL_MOD_SUPER = 1u << 3u ///< Mod4/Command/Windows key
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	111 } PuglMod;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	112
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	113 /// Bitwise OR of #PuglMod values
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	114 typedef uint32_t PuglMods;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	115
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	116 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	117 Keyboard key codepoints.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	118
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	119 All keys are identified by a Unicode code point in PuglKeyEvent::key. This
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	120 enumeration defines constants for special keys that do not have a standard
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	121 code point, and some convenience constants for control characters. Note
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	122 that all keys are handled in the same way, this enumeration is just for
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	123 convenience when writing hard-coded key bindings.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	124
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	125 Keys that do not have a standard code point use values in the Private Use
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	126 Area in the Basic Multilingual Plane (`U+E000` to `U+F8FF`). Applications
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	127 must take care to not interpret these values beyond key detection, the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	128 mapping used here is arbitrary and specific to Pugl.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	129 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	130 typedef enum {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	131 // ASCII control codes
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	132 PUGL_KEY_BACKSPACE = 0x08,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	133 PUGL_KEY_ESCAPE = 0x1B,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	134 PUGL_KEY_DELETE = 0x7F,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	135
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	136 // Unicode Private Use Area
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	137 PUGL_KEY_F1 = 0xE000,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	138 PUGL_KEY_F2,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	139 PUGL_KEY_F3,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	140 PUGL_KEY_F4,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	141 PUGL_KEY_F5,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	142 PUGL_KEY_F6,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	143 PUGL_KEY_F7,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	144 PUGL_KEY_F8,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	145 PUGL_KEY_F9,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	146 PUGL_KEY_F10,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	147 PUGL_KEY_F11,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	148 PUGL_KEY_F12,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	149 PUGL_KEY_LEFT,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	150 PUGL_KEY_UP,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	151 PUGL_KEY_RIGHT,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	152 PUGL_KEY_DOWN,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	153 PUGL_KEY_PAGE_UP,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	154 PUGL_KEY_PAGE_DOWN,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	155 PUGL_KEY_HOME,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	156 PUGL_KEY_END,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	157 PUGL_KEY_INSERT,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	158 PUGL_KEY_SHIFT,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	159 PUGL_KEY_SHIFT_L = PUGL_KEY_SHIFT,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	160 PUGL_KEY_SHIFT_R,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	161 PUGL_KEY_CTRL,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	162 PUGL_KEY_CTRL_L = PUGL_KEY_CTRL,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	163 PUGL_KEY_CTRL_R,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	164 PUGL_KEY_ALT,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	165 PUGL_KEY_ALT_L = PUGL_KEY_ALT,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	166 PUGL_KEY_ALT_R,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	167 PUGL_KEY_SUPER,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	168 PUGL_KEY_SUPER_L = PUGL_KEY_SUPER,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	169 PUGL_KEY_SUPER_R,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	170 PUGL_KEY_MENU,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	171 PUGL_KEY_CAPS_LOCK,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	172 PUGL_KEY_SCROLL_LOCK,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	173 PUGL_KEY_NUM_LOCK,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	174 PUGL_KEY_PRINT_SCREEN,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	175 PUGL_KEY_PAUSE
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	176 } PuglKey;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	177
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	178 /// The type of a PuglEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	179 typedef enum {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	180 PUGL_NOTHING, ///< No event
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	181 PUGL_CREATE, ///< View created, a #PuglCreateEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	182 PUGL_DESTROY, ///< View destroyed, a #PuglDestroyEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	183 PUGL_CONFIGURE, ///< View moved/resized, a #PuglConfigureEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	184 PUGL_MAP, ///< View made visible, a #PuglMapEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	185 PUGL_UNMAP, ///< View made invisible, a #PuglUnmapEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	186 PUGL_UPDATE, ///< View ready to draw, a #PuglUpdateEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	187 PUGL_EXPOSE, ///< View must be drawn, a #PuglExposeEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	188 PUGL_CLOSE, ///< View will be closed, a #PuglCloseEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	189 PUGL_FOCUS_IN, ///< Keyboard focus entered view, a #PuglFocusEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	190 PUGL_FOCUS_OUT, ///< Keyboard focus left view, a #PuglFocusEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	191 PUGL_KEY_PRESS, ///< Key pressed, a #PuglKeyEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	192 PUGL_KEY_RELEASE, ///< Key released, a #PuglKeyEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	193 PUGL_TEXT, ///< Character entered, a #PuglTextEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	194 PUGL_POINTER_IN, ///< Pointer entered view, a #PuglCrossingEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	195 PUGL_POINTER_OUT, ///< Pointer left view, a #PuglCrossingEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	196 PUGL_BUTTON_PRESS, ///< Mouse button pressed, a #PuglButtonEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	197 PUGL_BUTTON_RELEASE, ///< Mouse button released, a #PuglButtonEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	198 PUGL_MOTION, ///< Pointer moved, a #PuglMotionEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	199 PUGL_SCROLL, ///< Scrolled, a #PuglScrollEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	200 PUGL_CLIENT, ///< Custom client message, a #PuglClientEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	201 PUGL_TIMER, ///< Timer triggered, a #PuglTimerEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	202 PUGL_LOOP_ENTER, ///< Recursive loop entered, a #PuglLoopEnterEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	203 PUGL_LOOP_LEAVE, ///< Recursive loop left, a #PuglLoopLeaveEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	204 PUGL_DATA_OFFER, ///< Data offered from clipboard, a #PuglDataOfferEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	205 PUGL_DATA, ///< Data available from clipboard, a #PuglDataEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	206 } PuglEventType;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	207
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	208 /// Common flags for all event types
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	209 typedef enum {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	210 PUGL_IS_SEND_EVENT = 1, ///< Event is synthetic
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	211 PUGL_IS_HINT = 2 ///< Event is a hint (not direct user input)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	212 } PuglEventFlag;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	213
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	214 /// Bitwise OR of #PuglEventFlag values
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	215 typedef uint32_t PuglEventFlags;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	216
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	217 /// Reason for a PuglCrossingEvent
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	218 typedef enum {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	219 PUGL_CROSSING_NORMAL, ///< Crossing due to pointer motion
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	220 PUGL_CROSSING_GRAB, ///< Crossing due to a grab
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	221 PUGL_CROSSING_UNGRAB ///< Crossing due to a grab release
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	222 } PuglCrossingMode;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	223
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	224 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	225 Scroll direction.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	226
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	227 Describes the direction of a #PuglScrollEvent along with whether the scroll
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	228 is a "smooth" scroll. The discrete directions are for devices like mouse
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	229 wheels with constrained axes, while a smooth scroll is for those with
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	230 arbitrary scroll direction freedom, like some touchpads.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	231 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	232 typedef enum {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	233 PUGL_SCROLL_UP, ///< Scroll up
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	234 PUGL_SCROLL_DOWN, ///< Scroll down
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	235 PUGL_SCROLL_LEFT, ///< Scroll left
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	236 PUGL_SCROLL_RIGHT, ///< Scroll right
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	237 PUGL_SCROLL_SMOOTH ///< Smooth scroll in any direction
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	238 } PuglScrollDirection;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	239
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	240 /// Common header for all event structs
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	241 typedef struct {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	242 PuglEventType type; ///< Event type
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	243 PuglEventFlags flags; ///< Bitwise OR of #PuglEventFlag values
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	244 } PuglAnyEvent;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	245
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	246 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	247 View create event.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	248
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	249 This event is sent when a view is realized before it is first displayed,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	250 with the graphics context entered. This is typically used for setting up
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	251 the graphics system, for example by loading OpenGL extensions.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	252
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	253 This event type has no extra fields.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	254 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	255 typedef PuglAnyEvent PuglCreateEvent;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	256
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	257 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	258 View destroy event.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	259
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	260 This event is the counterpart to #PuglCreateEvent, and it is sent when the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	261 view is being destroyed. This is typically used for tearing down the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	262 graphics system, or otherwise freeing any resources allocated when the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	263 create event was handled.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	264
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	265 This is the last event sent to any view, and immediately after it is
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	266 processed, the view is destroyed and may no longer be used.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	267
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	268 This event type has no extra fields.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	269 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	270 typedef PuglAnyEvent PuglDestroyEvent;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	271
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	272 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	273 View resize or move event.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	274
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	275 A configure event is sent whenever the view is resized or moved. When a
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	276 configure event is received, the graphics context is active but not set up
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	277 for drawing. For example, it is valid to adjust the OpenGL viewport or
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	278 otherwise configure the context, but not to draw anything.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	279 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	280 typedef struct {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	281 PuglEventType type; ///< #PUGL_CONFIGURE
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	282 PuglEventFlags flags; ///< Bitwise OR of #PuglEventFlag values
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	283 PuglCoord x; ///< Parent-relative X coordinate of view
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	284 PuglCoord y; ///< Parent-relative Y coordinate of view
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	285 PuglSpan width; ///< Width of view
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	286 PuglSpan height; ///< Height of view
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	287 } PuglConfigureEvent;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	288
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	289 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	290 View show event.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	291
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	292 This event is sent when a view is mapped to the screen and made visible.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	293
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	294 This event type has no extra fields.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	295 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	296 typedef PuglAnyEvent PuglMapEvent;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	297
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	298 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	299 View hide event.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	300
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	301 This event is sent when a view is unmapped from the screen and made
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	302 invisible.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	303
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	304 This event type has no extra fields.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	305 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	306 typedef PuglAnyEvent PuglUnmapEvent;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	307
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	308 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	309 View update event.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	310
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	311 This event is sent to every view near the end of a main loop iteration when
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	312 any pending exposures are about to be redrawn. It is typically used to mark
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	313 regions to expose with puglPostRedisplay() or puglPostRedisplayRect(). For
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	314 example, to continuously animate, a view calls puglPostRedisplay() when an
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	315 update event is received, and it will then shortly receive an expose event.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	316 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	317 typedef PuglAnyEvent PuglUpdateEvent;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	318
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	319 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	320 Expose event for when a region must be redrawn.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	321
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	322 When an expose event is received, the graphics context is active, and the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	323 view must draw the entire specified region. The contents of the region are
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	324 undefined, there is no preservation of anything drawn previously.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	325 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	326 typedef struct {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	327 PuglEventType type; ///< #PUGL_EXPOSE
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	328 PuglEventFlags flags; ///< Bitwise OR of #PuglEventFlag values
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	329 PuglCoord x; ///< View-relative top-left X coordinate of region
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	330 PuglCoord y; ///< View-relative top-left Y coordinate of region
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	331 PuglSpan width; ///< Width of exposed region
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	332 PuglSpan height; ///< Height of exposed region
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	333 } PuglExposeEvent;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	334
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	335 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	336 View close event.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	337
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	338 This event is sent when the view is to be closed, for example when the user
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	339 clicks the close button.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	340
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	341 This event type has no extra fields.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	342 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	343 typedef PuglAnyEvent PuglCloseEvent;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	344
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	345 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	346 Keyboard focus event.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	347
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	348 This event is sent whenever the view gains or loses the keyboard focus. The
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	349 view with the keyboard focus will receive any key press or release events.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	350 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	351 typedef struct {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	352 PuglEventType type; ///< #PUGL_FOCUS_IN or #PUGL_FOCUS_OUT
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	353 PuglEventFlags flags; ///< Bitwise OR of #PuglEventFlag values
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	354 PuglCrossingMode mode; ///< Reason for focus change
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	355 } PuglFocusEvent;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	356
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	357 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	358 Key press or release event.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	359
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	360 This event represents low-level key presses and releases. This can be used
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	361 for "direct" keyboard handing like key bindings, but must not be interpreted
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	362 as text input.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	363
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	364 Keys are represented portably as Unicode code points, using the "natural"
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	365 code point for the key where possible (see #PuglKey for details). The `key`
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	366 field is the code for the pressed key, without any modifiers applied. For
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	367 example, a press or release of the 'A' key will have `key` 97 ('a')
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	368 regardless of whether shift or control are being held.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	369
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	370 Alternatively, the raw `keycode` can be used to work directly with physical
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	371 keys, but note that this value is not portable and differs between platforms
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	372 and hardware.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	373 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	374 typedef struct {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	375 PuglEventType type; ///< #PUGL_KEY_PRESS or #PUGL_KEY_RELEASE
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	376 PuglEventFlags flags; ///< Bitwise OR of #PuglEventFlag values
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	377 double time; ///< Time in seconds
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	378 double x; ///< View-relative X coordinate
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	379 double y; ///< View-relative Y coordinate
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	380 double xRoot; ///< Root-relative X coordinate
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	381 double yRoot; ///< Root-relative Y coordinate
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	382 PuglMods state; ///< Bitwise OR of #PuglMod flags
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	383 uint32_t keycode; ///< Raw key code
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	384 uint32_t key; ///< Unshifted Unicode character code, or 0
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	385 } PuglKeyEvent;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	386
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	387 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	388 Character input event.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	389
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	390 This event represents text input, usually as the result of a key press. The
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	391 text is given both as a Unicode character code and a UTF-8 string.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	392
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	393 Note that this event is generated by the platform's input system, so there
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	394 is not necessarily a direct correspondence between text events and physical
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	395 key presses. For example, with some input methods a sequence of several key
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	396 presses will generate a single character.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	397 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	398 typedef struct {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	399 PuglEventType type; ///< #PUGL_TEXT
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	400 PuglEventFlags flags; ///< Bitwise OR of #PuglEventFlag values
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	401 double time; ///< Time in seconds
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	402 double x; ///< View-relative X coordinate
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	403 double y; ///< View-relative Y coordinate
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	404 double xRoot; ///< Root-relative X coordinate
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	405 double yRoot; ///< Root-relative Y coordinate
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	406 PuglMods state; ///< Bitwise OR of #PuglMod flags
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	407 uint32_t keycode; ///< Raw key code
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	408 uint32_t character; ///< Unicode character code
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	409 char string[8]; ///< UTF-8 string
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	410 } PuglTextEvent;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	411
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	412 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	413 Pointer enter or leave event.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	414
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	415 This event is sent when the pointer enters or leaves the view. This can
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	416 happen for several reasons (not just the user dragging the pointer over the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	417 window edge), as described by the `mode` field.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	418 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	419 typedef struct {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	420 PuglEventType type; ///< #PUGL_POINTER_IN or #PUGL_POINTER_OUT
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	421 PuglEventFlags flags; ///< Bitwise OR of #PuglEventFlag values
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	422 double time; ///< Time in seconds
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	423 double x; ///< View-relative X coordinate
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	424 double y; ///< View-relative Y coordinate
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	425 double xRoot; ///< Root-relative X coordinate
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	426 double yRoot; ///< Root-relative Y coordinate
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	427 PuglMods state; ///< Bitwise OR of #PuglMod flags
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	428 PuglCrossingMode mode; ///< Reason for crossing
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	429 } PuglCrossingEvent;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	430
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	431 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	432 Button press or release event.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	433
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	434 Button numbers start from 0, and are ordered: primary, secondary, middle.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	435 So, on a typical right-handed mouse, the button numbers are:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	436
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	437 Left: 0
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	438 Right: 1
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	439 Middle (often a wheel): 2
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	440
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	441 Higher button numbers are reported in the same order they are represented on
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	442 the system. There is no universal standard here, but buttons 3 and 4 are
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	443 typically a pair of buttons or a rocker, which are usually bound to "back"
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	444 and "forward" operations.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	445
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	446 Note that these numbers may differ from those used on the underlying
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	447 platform, since they are manipulated to provide a consistent portable API.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	448 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	449 typedef struct {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	450 PuglEventType type; ///< #PUGL_BUTTON_PRESS or #PUGL_BUTTON_RELEASE
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	451 PuglEventFlags flags; ///< Bitwise OR of #PuglEventFlag values
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	452 double time; ///< Time in seconds
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	453 double x; ///< View-relative X coordinate
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	454 double y; ///< View-relative Y coordinate
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	455 double xRoot; ///< Root-relative X coordinate
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	456 double yRoot; ///< Root-relative Y coordinate
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	457 PuglMods state; ///< Bitwise OR of #PuglMod flags
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	458 uint32_t button; ///< Button number starting from 0
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	459 } PuglButtonEvent;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	460
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	461 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	462 Pointer motion event.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	463 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	464 typedef struct {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	465 PuglEventType type; ///< #PUGL_MOTION
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	466 PuglEventFlags flags; ///< Bitwise OR of #PuglEventFlag values
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	467 double time; ///< Time in seconds
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	468 double x; ///< View-relative X coordinate
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	469 double y; ///< View-relative Y coordinate
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	470 double xRoot; ///< Root-relative X coordinate
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	471 double yRoot; ///< Root-relative Y coordinate
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	472 PuglMods state; ///< Bitwise OR of #PuglMod flags
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	473 } PuglMotionEvent;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	474
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	475 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	476 Scroll event.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	477
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	478 The scroll distance is expressed in "lines", an arbitrary unit that
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	479 corresponds to a single tick of a detented mouse wheel. For example, `dy` =
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	480 1.0 scrolls 1 line up. Some systems and devices support finer resolution
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	481 and/or higher values for fast scrolls, so programs should handle any value
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	482 gracefully.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	483 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	484 typedef struct {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	485 PuglEventType type; ///< #PUGL_SCROLL
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	486 PuglEventFlags flags; ///< Bitwise OR of #PuglEventFlag values
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	487 double time; ///< Time in seconds
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	488 double x; ///< View-relative X coordinate
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	489 double y; ///< View-relative Y coordinate
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	490 double xRoot; ///< Root-relative X coordinate
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	491 double yRoot; ///< Root-relative Y coordinate
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	492 PuglMods state; ///< Bitwise OR of #PuglMod flags
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	493 PuglScrollDirection direction; ///< Scroll direction
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	494 double dx; ///< Scroll X distance in lines
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	495 double dy; ///< Scroll Y distance in lines
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	496 } PuglScrollEvent;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	497
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	498 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	499 Custom client message event.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	500
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	501 This can be used to send a custom message to a view, which is delivered via
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	502 the window system and processed in the event loop as usual. Among other
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	503 things, this makes it possible to wake up the event loop for any reason.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	504 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	505 typedef struct {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	506 PuglEventType type; ///< #PUGL_CLIENT
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	507 PuglEventFlags flags; ///< Bitwise OR of #PuglEventFlag values
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	508 uintptr_t data1; ///< Client-specific data
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	509 uintptr_t data2; ///< Client-specific data
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	510 } PuglClientEvent;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	511
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	512 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	513 Timer event.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	514
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	515 This event is sent at the regular interval specified in the call to
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	516 puglStartTimer() that activated it.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	517
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	518 The `id` is the application-specific ID given to puglStartTimer() which
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	519 distinguishes this timer from others. It should always be checked in the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	520 event handler, even in applications that register only one timer.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	521 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	522 typedef struct {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	523 PuglEventType type; ///< #PUGL_TIMER
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	524 PuglEventFlags flags; ///< Bitwise OR of #PuglEventFlag values
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	525 uintptr_t id; ///< Timer ID
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	526 } PuglTimerEvent;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	527
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	528 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	529 Clipboard data offer event.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	530
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	531 This event is sent when a clipboard has data present, possibly with several
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	532 datatypes. While handling this event, the types can be investigated with
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	533 puglGetClipboardType() to decide whether to accept the offer with
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	534 puglAcceptOffer().
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	535 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	536 typedef struct {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	537 PuglEventType type; ///< #PUGL_DATA_OFFER
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	538 PuglEventFlags flags; ///< Bitwise OR of #PuglEventFlag values
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	539 double time; ///< Time in seconds
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	540 } PuglDataOfferEvent;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	541
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	542 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	543 Clipboard data event.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	544
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	545 This event is sent after accepting a data offer when the data has been
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	546 retrieved and converted. While handling this event, the data can be
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	547 accessed with puglGetClipboard().
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	548 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	549 typedef struct {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	550 PuglEventType type; ///< #PUGL_DATA
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	551 PuglEventFlags flags; ///< Bitwise OR of #PuglEventFlag values
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	552 double time; ///< Time in seconds
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	553 uint32_t typeIndex; ///< Index of datatype
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	554 } PuglDataEvent;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	555
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	556 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	557 Recursive loop enter event.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	558
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	559 This event is sent when the window system enters a recursive loop. The main
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	560 loop will be stalled and no expose events will be received while in the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	561 recursive loop. To give the application full control, Pugl does not do any
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	562 special handling of this situation, but this event can be used to install a
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	563 timer to perform continuous actions (such as drawing) on platforms that do
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	564 this.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	565
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	566 - MacOS: A recursive loop is entered while the window is being live resized.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	567
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	568 - Windows: A recursive loop is entered while the window is being live
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	569 resized or the menu is shown.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	570
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	571 - X11: A recursive loop is never entered and the event loop runs as usual
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	572 while the view is being resized.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	573
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	574 This event type has no extra fields.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	575 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	576 typedef PuglAnyEvent PuglLoopEnterEvent;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	577
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	578 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	579 Recursive loop leave event.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	580
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	581 This event is sent after a loop enter event when the recursive loop is
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	582 finished and normal iteration will continue.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	583
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	584 This event type has no extra fields.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	585 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	586 typedef PuglAnyEvent PuglLoopLeaveEvent;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	587
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	588 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	589 View event.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	590
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	591 This is a union of all event types. The type must be checked to determine
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	592 which fields are safe to access. A pointer to PuglEvent can either be cast
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	593 to the appropriate type, or the union members used.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	594
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	595 The graphics system may only be accessed when handling certain events. The
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	596 graphics context is active for #PUGL_CREATE, #PUGL_DESTROY, #PUGL_CONFIGURE,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	597 and #PUGL_EXPOSE, but only enabled for drawing for #PUGL_EXPOSE.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	598 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	599 typedef union {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	600 PuglAnyEvent any; ///< Valid for all event types
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	601 PuglEventType type; ///< Event type
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	602 PuglButtonEvent button; ///< #PUGL_BUTTON_PRESS, #PUGL_BUTTON_RELEASE
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	603 PuglConfigureEvent configure; ///< #PUGL_CONFIGURE
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	604 PuglExposeEvent expose; ///< #PUGL_EXPOSE
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	605 PuglKeyEvent key; ///< #PUGL_KEY_PRESS, #PUGL_KEY_RELEASE
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	606 PuglTextEvent text; ///< #PUGL_TEXT
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	607 PuglCrossingEvent crossing; ///< #PUGL_POINTER_IN, #PUGL_POINTER_OUT
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	608 PuglMotionEvent motion; ///< #PUGL_MOTION
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	609 PuglScrollEvent scroll; ///< #PUGL_SCROLL
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	610 PuglFocusEvent focus; ///< #PUGL_FOCUS_IN, #PUGL_FOCUS_OUT
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	611 PuglClientEvent client; ///< #PUGL_CLIENT
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	612 PuglTimerEvent timer; ///< #PUGL_TIMER
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	613 PuglDataOfferEvent offer; ///< #PUGL_DATA_OFFER
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	614 PuglDataEvent data; ///< #PUGL_DATA
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	615 } PuglEvent;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	616
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	617 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	618 @}
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	619 @defgroup status Status
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	620
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	621 Most functions return a status code which can be used to check for errors.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	622
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	623 @{
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	624 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	625
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	626 /// Return status code
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	627 typedef enum {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	628 PUGL_SUCCESS, ///< Success
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	629 PUGL_FAILURE, ///< Non-fatal failure
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	630 PUGL_UNKNOWN_ERROR, ///< Unknown system error
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	631 PUGL_BAD_BACKEND, ///< Invalid or missing backend
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	632 PUGL_BAD_CONFIGURATION, ///< Invalid view configuration
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	633 PUGL_BAD_PARAMETER, ///< Invalid parameter
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	634 PUGL_BACKEND_FAILED, ///< Backend initialization failed
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	635 PUGL_REGISTRATION_FAILED, ///< Class registration failed
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	636 PUGL_REALIZE_FAILED, ///< System view realization failed
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	637 PUGL_SET_FORMAT_FAILED, ///< Failed to set pixel format
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	638 PUGL_CREATE_CONTEXT_FAILED, ///< Failed to create drawing context
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	639 PUGL_UNSUPPORTED, ///< Unsupported operation
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	640 PUGL_NO_MEMORY, ///< Failed to allocate memory
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	641 } PuglStatus;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	642
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	643 /// Return a string describing a status code
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	644 PUGL_CONST_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	645 const char*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	646 puglStrerror(PuglStatus status);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	647
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	648 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	649 @}
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	650 @defgroup world World
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	651
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	652 The top-level context of a Pugl application or plugin.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	653
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	654 The world contains all library-wide state. There is no static data in Pugl,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	655 so it is safe to use multiple worlds in a single process. This is to
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	656 facilitate plugins or other situations where it is not possible to share a
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	657 world, but a single world should be shared for all views where possible.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	658
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	659 @{
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	660 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	661
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	662 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	663 The "world" of application state.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	664
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	665 The world represents everything that is not associated with a particular
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	666 view. Several worlds can be created in a single process, but code using
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	667 different worlds must be isolated so they are never mixed. Views are
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	668 strongly associated with the world they were created in.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	669 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	670 typedef struct PuglWorldImpl PuglWorld;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	671
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	672 /// Handle for the world's opaque user data
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	673 typedef void* PuglWorldHandle;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	674
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	675 /// The type of a World
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	676 typedef enum {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	677 PUGL_PROGRAM, ///< Top-level application
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	678 PUGL_MODULE ///< Plugin or module within a larger application
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	679 } PuglWorldType;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	680
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	681 /// World flags
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	682 typedef enum {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	683 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	684 Set up support for threads if necessary.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	685
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	686 X11: Calls XInitThreads() which is required for some drivers.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	687 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	688 PUGL_WORLD_THREADS = 1u << 0u
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	689 } PuglWorldFlag;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	690
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	691 /// Bitwise OR of #PuglWorldFlag values
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	692 typedef uint32_t PuglWorldFlags;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	693
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	694 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	695 Create a new world.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	696
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	697 @param type The type, which dictates what this world is responsible for.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	698 @param flags Flags to control world features.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	699 @return A new world, which must be later freed with puglFreeWorld().
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	700 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	701 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	702 PuglWorld*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	703 puglNewWorld(PuglWorldType type, PuglWorldFlags flags);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	704
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	705 /// Free a world allocated with puglNewWorld()
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	706 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	707 void
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	708 puglFreeWorld(PuglWorld* world);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	709
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	710 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	711 Set the user data for the world.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	712
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	713 This is usually a pointer to a struct that contains all the state which must
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	714 be accessed by several views.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	715
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	716 The handle is opaque to Pugl and is not interpreted in any way.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	717 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	718 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	719 void
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	720 puglSetWorldHandle(PuglWorld* world, PuglWorldHandle handle);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	721
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	722 /// Get the user data for the world
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	723 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	724 PuglWorldHandle
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	725 puglGetWorldHandle(PuglWorld* world);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	726
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	727 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	728 Return a pointer to the native handle of the world.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	729
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	730 X11: Returns a pointer to the `Display`.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	731
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	732 MacOS: Returns a pointer to the `NSApplication`.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	733
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	734 Windows: Returns the `HMODULE` of the calling process.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	735 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	736 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	737 void*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	738 puglGetNativeWorld(PuglWorld* world);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	739
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	740 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	741 Set the class name of the application.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	742
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	743 This is a stable identifier for the application, used as the window
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	744 class/instance name on X11 and Windows. It is not displayed to the user,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	745 but can be used in scripts and by window managers, so it should be the same
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	746 for every instance of the application, but different from other
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	747 applications.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	748 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	749 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	750 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	751 puglSetClassName(PuglWorld* world, const char* name);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	752
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	753 /// Get the class name of the application, or null
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	754 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	755 const char*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	756 puglGetClassName(const PuglWorld* world);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	757
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	758 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	759 Return the time in seconds.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	760
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	761 This is a monotonically increasing clock with high resolution. The returned
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	762 time is only useful to compare against other times returned by this
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	763 function, its absolute value has no meaning.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	764 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	765 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	766 double
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	767 puglGetTime(const PuglWorld* world);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	768
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	769 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	770 Update by processing events from the window system.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	771
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	772 This function is a single iteration of the main loop, and should be called
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	773 repeatedly to update all views.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	774
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	775 If `timeout` is zero, then this function will not block. Plugins should
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	776 always use a timeout of zero to avoid blocking the host.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	777
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	778 If a positive `timeout` is given, then events will be processed for that
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	779 amount of time, starting from when this function was called.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	780
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	781 If a negative `timeout` is given, this function will block indefinitely
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	782 until an event occurs.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	783
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	784 For continuously animating programs, a timeout that is a reasonable fraction
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	785 of the ideal frame period should be used, to minimize input latency by
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	786 ensuring that as many input events are consumed as possible before drawing.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	787
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	788 @return #PUGL_SUCCESS if events are read, #PUGL_FAILURE if no events are
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	789 read, or an error.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	790 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	791 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	792 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	793 puglUpdate(PuglWorld* world, double timeout);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	794
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	795 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	796 @}
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	797 @defgroup view View
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	798
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	799 A drawable region that receives events.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	800
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	801 A view can be thought of as a window, but does not necessarily correspond to
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	802 a top-level window in a desktop environment. For example, a view can be
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	803 embedded in some other window, or represent an embedded system where there
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	804 is no concept of multiple windows at all.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	805
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	806 @{
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	807 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	808
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	809 /// A drawable region that receives events
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	810 typedef struct PuglViewImpl PuglView;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	811
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	812 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	813 A graphics backend.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	814
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	815 The backend dictates how graphics are set up for a view, and how drawing is
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	816 performed. A backend must be set by calling puglSetBackend() before
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	817 realising a view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	818
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	819 If you are using a local copy of Pugl, it is possible to implement a custom
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	820 backend. See the definition of `PuglBackendImpl` in the source code for
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	821 details.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	822 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	823 typedef struct PuglBackendImpl PuglBackend;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	824
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	825 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	826 A native view handle.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	827
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	828 X11: This is a `Window`.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	829
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	830 MacOS: This is a pointer to an `NSView*`.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	831
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	832 Windows: This is a `HWND`.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	833 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	834 typedef uintptr_t PuglNativeView;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	835
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	836 /// Handle for a view's opaque user data
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	837 typedef void* PuglHandle;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	838
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	839 /// A hint for configuring a view
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	840 typedef enum {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	841 PUGL_USE_COMPAT_PROFILE, ///< Use compatible (not core) OpenGL profile
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	842 PUGL_USE_DEBUG_CONTEXT, ///< True to use a debug OpenGL context
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	843 PUGL_CONTEXT_VERSION_MAJOR, ///< OpenGL context major version
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	844 PUGL_CONTEXT_VERSION_MINOR, ///< OpenGL context minor version
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	845 PUGL_RED_BITS, ///< Number of bits for red channel
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	846 PUGL_GREEN_BITS, ///< Number of bits for green channel
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	847 PUGL_BLUE_BITS, ///< Number of bits for blue channel
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	848 PUGL_ALPHA_BITS, ///< Number of bits for alpha channel
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	849 PUGL_DEPTH_BITS, ///< Number of bits for depth buffer
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	850 PUGL_STENCIL_BITS, ///< Number of bits for stencil buffer
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	851 PUGL_SAMPLES, ///< Number of samples per pixel (AA)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	852 PUGL_DOUBLE_BUFFER, ///< True if double buffering should be used
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	853 PUGL_SWAP_INTERVAL, ///< Number of frames between buffer swaps
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	854 PUGL_RESIZABLE, ///< True if view should be resizable
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	855 PUGL_IGNORE_KEY_REPEAT, ///< True if key repeat events are ignored
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	856 PUGL_REFRESH_RATE, ///< Refresh rate in Hz
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	857 } PuglViewHint;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	858
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	859 /// The number of #PuglViewHint values
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	860 #define PUGL_NUM_VIEW_HINTS ((unsigned)PUGL_REFRESH_RATE + 1u)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	861
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	862 /// A special view hint value
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	863 typedef enum {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	864 PUGL_DONT_CARE = -1, ///< Use best available value
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	865 PUGL_FALSE = 0, ///< Explicitly false
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	866 PUGL_TRUE = 1 ///< Explicitly true
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	867 } PuglViewHintValue;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	868
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	869 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	870 A hint for configuring/constraining the size of a view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	871
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	872 The system will attempt to make the view's window adhere to these, but they
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	873 are suggestions, not hard constraints. Applications should handle any view
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	874 size gracefully.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	875 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	876 typedef enum {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	877 PUGL_DEFAULT_SIZE, ///< Default size
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	878 PUGL_MIN_SIZE, ///< Minimum size
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	879 PUGL_MAX_SIZE, ///< Maximum size
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	880
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	881 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	882 Fixed aspect ratio.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	883
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	884 If set, the view's size should be constrained to this aspect ratio.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	885 Mutually exclusive with #PUGL_MIN_ASPECT and #PUGL_MAX_ASPECT.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	886 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	887 PUGL_FIXED_ASPECT,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	888
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	889 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	890 Minimum aspect ratio.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	891
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	892 If set, the view's size should be constrained to an aspect ratio no lower
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	893 than this. Mutually exclusive with #PUGL_FIXED_ASPECT.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	894 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	895 PUGL_MIN_ASPECT,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	896
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	897 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	898 Maximum aspect ratio.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	899
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	900 If set, the view's size should be constrained to an aspect ratio no higher
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	901 than this. Mutually exclusive with #PUGL_FIXED_ASPECT.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	902 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	903 PUGL_MAX_ASPECT
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	904 } PuglSizeHint;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	905
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	906 /// The number of #PuglSizeHint values
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	907 #define PUGL_NUM_SIZE_HINTS ((unsigned)PUGL_MAX_ASPECT + 1u)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	908
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	909 /// A function called when an event occurs
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	910 typedef PuglStatus (PuglEventFunc)(PuglView view, const PuglEvent* event);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	911
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	912 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	913 @defgroup setup Setup
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	914 Functions for creating and destroying a view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	915 @{
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	916 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	917
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	918 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	919 Create a new view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	920
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	921 A newly created view does not correspond to a real system view or window.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	922 It must first be configured, then the system view can be created with
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	923 puglRealize().
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	924 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	925 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	926 PuglView*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	927 puglNewView(PuglWorld* world);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	928
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	929 /// Free a view created with puglNewView()
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	930 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	931 void
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	932 puglFreeView(PuglView* view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	933
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	934 /// Return the world that `view` is a part of
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	935 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	936 PuglWorld*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	937 puglGetWorld(PuglView* view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	938
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	939 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	940 Set the user data for a view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	941
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	942 This is usually a pointer to a struct that contains all the state which must
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	943 be accessed by a view. Everything needed to process events should be stored
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	944 here, not in static variables.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	945
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	946 The handle is opaque to Pugl and is not interpreted in any way.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	947 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	948 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	949 void
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	950 puglSetHandle(PuglView* view, PuglHandle handle);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	951
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	952 /// Get the user data for a view
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	953 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	954 PuglHandle
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	955 puglGetHandle(PuglView* view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	956
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	957 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	958 Set the graphics backend to use for a view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	959
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	960 This must be called once to set the graphics backend before calling
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	961 puglRealize().
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	962
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	963 Pugl includes the following backends:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	964
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	965 - puglCairoBackend()
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	966 - puglGlBackend()
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	967 - puglVulkanBackend()
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	968
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	969 Note that backends are modular and not compiled into the main Pugl library
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	970 to avoid unnecessary dependencies. To use a particular backend,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	971 applications must link against the appropriate backend library, or be sure
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	972 to compile in the appropriate code if using a local copy of Pugl.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	973 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	974 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	975 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	976 puglSetBackend(PuglView* view, const PuglBackend* backend);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	977
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	978 /// Return the graphics backend used by a view
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	979 const PuglBackend*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	980 puglGetBackend(const PuglView* view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	981
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	982 /// Set the function to call when an event occurs
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	983 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	984 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	985 puglSetEventFunc(PuglView* view, PuglEventFunc eventFunc);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	986
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	987 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	988 Set a hint to configure view properties.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	989
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	990 This only has an effect when called before puglRealize().
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	991 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	992 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	993 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	994 puglSetViewHint(PuglView* view, PuglViewHint hint, int value);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	995
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	996 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	997 Get the value for a view hint.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	998
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	999 If the view has been realized, this can be used to get the actual value of a
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1000 hint which was initially set to PUGL_DONT_CARE, or has been adjusted from
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1001 the suggested value.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1002 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1003 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1004 int
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1005 puglGetViewHint(const PuglView* view, PuglViewHint hint);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1006
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1007 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1008 Return the scale factor of the view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1009
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1010 This factor describe how large UI elements (especially text) should be
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1011 compared to "normal". For example, 2.0 means the UI should be drawn twice
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1012 as large.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1013
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1014 "Normal" is loosely defined, but means a good size on a "standard DPI"
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1015 display (around 96 DPI). In other words, the scale 1.0 should have text
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1016 that is reasonably sized on a 96 DPI display, and the scale 2.0 should have
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1017 text twice that large.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1018 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1019 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1020 double
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1021 puglGetScaleFactor(const PuglView* view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1022
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1023 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1024 @}
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1025 @defgroup frame Frame
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1026 Functions for working with the position and size of a view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1027 @{
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1028 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1029
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1030 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1031 Get the current position and size of the view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1032
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1033 The position is in screen coordinates with an upper left origin.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1034 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1035 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1036 PuglRect
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1037 puglGetFrame(const PuglView* view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1038
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1039 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1040 Set the current position and size of the view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1041
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1042 The position is in screen coordinates with an upper left origin.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1043
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1044 @return #PUGL_UNKNOWN_ERROR on failure, in which case the view frame is
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1045 unchanged.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1046 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1047 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1048 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1049 puglSetFrame(PuglView* view, PuglRect frame);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1050
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1051 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1052 Set the current position of the view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1053
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1054 @return #PUGL_UNKNOWN_ERROR on failure, in which case the view frame is
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1055 unchanged.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1056 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1057 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1058 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1059 puglSetPosition(PuglView* view, int x, int y);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1060
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1061 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1062 Set the current size of the view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1063
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1064 @return #PUGL_UNKNOWN_ERROR on failure, in which case the view frame is
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1065 unchanged.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1066 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1067 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1068 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1069 puglSetSize(PuglView* view, unsigned width, unsigned height);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1070
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1071 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1072 Set a size hint for the view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1073
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1074 This can be used to set the default, minimum, and maximum size of a view,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1075 as well as the supported range of aspect ratios.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1076
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1077 This should be called before puglRealize() so the initial window for the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1078 view can be configured correctly.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1079
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1080 @return #PUGL_UNKNOWN_ERROR on failure, but always succeeds if the view is
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1081 not yet realized.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1082 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1083 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1084 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1085 puglSetSizeHint(PuglView* view,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1086 PuglSizeHint hint,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1087 PuglSpan width,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1088 PuglSpan height);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1089
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1090 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1091 @}
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1092 @defgroup window Window
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1093 Functions to control the top-level window of a view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1094 @{
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1095 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1096
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1097 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1098 Set the title of the window.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1099
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1100 This only makes sense for non-embedded views that will have a corresponding
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1101 top-level window, and sets the title, typically displayed in the title bar
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1102 or in window switchers.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1103 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1104 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1105 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1106 puglSetWindowTitle(PuglView* view, const char* title);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1107
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1108 /// Return the title of the window, or null
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1109 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1110 const char*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1111 puglGetWindowTitle(const PuglView* view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1112
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1113 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1114 Set the parent window for embedding a view in an existing window.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1115
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1116 This must be called before puglRealize(), reparenting is not supported.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1117 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1118 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1119 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1120 puglSetParentWindow(PuglView* view, PuglNativeView parent);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1121
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1122 /// Return the parent window this view is embedded in, or null
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1123 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1124 PuglNativeView
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1125 puglGetParentWindow(const PuglView* view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1126
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1127 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1128 Set the transient parent of the window.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1129
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1130 Set this for transient children like dialogs, to have them properly
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1131 associated with their parent window. This should be called before
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1132 puglRealize().
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1133
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1134 A view can either have a parent (for embedding) or a transient parent (for
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1135 top-level windows like dialogs), but not both.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1136 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1137 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1138 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1139 puglSetTransientParent(PuglView* view, PuglNativeView parent);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1140
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1141 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1142 Return the transient parent of the window.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1143
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1144 @return The native handle to the window this view is a transient child of,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1145 or null.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1146 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1147 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1148 PuglNativeView
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1149 puglGetTransientParent(const PuglView* view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1150
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1151 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1152 Realize a view by creating a corresponding system view or window.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1153
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1154 After this call, the (initially invisible) underlying system view exists and
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1155 can be accessed with puglGetNativeView(). There is currently no
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1156 corresponding unrealize function, the system view will be destroyed along
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1157 with the view when puglFreeView() is called.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1158
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1159 The view should be fully configured using the above functions before this is
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1160 called. This function may only be called once per view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1161 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1162 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1163 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1164 puglRealize(PuglView* view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1165
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1166 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1167 Show the view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1168
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1169 If the view has not yet been realized, the first call to this function will
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1170 do so automatically.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1171
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1172 If the view is currently hidden, it will be shown and possibly raised to the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1173 top depending on the platform.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1174 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1175 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1176 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1177 puglShow(PuglView* view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1178
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1179 /// Hide the current window
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1180 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1181 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1182 puglHide(PuglView* view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1183
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1184 /// Return true iff the view is currently visible
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1185 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1186 bool
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1187 puglGetVisible(const PuglView* view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1188
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1189 /// Return the native window handle
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1190 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1191 PuglNativeView
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1192 puglGetNativeView(PuglView* view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1193
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1194 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1195 @}
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1196 @defgroup graphics Graphics
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1197 Functions for working with the graphics context and scheduling redisplays.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1198 @{
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1199 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1200
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1201 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1202 Get the graphics context.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1203
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1204 This is a backend-specific context used for drawing if the backend graphics
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1205 API requires one. It is only available during an expose.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1206
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1207 Cairo: Returns a pointer to a
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1208 [cairo_t](http://www.cairographics.org/manual/cairo-cairo-t.html).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1209
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1210 All other backends: returns null.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1211 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1212 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1213 void*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1214 puglGetContext(PuglView* view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1215
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1216 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1217 Request a redisplay for the entire view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1218
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1219 This will cause an expose event to be dispatched later. If called from
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1220 within the event handler, the expose should arrive at the end of the current
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1221 event loop iteration, though this is not strictly guaranteed on all
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1222 platforms. If called elsewhere, an expose will be enqueued to be processed
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1223 in the next event loop iteration.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1224 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1225 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1226 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1227 puglPostRedisplay(PuglView* view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1228
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1229 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1230 Request a redisplay of the given rectangle within the view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1231
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1232 This has the same semantics as puglPostRedisplay(), but allows giving a
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1233 precise region for redrawing only a portion of the view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1234 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1235 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1236 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1237 puglPostRedisplayRect(PuglView* view, PuglRect rect);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1238
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1239 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1240 @}
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1241 @defgroup interaction Interaction
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1242 Functions for interacting with the user and window system.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1243 @{
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1244 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1245
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1246 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1247 A mouse cursor type.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1248
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1249 This is a portable subset of mouse cursors that exist on X11, MacOS, and
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1250 Windows.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1251 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1252 typedef enum {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1253 PUGL_CURSOR_ARROW, ///< Default pointing arrow
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1254 PUGL_CURSOR_CARET, ///< Caret (I-Beam) for text entry
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1255 PUGL_CURSOR_CROSSHAIR, ///< Cross-hair
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1256 PUGL_CURSOR_HAND, ///< Hand with a pointing finger
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1257 PUGL_CURSOR_NO, ///< Operation not allowed
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1258 PUGL_CURSOR_LEFT_RIGHT, ///< Left/right arrow for horizontal resize
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1259 PUGL_CURSOR_UP_DOWN, ///< Up/down arrow for vertical resize
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1260 PUGL_CURSOR_DIAGONAL, ///< Top-left to bottom-right arrow for diagonal resize
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1261 PUGL_CURSOR_ANTI_DIAGONAL, ///< Bottom-left to top-right arrow for diagonal resize
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1262 } PuglCursor;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1263
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1264 /// The number of #PuglCursor values
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1265 #define PUGL_NUM_CURSORS ((unsigned)PUGL_CURSOR_ANTI_DIAGONAL + 1u)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1266
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1267 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1268 Grab the keyboard input focus.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1269
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1270 Note that this will fail if the view is not mapped and so should not, for
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1271 example, be called immediately after puglShow().
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1272
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1273 @return #PUGL_SUCCESS if the focus was successfully grabbed, or an error.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1274 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1275 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1276 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1277 puglGrabFocus(PuglView* view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1278
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1279 /// Return whether `view` has the keyboard input focus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1280 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1281 bool
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1282 puglHasFocus(const PuglView* view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1283
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1284 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1285 Request data from the general copy/paste clipboard.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1286
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1287 A #PUGL_DATA_OFFER event will be sent if data is available.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1288 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1289 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1290 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1291 puglPaste(PuglView* view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1292
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1293 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1294 Return the number of types available for the data in a clipboard.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1295
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1296 Returns zero if the clipboard is empty.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1297 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1298 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1299 uint32_t
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1300 puglGetNumClipboardTypes(const PuglView* view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1301
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1302 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1303 Return the identifier of a type available in a clipboard.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1304
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1305 This is usually a MIME type, but may also be another platform-specific type
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1306 identifier. Applications must ignore any type they do not recognize.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1307
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1308 Returns null if `typeIndex` is out of bounds according to
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1309 puglGetNumClipboardTypes().
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1310 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1311 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1312 const char*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1313 puglGetClipboardType(const PuglView* view, uint32_t typeIndex);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1314
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1315 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1316 Accept data offered from a clipboard.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1317
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1318 To accept data, this must be called while handling a #PUGL_DATA_OFFER event.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1319 Doing so will request the data from the source as the specified type. When
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1320 the data is available, a #PUGL_DATA event will be sent to the view which can
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1321 then retrieve the data with puglGetClipboard().
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1322
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1323 @param view The view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1324
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1325 @param offer The data offer event.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1326
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1327 @param typeIndex The index of the type that the view will accept. This is
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1328 the `typeIndex` argument to the call of puglGetClipboardType() that returned
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1329 the accepted type.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1330 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1331 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1332 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1333 puglAcceptOffer(PuglView* view,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1334 const PuglDataOfferEvent* offer,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1335 uint32_t typeIndex);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1336
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1337 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1338 Set the clipboard contents.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1339
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1340 This sets the system clipboard contents, which can be retrieved with
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1341 puglGetClipboard() or pasted into other applications.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1342
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1343 @param view The view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1344 @param type The MIME type of the data, "text/plain" is assumed if `NULL`.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1345 @param data The data to copy to the clipboard.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1346 @param len The length of data in bytes (including terminator if necessary).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1347 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1348 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1349 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1350 puglSetClipboard(PuglView* view,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1351 const char* type,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1352 const void* data,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1353 size_t len);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1354
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1355 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1356 Get the clipboard contents.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1357
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1358 This gets the system clipboard contents, which may have been set with
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1359 puglSetClipboard() or copied from another application.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1360
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1361 @param view The view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1362 @param typeIndex Index of the data type to get the item as.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1363 @param[out] len Set to the length of the data in bytes.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1364 @return The clipboard contents, or null.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1365 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1366 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1367 const void*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1368 puglGetClipboard(PuglView* view, uint32_t typeIndex, size_t* len);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1369
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1370 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1371 Set the mouse cursor.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1372
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1373 This changes the system cursor that is displayed when the pointer is inside
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1374 the view. May fail if setting the cursor is not supported on this system,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1375 for example if compiled on X11 without Xcursor support.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1376
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1377 @return #PUGL_BAD_PARAMETER if the given cursor is invalid,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1378 #PUGL_FAILURE if the cursor is known but loading it system fails.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1379 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1380 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1381 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1382 puglSetCursor(PuglView* view, PuglCursor cursor);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1383
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1384 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1385 Request user attention.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1386
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1387 This hints to the system that the window or application requires attention
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1388 from the user. The exact effect depends on the platform, but is usually
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1389 something like a flashing task bar entry or bouncing application icon.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1390 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1391 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1392 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1393 puglRequestAttention(PuglView* view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1394
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1395 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1396 Activate a repeating timer event.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1397
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1398 This starts a timer which will send a #PuglTimerEvent to `view` every
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1399 `timeout` seconds. This can be used to perform some action in a view at a
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1400 regular interval with relatively low frequency. Note that the frequency of
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1401 timer events may be limited by how often puglUpdate() is called.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1402
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1403 If the given timer already exists, it is replaced.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1404
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1405 @param view The view to begin sending #PUGL_TIMER events to.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1406
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1407 @param id The identifier for this timer. This is an application-specific ID
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1408 that should be a low number, typically the value of a constant or `enum`
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1409 that starts from 0. There is a platform-specific limit to the number of
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1410 supported timers, and overhead associated with each, so applications should
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1411 create only a few timers and perform several tasks in one if necessary.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1412
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1413 @param timeout The period, in seconds, of this timer. This is not
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1414 guaranteed to have a resolution better than 10ms (the maximum timer
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1415 resolution on Windows) and may be rounded up if it is too short. On X11 and
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1416 MacOS, a resolution of about 1ms can usually be relied on.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1417
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1418 @return #PUGL_FAILURE if timers are not supported by the system,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1419 #PUGL_UNKNOWN_ERROR if setting the timer failed.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1420 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1421 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1422 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1423 puglStartTimer(PuglView* view, uintptr_t id, double timeout);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1424
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1425 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1426 Stop an active timer.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1427
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1428 @param view The view that the timer is set for.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1429 @param id The ID previously passed to puglStartTimer().
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1430
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1431 @return #PUGL_FAILURE if timers are not supported by this system,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1432 #PUGL_UNKNOWN_ERROR if stopping the timer failed.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1433 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1434 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1435 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1436 puglStopTimer(PuglView* view, uintptr_t id);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1437
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1438 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1439 Send an event to a view via the window system.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1440
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1441 If supported, the event will be delivered to the view via the event loop
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1442 like other events. Note that this function only works for certain event
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1443 types.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1444
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1445 Currently, only #PUGL_CLIENT events are supported on all platforms.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1446
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1447 X11: A #PUGL_EXPOSE event can be sent, which is similar to calling
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1448 puglPostRedisplayRect(), but will always send a message to the X server,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1449 even when called in an event handler.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1450
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1451 @return #PUGL_UNSUPPORTED if sending events of this type is not supported,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1452 #PUGL_UNKNOWN_ERROR if sending the event failed.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1453 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1454 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1455 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1456 puglSendEvent(PuglView* view, const PuglEvent* event);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1457
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1458 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1459 @}
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1460 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1461
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1462 #ifndef PUGL_DISABLE_DEPRECATED
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1463
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1464 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1465 @}
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1466 @defgroup deprecated Deprecated API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1467 @{
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1468 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1469
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1470 PUGL_DEPRECATED_BY("PuglCreateEvent")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1471 typedef PuglCreateEvent PuglEventCreate;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1472
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1473 PUGL_DEPRECATED_BY("PuglDestroyEvent")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1474 typedef PuglDestroyEvent PuglEventDestroy;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1475
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1476 PUGL_DEPRECATED_BY("PuglConfigureEvent")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1477 typedef PuglConfigureEvent PuglEventConfigure;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1478
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1479 PUGL_DEPRECATED_BY("PuglMapEvent")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1480 typedef PuglMapEvent PuglEventMap;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1481
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1482 PUGL_DEPRECATED_BY("PuglUnmapEvent")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1483 typedef PuglUnmapEvent PuglEventUnmap;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1484
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1485 PUGL_DEPRECATED_BY("PuglUpdateEvent")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1486 typedef PuglUpdateEvent PuglEventUpdate;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1487
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1488 PUGL_DEPRECATED_BY("PuglExposeEvent")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1489 typedef PuglExposeEvent PuglEventExpose;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1490
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1491 PUGL_DEPRECATED_BY("PuglCloseEvent")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1492 typedef PuglCloseEvent PuglEventClose;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1493
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1494 PUGL_DEPRECATED_BY("PuglFocusEvent")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1495 typedef PuglFocusEvent PuglEventFocus;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1496
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1497 PUGL_DEPRECATED_BY("PuglKeyEvent")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1498 typedef PuglKeyEvent PuglEventKey;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1499
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1500 PUGL_DEPRECATED_BY("PuglTextEvent")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1501 typedef PuglTextEvent PuglEventText;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1502
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1503 PUGL_DEPRECATED_BY("PuglCrossingEvent")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1504 typedef PuglCrossingEvent PuglEventCrossing;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1505
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1506 PUGL_DEPRECATED_BY("PuglButtonEvent")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1507 typedef PuglButtonEvent PuglEventButton;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1508
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1509 PUGL_DEPRECATED_BY("PuglMotionEvent")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1510 typedef PuglMotionEvent PuglEventMotion;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1511
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1512 PUGL_DEPRECATED_BY("PuglScrollEvent")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1513 typedef PuglScrollEvent PuglEventScroll;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1514
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1515 PUGL_DEPRECATED_BY("PuglClientEvent")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1516 typedef PuglClientEvent PuglEventClient;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1517
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1518 PUGL_DEPRECATED_BY("PuglTimerEvent")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1519 typedef PuglTimerEvent PuglEventTimer;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1520
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1521 PUGL_DEPRECATED_BY("PuglLoopEnterEvent")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1522 typedef PuglLoopEnterEvent PuglEventLoopEnter;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1523
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1524 PUGL_DEPRECATED_BY("PuglLoopLeaveEvent")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1525 typedef PuglLoopLeaveEvent PuglEventLoopLeave;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1526
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1527 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1528 A native window handle.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1529
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1530 X11: This is a `Window`.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1531
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1532 MacOS: This is a pointer to an `NSView*`.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1533
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1534 Windows: This is a `HWND`.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1535 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1536 PUGL_DEPRECATED_BY("PuglNativeView")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1537 typedef uintptr_t PuglNativeWindow;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1538
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1539 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1540 Create a Pugl application and view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1541
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1542 To create a window, call the various puglInit* functions as necessary, then
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1543 call puglRealize().
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1544
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1545 @deprecated Use puglNewApp() and puglNewView().
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1546
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1547 @param pargc Pointer to argument count (currently unused).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1548 @param argv Arguments (currently unused).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1549 @return A newly created view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1550 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1551 static inline PUGL_DEPRECATED_BY("puglNewView")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1552 PuglView*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1553 puglInit(const int* pargc, char** argv)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1554 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1555 (void)pargc;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1556 (void)argv;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1557
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1558 return puglNewView(puglNewWorld(PUGL_MODULE, 0));
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1559 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1560
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1561 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1562 Destroy an app and view created with `puglInit()`.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1563
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1564 @deprecated Use puglFreeApp() and puglFreeView().
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1565 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1566 static inline PUGL_DEPRECATED_BY("puglFreeView")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1567 void
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1568 puglDestroy(PuglView* view)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1569 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1570 PuglWorld* const world = puglGetWorld(view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1571
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1572 puglFreeView(view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1573 puglFreeWorld(world);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1574 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1575
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1576 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1577 Set the window class name before creating a window.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1578 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1579 static inline PUGL_DEPRECATED_BY("puglSetClassName")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1580 void
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1581 puglInitWindowClass(PuglView* view, const char* name)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1582 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1583 puglSetClassName(puglGetWorld(view), name);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1584 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1585
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1586 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1587 Set the window size before creating a window.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1588
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1589 @deprecated Use puglSetFrame().
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1590 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1591 static inline PUGL_DEPRECATED_BY("puglSetFrame")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1592 void
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1593 puglInitWindowSize(PuglView* view, int width, int height)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1594 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1595 PuglRect frame = puglGetFrame(view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1596
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1597 frame.width = (PuglSpan)width;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1598 frame.height = (PuglSpan)height;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1599
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1600 puglSetFrame(view, frame);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1601 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1602
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1603 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1604 Set the minimum window size before creating a window.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1605 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1606 static inline PUGL_DEPRECATED_BY("puglSetMinSize")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1607 void
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1608 puglInitWindowMinSize(PuglView* view, int width, int height)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1609 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1610 puglSetSizeHint(view, PUGL_MIN_SIZE, (PuglSpan)width, (PuglSpan)height);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1611 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1612
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1613 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1614 Set the window aspect ratio range before creating a window.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1615
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1616 The x and y values here represent a ratio of width to height. To set a
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1617 fixed aspect ratio, set the minimum and maximum values to the same ratio.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1618
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1619 Note that setting different minimum and maximum constraints does not
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1620 currently work on MacOS (the minimum is used), so only setting a fixed
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1621 aspect ratio works properly across all platforms.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1622 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1623 static inline PUGL_DEPRECATED_BY("puglSetAspectRatio")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1624 void
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1625 puglInitWindowAspectRatio(PuglView* view,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1626 int minX,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1627 int minY,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1628 int maxX,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1629 int maxY)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1630 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1631 puglSetSizeHint(view, PUGL_MIN_ASPECT, (PuglSpan)minX, (PuglSpan)minY);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1632 puglSetSizeHint(view, PUGL_MAX_ASPECT, (PuglSpan)maxX, (PuglSpan)maxY);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1633 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1634
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1635 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1636 Set transient parent before creating a window.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1637
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1638 On X11, parent must be a Window.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1639 On OSX, parent must be an NSView*.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1640 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1641 static inline PUGL_DEPRECATED_BY("puglSetTransientParent")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1642 void
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1643 puglInitTransientFor(PuglView* view, uintptr_t parent)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1644 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1645 puglSetTransientParent(view, (PuglNativeWindow)parent);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1646 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1647
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1648 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1649 Set transient parent before creating a window.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1650
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1651 @deprecated Use puglSetTransientParent().
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1652 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1653 static inline PUGL_DEPRECATED_BY("puglSetTransientParent")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1654 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1655 puglSetTransientFor(PuglView* view, uintptr_t parent)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1656 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1657 return puglSetTransientParent(view, (PuglNativeWindow)parent);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1658 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1659
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1660 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1661 Enable or disable resizing before creating a window.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1662
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1663 @deprecated Use puglSetViewHint() with #PUGL_RESIZABLE.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1664 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1665 static inline PUGL_DEPRECATED_BY("puglSetViewHint")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1666 void
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1667 puglInitResizable(PuglView* view, bool resizable)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1668 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1669 puglSetViewHint(view, PUGL_RESIZABLE, resizable);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1670 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1671
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1672 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1673 Get the current size of the view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1674
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1675 @deprecated Use puglGetFrame().
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1676
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1677 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1678 static inline PUGL_DEPRECATED_BY("puglGetFrame")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1679 void
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1680 puglGetSize(PuglView* view, int* width, int* height)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1681 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1682 const PuglRect frame = puglGetFrame(view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1683
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1684 *width = (int)frame.width;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1685 *height = (int)frame.height;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1686 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1687
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1688 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1689 Ignore synthetic repeated key events.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1690
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1691 @deprecated Use puglSetViewHint() with #PUGL_IGNORE_KEY_REPEAT.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1692 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1693 static inline PUGL_DEPRECATED_BY("puglSetViewHint")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1694 void
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1695 puglIgnoreKeyRepeat(PuglView* view, bool ignore)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1696 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1697 puglSetViewHint(view, PUGL_IGNORE_KEY_REPEAT, ignore);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1698 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1699
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1700 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1701 Set a hint before creating a window.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1702
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1703 @deprecated Use puglSetWindowHint().
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1704 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1705 static inline PUGL_DEPRECATED_BY("puglSetViewHint")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1706 void
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1707 puglInitWindowHint(PuglView* view, PuglViewHint hint, int value)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1708 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1709 puglSetViewHint(view, hint, value);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1710 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1711
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1712 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1713 Set the parent window before creating a window (for embedding).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1714
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1715 @deprecated Use puglSetWindowParent().
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1716 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1717 static inline PUGL_DEPRECATED_BY("puglSetParentWindow")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1718 void
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1719 puglInitWindowParent(PuglView* view, PuglNativeWindow parent)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1720 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1721 puglSetParentWindow(view, parent);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1722 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1723
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1724 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1725 Set the graphics backend to use.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1726
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1727 @deprecated Use puglSetBackend().
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1728 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1729 static inline PUGL_DEPRECATED_BY("puglSetBackend")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1730 int
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1731 puglInitBackend(PuglView* view, const PuglBackend* backend)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1732 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1733 return (int)puglSetBackend(view, backend);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1734 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1735
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1736 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1737 Realize a view by creating a corresponding system view or window.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1738
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1739 The view should be fully configured using the above functions before this is
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1740 called. This function may only be called once per view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1741
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1742 @deprecated Use puglRealize(), or just show the view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1743 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1744 static inline PUGL_DEPRECATED_BY("puglRealize")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1745 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1746 puglCreateWindow(PuglView* view, const char* title)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1747 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1748 puglSetWindowTitle(view, title);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1749 return puglRealize(view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1750 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1751
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1752 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1753 Block and wait for an event to be ready.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1754
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1755 This can be used in a loop to only process events via puglProcessEvents when
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1756 necessary. This function will block indefinitely if no events are
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1757 available, so is not appropriate for use in programs that need to perform
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1758 regular updates (e.g. animation).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1759
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1760 @deprecated Use puglPollEvents().
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1761 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1762 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1763 PUGL_DEPRECATED_BY("puglPollEvents")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1764 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1765 puglWaitForEvent(PuglView* view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1766
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1767 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1768 Process all pending window events.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1769
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1770 This handles input events as well as rendering, so it should be called
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1771 regularly and rapidly enough to keep the UI responsive. This function does
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1772 not block if no events are pending.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1773
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1774 @deprecated Use puglDispatchEvents().
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1775 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1776 PUGL_API
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1777 PUGL_DEPRECATED_BY("puglDispatchEvents")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1778 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1779 puglProcessEvents(PuglView* view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1780
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1781 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1782 Poll for events that are ready to be processed.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1783
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1784 This polls for events that are ready for any view in the world, potentially
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1785 blocking depending on `timeout`.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1786
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1787 @param world The world to poll for events.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1788
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1789 @param timeout Maximum time to wait, in seconds. If zero, the call returns
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1790 immediately, if negative, the call blocks indefinitely.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1791
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1792 @return #PUGL_SUCCESS if events are read, #PUGL_FAILURE if not, or an error.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1793
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1794 @deprecated Use puglUpdate().
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1795 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1796 static inline PUGL_DEPRECATED_BY("puglUpdate")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1797 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1798 puglPollEvents(PuglWorld* world, double timeout)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1799 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1800 return puglUpdate(world, timeout);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1801 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1802
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1803 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1804 Dispatch any pending events to views.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1805
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1806 This processes all pending events, dispatching them to the appropriate
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1807 views. View event handlers will be called in the scope of this call. This
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1808 function does not block, if no events are pending then it will return
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1809 immediately.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1810
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1811 @deprecated Use puglUpdate().
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1812 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1813 static inline PUGL_DEPRECATED_BY("puglUpdate")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1814 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1815 puglDispatchEvents(PuglWorld* world)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1816 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1817 return puglUpdate(world, 0.0);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1818 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1819
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1820 static inline PUGL_DEPRECATED_BY("puglShow")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1821 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1822 puglShowWindow(PuglView* view)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1823 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1824 return puglShow(view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1825 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1826
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1827 static inline PUGL_DEPRECATED_BY("puglHide")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1828 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1829 puglHideWindow(PuglView* view)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1830 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1831 return puglHide(view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1832 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1833
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1834 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1835 Set the default size of the view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1836
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1837 This should be called before puglRealize() to set the default size of the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1838 view, which will be the initial size of the window if this is a top level
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1839 view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1840
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1841 @return #PUGL_UNKNOWN_ERROR on failure, but always succeeds if the view is
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1842 not yet realized.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1843 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1844 static inline PUGL_DEPRECATED_BY("puglSetSizeHint")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1845 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1846 puglSetDefaultSize(PuglView* view, int width, int height)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1847 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1848 return puglSetSizeHint(
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1849 view, PUGL_DEFAULT_SIZE, (PuglSpan)width, (PuglSpan)height);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1850 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1851
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1852 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1853 Set the minimum size of the view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1854
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1855 If an initial minimum size is known, this should be called before
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1856 puglRealize() to avoid stutter, though it can be called afterwards as well.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1857
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1858 @return #PUGL_UNKNOWN_ERROR on failure, but always succeeds if the view is
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1859 not yet realized.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1860 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1861 static inline PUGL_DEPRECATED_BY("puglSetSizeHint")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1862 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1863 puglSetMinSize(PuglView* view, int width, int height)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1864 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1865 return puglSetSizeHint(
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1866 view, PUGL_MIN_SIZE, (PuglSpan)width, (PuglSpan)height);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1867 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1868
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1869 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1870 Set the maximum size of the view.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1871
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1872 If an initial maximum size is known, this should be called before
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1873 puglRealize() to avoid stutter, though it can be called afterwards as well.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1874
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1875 @return #PUGL_UNKNOWN_ERROR on failure, but always succeeds if the view is
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1876 not yet realized.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1877 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1878 static inline PUGL_DEPRECATED_BY("puglSetSizeHint")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1879 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1880 puglSetMaxSize(PuglView* view, int width, int height)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1881 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1882 return puglSetSizeHint(
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1883 view, PUGL_MAX_SIZE, (PuglSpan)width, (PuglSpan)height);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1884 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1885
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1886 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1887 Set the view aspect ratio range.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1888
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1889 The x and y values here represent a ratio of width to height. To set a
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1890 fixed aspect ratio, set the minimum and maximum values to the same ratio.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1891
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1892 Note that setting different minimum and maximum constraints does not
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1893 currently work on MacOS (the minimum is used), so only setting a fixed
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1894 aspect ratio works properly across all platforms.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1895
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1896 If an initial aspect ratio is known, this should be called before
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1897 puglRealize() to avoid stutter, though it can be called afterwards as well.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1898
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1899 @return #PUGL_UNKNOWN_ERROR on failure, but always succeeds if the view is
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1900 not yet realized.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1901 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1902 static inline PUGL_DEPRECATED_BY("puglSetSizeHint")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1903 PuglStatus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1904 puglSetAspectRatio(PuglView* view, int minX, int minY, int maxX, int maxY)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1905 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1906 const PuglStatus st0 =
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1907 puglSetSizeHint(view, PUGL_MIN_ASPECT, (PuglSpan)minX, (PuglSpan)minY);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1908
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1909 const PuglStatus st1 =
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1910 puglSetSizeHint(view, PUGL_MAX_ASPECT, (PuglSpan)maxX, (PuglSpan)maxY);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1911
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1912 return st0 ? st0 : st1;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1913 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1914
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1915 /// Return the native window handle
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1916 static inline PUGL_DEPRECATED_BY("puglGetNativeView")
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1917 PuglNativeView
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1918 puglGetNativeWindow(PuglView* view)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1919 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1920 return puglGetNativeView(view);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1921 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1922
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1923 #endif // PUGL_DISABLE_DEPRECATED
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1924
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1925 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1926 @}
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1927 @}
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1928 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1929
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1930 PUGL_END_DECLS
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1931
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1932 #endif // PUGL_PUGL_H

Mercurial > hg > pub > prymula > com

annotate DPF-Prymula-audioplugins/dpf/dgl/src/pugl-upstream/include/pugl/pugl.h @ 3:84e66ea83026