aboutsummaryrefslogtreecommitdiff
path: root/pugl/pugl/detail/types.h
blob: 60f768275b073b9c9a57b45149adec2d41ac3e39 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
/*
  Copyright 2012-2019 David Robillard <http://drobilla.net>

  Permission to use, copy, modify, and/or distribute this software for any
  purpose with or without fee is hereby granted, provided that the above
  copyright notice and this permission notice appear in all copies.

  THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/

/**
   @file types.h Shared internal type definitions.
*/

#ifndef PUGL_DETAIL_TYPES_H
#define PUGL_DETAIL_TYPES_H

#include "pugl/pugl.h"

#include <stdbool.h>
#include <stdint.h>

// Unused parameter macro to suppresses warnings and make it impossible to use
#if defined(__cplusplus) || defined(_MSC_VER)
#   define PUGL_UNUSED(name)
#elif defined(__GNUC__)
#   define PUGL_UNUSED(name) name##_unused __attribute__((__unused__))
#else
#   define PUGL_UNUSED(name)
#endif

/** Platform-specific internals. */
typedef struct PuglInternalsImpl PuglInternals;

/** View hints. */
typedef struct {
	int  context_version_major;
	int  context_version_minor;
	int  red_bits;
	int  green_bits;
	int  blue_bits;
	int  alpha_bits;
	int  depth_bits;
	int  stencil_bits;
	int  samples;
	int  double_buffer;
	bool use_compat_profile;
	bool resizable;
	bool ignoreKeyRepeat;
} PuglHints;

/** Cross-platform view definition. */
struct PuglViewImpl {
	const PuglBackend* backend;
	PuglInternals*     impl;
	PuglHandle         handle;
	PuglEventFunc      eventFunc;
	char*              windowClass;
	PuglNativeWindow   parent;
	double             start_time;
	uintptr_t          transient_parent;
	PuglHints          hints;
	int                width;
	int                height;
	int                min_width;
	int                min_height;
	int                min_aspect_x;
	int                min_aspect_y;
	int                max_aspect_x;
	int                max_aspect_y;
	bool               visible;
};

/** Opaque surface used by graphics backend. */
typedef void PuglSurface;

/** Graphics backend interface. */
struct PuglBackendImpl {
	/** Get visual information from display and setup view as necessary. */
	int (*configure)(PuglView*);

	/** Create surface and drawing context. */
	int (*create)(PuglView*);

	/** Destroy surface and drawing context. */
	int (*destroy)(PuglView*);

	/** Enter drawing context, for drawing if parameter is true. */
	int (*enter)(PuglView*, bool);

	/** Leave drawing context, after drawing if parameter is true. */
	int (*leave)(PuglView*, bool);

	/** Resize drawing context to the given width and height. */
	int (*resize)(PuglView*, int, int);

	/** Return the puglGetContext() handle for the application, if any. */
	void* (*getContext)(PuglView*);
};

#endif // PUGL_DETAIL_TYPES_H