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
|
ComputeShader
=============
.. py:class:: ComputeShader
Returned by :py:meth:`Context.compute_shader`
A Compute Shader is a Shader Stage that is used entirely for computing arbitrary information.
While it can do rendering, it is generally used
for tasks not directly related to drawing.
- Compute shaders support uniforms similar to :py:class:`moderngl.Program` objects.
- Storage buffers can be bound using :py:meth:`Buffer.bind_to_storage_buffer`.
- Uniform buffers can be bound using :py:meth:`Buffer.bind_to_uniform_block`.
- Images can be bound using :py:meth:`Texture.bind_to_image`.
Methods
-------
.. py:method:: ComputeShader.run(group_x: int = 1, group_y: int = 1, group_z: int = 1) -> None:
:param int group_x: Workgroup size x.
:param int group_y: Workgroup size y.
:param int group_z: Workgroup size z.
Run the compute shader.
.. py:method:: run_indirect(self, buffer: Buffer, offset: int = 0) -> None:
Run the compute shader indirectly from a Buffer object.
:param Buffer buffer: the buffer containing a single workgroup size at offset.
:param int offset: the offset into the buffer in bytes.
.. py:method:: ComputeShader.get(key, default)
Returns a Uniform, UniformBlock or StorageBlock.
:param default: This is the value to be returned in case key does not exist.
.. py:method:: ComputeShader.__getitem__(key)
Get a member such as uniforms, uniform blocks and storage blocks.
.. code-block:: python
# Get a uniform
uniform = program['color']
# Uniform values can be set on the returned object
# or the `__setitem__` shortcut can be used.
program['color'].value = 1.0, 1.0, 1.0, 1.0
# Still when writing byte data we need to use the `write()` method
program['color'].write(buffer)
# Set binding for a storage block (if supported)
program['DataBlock'].binding = 0
.. py:method:: ComputeShader.__setitem__(key, value)
Set a value of uniform or uniform block.
.. code-block:: python
# Set a vec4 uniform
uniform['color'] = 1.0, 1.0, 1.0, 1.0
# Optionally we can store references to a member and set the value directly
uniform = program['color']
uniform.value = 1.0, 0.0, 0.0, 0.0
uniform = program['cameraMatrix']
uniform.write(camera_matrix)
# Set binding for a storage block (if supported)
program['DataBlock'].binding = 0
.. py:method:: ComputeShader.__iter__()
Yields the internal members names as strings.
Example::
for member in program:
obj = program[member]
print(member, obj)
if isinstance(obj, moderngl.StorageBlock):
print('This is a storage block member')
This includes all members such as uniforms, uniform blocks and storage blocks.
Attributes
----------
.. py:attribute:: ComputeShader.ctx
:type: Context
The context this object belongs to
.. py:attribute:: ComputeShader.glo
:type: int
The internal OpenGL object.
This values is provided for interoperability and debug purposes only.
.. py:attribute:: ComputeShader.extra
:type: Any
User defined data.
|
