Package glitter :: Package convenience :: Module pipeline :: Class Pipeline

Class Pipeline

                         object --+    
                                  |    
utils.proxy.InstanceDescriptorMixin --+
                                      |
                         object --+   |
                                  |   |
           utils.objects.StateMixin --+
                                      |
                                     Pipeline

Convenience class for rendering pipelines.

Pipelines contain a vertex array, a shader, and an optional framebuffer. Property access and method calls are appropriately redirected to these objects. Vertex attributes, shader uniforms, and fragment outputs can be set by their name either in the constructor or by accessing the corresponding properties on the pipeline.

Vertex attributes can be set to buffer objects or anything that can be converted to an ArrayBuffer.

Shader uniforms behave as usual.

Fragment outputs can be set to texture objects.

Attention: In order to guarantee correct functioning of vertex attribute, uniform and fragment output variables, their names must be unique, must not begin with an underscore, and must not collide with the names of any vertex array or framebuffer methods.

Usage examples:

>>> shader = ShaderProgram(...)
>>> vertices = [...]
>>> colors = [...]
>>> elements = [...]
>>> texture = Texture2D(...)

>>> pipeline = Pipeline(shader, in_position=vertices, in_color=colors, elements=elements, out_color=texture)
>>> pipeline.clear()
>>> pipeline.draw()

>>> pipeline = Pipeline(shader, use_framebuffer=False)
>>> with pipeline(in_position=vertices, in_color=colors, elements=elements):
...     pipeline.draw()
>>> with pipeline(in_position=vertices, in_color=colors, elements=elements) as p:
...     p.draw()
>>> pipeline.draw_with(in_position=vertices, in_color=colors, elements=elements)

>>> pipeline = Pipeline(shader, use_framebuffer=False)
>>> vertex_array = VertexArray(...)
>>> with pipeline:
...     vertex_array.draw()

Instance Methods

[hide private]

__init__(self, shader, use_framebuffer=True, **kwargs)
Create a new Pipeline. source code

_has_input(self, name)
Determine whether the shader as an attribute named name. source code

_add_input(self, name, value=None)
Add a proxy for the attribute named name. source code

_has_output(self, name)
Determine whether the shader as a fragment output named name. source code

_add_output(self, name, value)
Add a proxy for the fragment output named name. source code

__setattr__(self, name, value)
Set an attribute.

source code

__delattr__(self, name, value)
Delete an attribute.

source code

__enter__(self)
Bind framebuffer and shader.

source code

__exit__(self, type, value, traceback)
Unbind framebuffer and shader.

source code

draw_with(self, *args, **kwargs)
Call draw on self with attributes from kwargs set. source code

Inherited from utils.proxy.InstanceDescriptorMixin: __getattribute__

Inherited from utils.objects.StateMixin: __call__

Inherited from object: __format__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __sizeof__, __str__, __subclasshook__

Class Variables

[hide private]

_frozen = False
Whether setting of unknown attributes should be interpreted literally or as accessing vertex array and framebuffer properties.

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, shader, use_framebuffer=True, **kwargs)
(Constructor)

source code

Create a new Pipeline.

Parameters:

shader (ShaderProgram) - The compiled and linked shader program object to use.
use_framebuffer (bool) - If True, render to textures instead of the currently bound framebuffer.
kwargs - Named arguments are translated to setting of attributes.

Overrides: object.__init__

To Do: _vao and _fbo should be created dynamically when (and if) attributes and attachments are accessed, respectively; use_framebuffer should not be necessary then.

setattr(self, name, value)

source code

Set an attribute.

When name is a known attribute or starts with an underscore, or when self is not in _frozen state, __setattr__ works as usual.

When self is in _frozen state (default), setting of unknown attributes will check for vertex attributes, fragment outputs and context properties called name and create appropriate proxies or raise an error if no such attribute or output exists.

Context properties set here will be set on binding and reset on unbinding the pipeline.

Overrides: object.__setattr__

delattr(self, name, value)

source code

Delete an attribute.

When name is a known attribute or starts with an underscore, or when self is not in _frozen state, __delattr__ works as usual.

Otherwise, if the attribute is a previously set context property, it will be removed from the pipeline.

Overrides: object.__delattr__

draw_with(self, *args, **kwargs)

source code

Call draw on self with attributes from kwargs set.

Keyword arguments that are known attributes or shader input our output variable names will be set as properties on self. Context properties are set before drawing and reset afterwards. Any other arguments will be passed to draw.

To Do: kwargs context properties should override _lazy_context_properties.

Class Pipeline

__init__(self, shader, use_framebuffer=True, **kwargs) (Constructor)

__setattr__(self, name, value)

__delattr__(self, name, value)

draw_with(self, *args, **kwargs)

init(self, shader, use_framebuffer=True, **kwargs)
(Constructor)

setattr(self, name, value)

delattr(self, name, value)