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
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.glcanvas.GLAttribsBase:
==========================================================================================================================================
|phoenix_title| **wx.glcanvas.GLAttribsBase**
==========================================================================================================================================
This is the base class for :ref:`wx.glcanvas.GLAttributes` and :ref:`wx.glcanvas.GLContextAttrs`.
It stores internally the list required by OS and OpenGL driver for setting display and rendering context attributes.
Normally this class is not used directly. But there's a case where it its member functions are useful: setting attributes not handled by wxWidgets. Suppose the OpenGL Board sets a new functionality of the context, by adding a new attribute (let's call it ``NEW_CTX_F``) and also a new type of context by allowing a new bit value (let's call it ``NEW_BITS``) for the ``CONTEXT_PROFILE_MASK_ARB`` value. These new values can be added to the list using code like this:
::
cxtAttrs = wx.glcanvas.GLContextAttrs()
# Some values
cxtAttrs.CoreProfile().OGLVersion(5, 0) # OGL 5.0, whenever available
cxtAttrs.PlatformDefaults()
# Values usually are platform-dependant named (even value assigned!)
if '__WXMSW__' in wx.PlatformInfo:
cxtAttrs.AddAttribute(WGL_NEW_CTX_F)
cxtAttrs.AddAttribBits(WGL_CONTEXT_PROFILE_MASK_ARB, WGL_NEW_BITS)
cxtAttrs.EndList() # Don't forget self
cxtAttrs.SetNeedsARB(True) # Context attributes are set by an ARB-function
.. versionadded:: 4.1/wxWidgets-3.1.0
.. seealso:: :ref:`wx.glcanvas.GLCanvas`, :ref:`wx.glcanvas.GLContext`, :ref:`wx.glcanvas.GLContextAttrs`, :ref:`wx.glcanvas.GLAttributes`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>GLAttribsBase</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.glcanvas.GLAttribsBase_inheritance.png" alt="Inheritance diagram of GLAttribsBase" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.glcanvas.GLAttribsBase.html" title="wx.glcanvas.GLAttribsBase" alt="" coords="5,5,204,35"/> </map>
</p>
</div>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.glcanvas.GLAttributes`, :ref:`wx.glcanvas.GLContextAttrs`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.glcanvas.GLAttribsBase.__init__` Constructor.
:meth:`~wx.glcanvas.GLAttribsBase.AddAttribBits` Combine (bitwise ``wx.OR``) a given value with the existing one, if any.
:meth:`~wx.glcanvas.GLAttribsBase.AddAttribute` Adds an integer value to the list of attributes.
:meth:`~wx.glcanvas.GLAttribsBase.GetSize` Returns the size of the internal list of attributes.
:meth:`~wx.glcanvas.GLAttribsBase.NeedsARB` Returns the current value of the ARB-flag.
:meth:`~wx.glcanvas.GLAttribsBase.Reset` Delete contents and sets ARB-flag to ``False``.
:meth:`~wx.glcanvas.GLAttribsBase.SetNeedsARB` Sets the necessity of using special ARB-functions (e.g.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.glcanvas.GLAttribsBase.Size` See :meth:`~wx.glcanvas.GLAttribsBase.GetSize`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.glcanvas.GLAttribsBase(object)
**Possible constructors**::
GLAttribsBase()
This is the base class for GLAttributes and GLContextAttrs.
.. method:: __init__(self)
Constructor.
.. method:: AddAttribBits(self, searchVal, combineVal)
Combine (bitwise ``wx.OR``) a given value with the existing one, if any.
This function first searches for an identifier and then combines the given value with the value right after the identifier. If the identifier is not found, two new values (i.e. the identifier and the given value) are added to the list.
:param `searchVal`: The identifier to search for.
:type `searchVal`: int
:param `combineVal`: The value to combine with the existing one.
:type `combineVal`: int
.. method:: AddAttribute(self, attribute)
Adds an integer value to the list of attributes.
:param `attribute`: The value to add.
:type `attribute`: int
.. method:: GetSize(self)
Returns the size of the internal list of attributes.
Remember that the last value in the list must be a '0' (zero). So, a minimal list is of size = 2, the first value is meaningful and the last is '0'.
:rtype: `int`
.. method:: NeedsARB(self)
Returns the current value of the ARB-flag.
:rtype: `bool`
.. seealso:: :meth:`SetNeedsARB`
.. method:: Reset(self)
Delete contents and sets ARB-flag to ``False``.
.. method:: SetNeedsARB(self, needsARB=True)
Sets the necessity of using special ARB-functions (e.g.
wglCreateContextAttribsARB in MSW) for some of the attributes of the list. Multi-sampling and modern context require these ARB-functions.
:param `needsARB`: ``True`` if an ARB-function is needed for any of the attributes.
:type `needsARB`: bool
.. seealso:: :meth:`NeedsARB`
.. attribute:: Size
See :meth:`~wx.glcanvas.GLAttribsBase.GetSize`
|
