summaryrefslogtreecommitdiffstats
path: root/sip/qtgl/qgl.sip
blob: e08b6a95bbddfb50630ddb3e14cfd9853e07ec8f (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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
// This is the SIP interface definition for QGL, QGLContext, QGLFormat and
// QGLWidget.
//
// Copyright (c) 2007
// 	Riverbank Computing Limited <info@riverbankcomputing.co.uk>
// 
// This file is part of PyQt.
// 
// This copy of PyQt is free software; you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free
// Software Foundation; either version 2, or (at your option) any later
// version.
// 
// PyQt is supplied in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
// details.
// 
// You should have received a copy of the GNU General Public License along with
// PyQt; see the file LICENSE.  If not, write to the Free Software Foundation,
// Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.


%ExportedDoc
<Sect2><Title>QGL</Title>
<Para>
<Literal>QGL</Literal> is fully implemented.
</Para>
</Sect2>
 
<Sect2><Title>QGLContext</Title>
<Para>
<Literal>QGLContext</Literal> is fully implemented.
</Para>
</Sect2>
 
<Sect2><Title>QGLFormat</Title>
<Para>
<Literal>QGLFormat</Literal> is fully implemented.
</Para>
</Sect2>
 
<Sect2><Title>QGLWidget</Title>
<Para>
<Literal>QGLWidget</Literal> is fully implemented.
</Para>
</Sect2>
%End


%If (Qt_2_00 -)

const int QGL_VERSION;
const char *QGL_VERSION_STR;

const char *qGLVersion();


class QGL
{
%TypeHeaderCode
#include <qgl.h>
%End

public:
	enum FormatOption {
		DoubleBuffer,
		DepthBuffer,
		Rgba,
		AlphaChannel,
		AccumBuffer,
		StencilBuffer,
		StereoBuffers,
		DirectRendering,
		HasOverlay,
		SingleBuffer,
		NoDepthBuffer,
		ColorIndex,
		NoAlphaChannel,
		NoAccumBuffer,
		NoStencilBuffer,
		NoStereoBuffers,
		IndirectRendering,
		NoOverlay
	};
};


class QGLFormat : QGL
{
%TypeHeaderCode
#include <qgl.h>
%End

public:
	QGLFormat();
	QGLFormat(int,int = 0);

	bool doubleBuffer() const;
	void setDoubleBuffer(bool);
	bool depth() const;
	void setDepth(bool);
	bool rgba() const;
	void setRgba(bool);
	bool alpha() const;
	void setAlpha(bool);
	bool accum() const;
	void setAccum(bool);
	bool stencil() const;
	void setStencil(bool);
	bool stereo() const;
	void setStereo(bool);
	bool directRendering() const;
	void setDirectRendering(bool);
	bool hasOverlay() const;
	void setOverlay(bool);

	int plane() const;
	void setPlane(int);

	void setOption(FormatOption);
	bool testOption(FormatOption) const;
    
	static QGLFormat defaultFormat();
	static void setDefaultFormat(const QGLFormat &);

	static QGLFormat defaultOverlayFormat();
	static void setDefaultOverlayFormat(const QGLFormat &);

	static bool hasOpenGL();
	static bool hasOpenGLOverlays();
};


class QGLContext : QGL
{
%TypeHeaderCode
#include <qgl.h>
%End

public:
	QGLContext(const QGLFormat &,QPaintDevice *);
%If (Qt_3_2_0 -)
	QGLContext(const QGLFormat &);
%End

	virtual bool create(const QGLContext * = 0);
	bool isValid() const;
	bool isSharing() const;
	virtual void reset();

	QGLFormat format() const;
%If (Qt_3_0_0 -)
	QGLFormat requestedFormat() const;
%End
	virtual void setFormat(const QGLFormat &);

	virtual void makeCurrent();
	virtual void swapBuffers() const;

	QPaintDevice *device() const;

	QColor overlayTransparentColor() const;

	static const QGLContext *currentContext();

protected:
	virtual bool chooseContext(const QGLContext * = 0);
	virtual void doneCurrent();
    
%If (WS_X11)
	virtual void *tryVisual(const QGLFormat &,int = 1);
	virtual void *chooseVisual();
%End

	bool deviceIsPixmap() const;
	bool windowCreated() const;
	void setWindowCreated(bool);
	bool initialized() const;
	void setInitialized(bool);
%If (Qt_3_1_0 -)
	void generateFontDisplayLists(const QFont &,int);
%End

	uint colorIndex(const QColor &) const;
%If (Qt_3_2_0 -)
	void setValid(bool);
	void setDevice(QPaintDevice *);
%End

private:
	QGLContext();
	QGLContext(const QGLContext &);
};


class QGLWidget : QWidget, QGL
{
%TypeHeaderCode
#include <qgl.h>
%End

public:
	QGLWidget(QWidget * /TransferThis/ = 0,const char * = 0,
		  const QGLWidget * = 0,WFlags = 0);
%If (Qt_3_2_0 -)
	QGLWidget(QGLContext * /Transfer/,QWidget * /TransferThis/ = 0,const char * = 0,
		  const QGLWidget * = 0,WFlags = 0);
%End
	QGLWidget(const QGLFormat &,QWidget * /TransferThis/ = 0,
		  const char * = 0,const QGLWidget * = 0,WFlags = 0);

%ConvertToSubClassCode
	sipClass = (sipCpp->inherits(sipName_QGLWidget) ? sipClass_QGLWidget : NULL);
%End

	void qglColor(const QColor &) const;
	void qglClearColor(const QColor &) const;

	bool isValid() const;
	bool isSharing() const;
	virtual void makeCurrent();
%If (Qt_3_2_0 -)
	void doneCurrent();
%End

	bool doubleBuffer() const;
	virtual void swapBuffers();

	QGLFormat format() const;

	const QGLContext *context() const;

	virtual QPixmap renderPixmap(int = 0,int = 0,bool = 0);
%If (Qt_3_0_0 -)
	virtual QImage grabFrameBuffer(bool = 0);
%End

	virtual void makeOverlayCurrent();
	const QGLContext *overlayContext() const;

	static QImage convertToGLFormat(const QImage &);

	void setMouseTracking(bool);

%If (Qt_3_0_0 -)
        virtual void reparent(QWidget * /GetWrapper/,WFlags,const QPoint &,
			      bool = 0);
%MethodCode
		if (sipCpp -> parent() != a0)
			if (a0)
				sipTransferTo(sipSelf,a0Wrapper);
			else
				sipTransferBack(sipSelf);

		Py_BEGIN_ALLOW_THREADS
		sipSelfWasArg ? sipCpp->QGLWidget::reparent(a0, a1, *a2, a3) : sipCpp->reparent(a0, a1, *a2, a3);
		Py_END_ALLOW_THREADS
%End

	const QGLColormap &colormap() const;
	void setColormap(const QGLColormap &);
%End

%If (Qt_3_1_0 -)
	void renderText(int,int,const QString &,const QFont & = QFont(),
			int = 2000);
	void renderText(double,double,double,const QString &,
			const QFont & = QFont(),int = 2000);
%End

public slots:
	virtual void updateGL();
	virtual void updateOverlayGL();

protected:
	virtual void initializeGL();
	virtual void resizeGL(int,int);
	virtual void paintGL();

	virtual void initializeOverlayGL();
	virtual void resizeOverlayGL(int,int);
	virtual void paintOverlayGL();

	void setAutoBufferSwap(bool);
	bool autoBufferSwap() const;

	void paintEvent(QPaintEvent *);
	void resizeEvent(QResizeEvent *);

	virtual void glInit();
	virtual void glDraw();

private:
	QGLWidget(const QGLWidget &);
};

%End