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 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
|
from typing import List
import numpy
import moderngl
import moderngl_window as mglw
from moderngl_window.opengl import types
# For sanity checking draw modes when creating the VAO
DRAW_MODES = {
moderngl.TRIANGLES: "TRIANGLES",
moderngl.TRIANGLE_FAN: "TRIANGLE_FAN",
moderngl.TRIANGLE_STRIP: "TRIANGLE_STRIP",
moderngl.TRIANGLES_ADJACENCY: "TRIANGLES_ADJACENCY",
moderngl.TRIANGLE_STRIP_ADJACENCY: "TRIANGLE_STRIP_ADJACENCY",
moderngl.POINTS: "POINTS",
moderngl.LINES: "LINES",
moderngl.LINE_STRIP: "LINE_STRIP",
moderngl.LINE_LOOP: "LINE_LOOP",
moderngl.LINES_ADJACENCY: "LINES_ADJACENCY",
}
class BufferInfo:
"""Container for a vbo with additional information"""
def __init__(
self,
buffer: moderngl.Buffer,
buffer_format: str,
attributes=None,
per_instance=False,
):
"""
:param buffer: The vbo object
:param format: The format of the buffer
"""
self.buffer = buffer
self.attrib_formats = types.parse_attribute_formats(buffer_format)
self.attributes = attributes
self.per_instance = per_instance
# Sanity check byte size
if self.buffer.size % self.vertex_size != 0:
raise VAOError(
"Buffer with type {} has size not aligning with {}. Remainder: {}".format(
buffer_format, self.vertex_size, self.buffer.size % self.vertex_size
)
)
self.vertices = self.buffer.size // self.vertex_size
@property
def vertex_size(self) -> int:
return sum(f.bytes_total for f in self.attrib_formats)
def content(self, attributes: List[str]):
"""Build content tuple for the buffer"""
formats = []
attrs = []
for attrib_format, attrib in zip(self.attrib_formats, self.attributes):
if attrib not in attributes:
formats.append(attrib_format.pad_str())
continue
formats.append(attrib_format.format)
attrs.append(attrib)
attributes.remove(attrib)
if not attrs:
return None
return (
self.buffer,
"{}{}".format(" ".join(formats), "/i" if self.per_instance else ""),
*attrs,
)
def has_attribute(self, name):
return name in self.attributes
class VAO:
"""
Represents a vertex array object.
This is a wrapper class over ``moderngl.VertexArray`` to make interactions
with programs/shaders simpler. Named buffers are added correspoding with
attribute names in a vertex shader. When rendering the VAO an internal
``moderngl.VertextArray`` is created automatically mapping the named buffers
compatible with the supplied program. This program is cached internally.
The shader program doesn't need to use all the buffers registered in
this wrapper. When a subset is used only the used buffers are mapped
and the appropriate padding is calculated when interleaved data is used.
You are not required to use this class, but most methods in the
system creating vertexbuffers will return this type. You can obtain
a single ``moderngl.VertexBuffer`` instance by calling :py:meth:`VAO.instance`
method if you prefer to work directly on moderngl instances.
Example::
# Separate buffers
vao = VAO(name="test", mode=moderngl.POINTS)
vao.buffer(positions, '3f', ['in_position'])
vao.buffer(velocities, '3f', ['in_velocities'])
# Interleaved
vao = VAO(name="test", mode=moderngl.POINTS)
vao.buffer(interleaved_data, '3f 3f', ['in_position', 'in_velocities'])
.. code:: glsl
# GLSL vertex shader in attributes
in vec3 in_position;
in vec3 in_velocities;
"""
def __init__(self, name="", mode=moderngl.TRIANGLES):
"""Create and empty VAO with a name and default render mode.
Example::
VAO(name="cube", mode=moderngl.TRIANGLES)
Keyword Args:
name (str): Optional name for debug purposes
mode (int): Default draw mode
"""
self.name = name
self.mode = mode
try:
DRAW_MODES[self.mode]
except KeyError:
raise VAOError(
"Invalid draw mode. Options are {}".format(DRAW_MODES.values())
)
self._buffers = []
self._index_buffer = None
self._index_element_size = None
self.vertex_count = 0
self.vaos = {}
@property
def ctx(self):
"""moderngl.Context: The actite moderngl context"""
return mglw.ctx()
def render(
self, program: moderngl.Program, mode=None, vertices=-1, first=0, instances=1
):
"""Render the VAO.
An internal ``moderngl.VertexBuffer`` with compatible buffer bindings
is automatically created on the fly and cached internally.
Args:
program: The ``moderngl.Program``
Keyword Args:
mode: Override the draw mode (``TRIANGLES`` etc)
vertices (int): The number of vertices to transform
first (int): The index of the first vertex to start with
instances (int): The number of instances
"""
vao = self.instance(program)
if mode is None:
mode = self.mode
vao.render(mode, vertices=vertices, first=first, instances=instances)
def render_indirect(
self, program: moderngl.Program, buffer, mode=None, count=-1, *, first=0
):
"""The render primitive (mode) must be the same as the input primitive of the GeometryShader.
The draw commands are 5 integers: (count, instanceCount, firstIndex, baseVertex, baseInstance).
Args:
program: The ``moderngl.Program``
buffer: The ``moderngl.Buffer`` containing indirect draw commands
Keyword Args:
mode (int): By default :py:data:`TRIANGLES` will be used.
count (int): The number of draws.
first (int): The index of the first indirect draw command.
"""
vao = self.instance(program)
if mode is None:
mode = self.mode
vao.render_indirect(buffer, mode=mode, count=count, first=first)
def transform(
self,
program: moderngl.Program,
buffer: moderngl.Buffer,
mode=None,
vertices=-1,
first=0,
instances=1,
):
"""Transform vertices. Stores the output in a single buffer.
Args:
program: The ``moderngl.Program``
buffer: The ``moderngl.buffer`` to store the output
Keyword Args:
mode: Draw mode (for example ``moderngl.POINTS``)
vertices (int): The number of vertices to transform
first (int): The index of the first vertex to start with
instances (int): The number of instances
"""
vao = self.instance(program)
if mode is None:
mode = self.mode
vao.transform(
buffer, mode=mode, vertices=vertices, first=first, instances=instances
)
def buffer(self, buffer, buffer_format: str, attribute_names: List[str]):
"""Register a buffer/vbo for the VAO. This can be called multiple times.
adding multiple buffers (interleaved or not).
Args:
buffer: The buffer data. Can be ``numpy.array``, ``moderngl.Buffer`` or ``bytes``.
buffer_format (str): The format of the buffer. (eg. ``3f 3f`` for interleaved positions and normals).
attribute_names: A list of attribute names this buffer should map to.
Returns:
The ``moderngl.Buffer`` instance object. This is handy when providing ``bytes`` and ``numpy.array``.
"""
if not isinstance(attribute_names, list):
attribute_names = [
attribute_names,
]
if not type(buffer) in [moderngl.Buffer, numpy.ndarray, bytes]:
raise VAOError(
(
"buffer parameter must be a moderngl.Buffer, numpy.ndarray or bytes instance"
"(not {})".format(type(buffer))
)
)
if isinstance(buffer, numpy.ndarray):
buffer = self.ctx.buffer(buffer.tobytes())
if isinstance(buffer, bytes):
buffer = self.ctx.buffer(data=buffer)
formats = buffer_format.split()
if len(formats) != len(attribute_names):
raise VAOError(
"Format '{}' does not describe attributes {}".format(
buffer_format, attribute_names
)
)
self._buffers.append(BufferInfo(buffer, buffer_format, attribute_names))
self.vertex_count = self._buffers[-1].vertices
return buffer
def index_buffer(self, buffer, index_element_size=4):
"""Set the index buffer for this VAO.
Args:
buffer: ``moderngl.Buffer``, ``numpy.array`` or ``bytes``
Keyword Args:
index_element_size (int): Byte size of each element. 1, 2 or 4
"""
if not type(buffer) in [moderngl.Buffer, numpy.ndarray, bytes]:
raise VAOError(
"buffer parameter must be a moderngl.Buffer, numpy.ndarray or bytes instance"
)
if isinstance(buffer, numpy.ndarray):
buffer = self.ctx.buffer(buffer.tobytes())
if isinstance(buffer, bytes):
buffer = self.ctx.buffer(data=buffer)
self._index_buffer = buffer
self._index_element_size = index_element_size
def instance(self, program: moderngl.Program) -> moderngl.VertexArray:
"""Obtain the ``moderngl.VertexArray`` instance for the program.
The instance is only created once and cached internally.
Args:
program (moderngl.Program): The program
Returns:
``moderngl.VertexArray``: instance
"""
vao = self.vaos.get(program.glo)
if vao:
return vao
program_attributes = [
name
for name, attr in program._members.items()
if isinstance(attr, moderngl.Attribute) and not attr.name.startswith("gl_")
]
# Make sure all attributes are covered
for attrib_name in program_attributes:
# Do we have a buffer mapping to this attribute?
if not sum(buffer.has_attribute(attrib_name) for buffer in self._buffers):
raise VAOError(
(
"VAO {} doesn't have attribute {} for program {}.\n"
"Program attributes: {}.\n"
"VAO attributes: {}"
).format(
self.name,
attrib_name,
program,
program_attributes,
[attr for buff in self._buffers for attr in buff.attributes],
)
)
vao_content = []
# Pick out the attributes we can actually map
for buffer in self._buffers:
content = buffer.content(program_attributes)
if content:
vao_content.append(content)
# Any attribute left is not accounted for
if program_attributes:
raise VAOError(
"Did not find a buffer mapping for {}".format(
[n for n in program_attributes]
)
)
# Create the vao
if self._index_buffer:
vao = self.ctx.vertex_array(
program, vao_content, self._index_buffer, self._index_element_size,
)
else:
vao = self.ctx.vertex_array(program, vao_content)
self.vaos[program.glo] = vao
return vao
def release(self, buffer=True):
"""Destroy all internally cached vaos and release all buffers.
Keyword Args:
buffers (bool): also release buffers
"""
for _, vao in self.vaos.items():
vao.release()
self.vaos = {}
if buffer:
for buff in self._buffers:
buff.buffer.release()
if self._index_buffer:
self._index_buffer.release()
self._buffers = []
def get_buffer_by_name(self, name: str) -> BufferInfo:
"""Get the BufferInfo associated with a specific attribute name
If no buffer is associated with the name `None` will be returned.
Args:
name (str): Name of the mapped attribute
Returns:
BufferInfo: BufferInfo instance
"""
for buffer in self._buffers:
if name in buffer.attributes:
return buffer
return None
class VAOError(Exception):
pass
|