Trees       Indices       Help   
Package glitter :: Package framebuffers :: Module framebuffer :: Class Framebuffer
[hide private]
[frames] | no frames]

Class Framebuffer

source code

              object --+        
                       |        
  utils.objects.GLObject --+    
                           |    
 utils.objects.ManagedObject --+
                               |
              object --+       |
                       |       |
  utils.objects.GLObject --+   |
                           |   |
              object --+   |   |
                       |   |   |
utils.objects.StateMixin --+   |
                           |   |
utils.objects.BindableObject --+
                               |
                              Framebuffer
Instance Methods [hide private]
 
__init__(self, *attachments, **kwargs)
Create a new framebuffer.		 source code
 
__getitem__(self, index) source code
 
__setitem__(self, index, value) source code
 
__delitem__(self, index) source code
 
_on_bind(self)
Function to call before binding.		 source code
 
_on_release(self)
Function to call after releasing.		 source code
 
_attach(self, attachment, texture=None, layer=None, level=0)
Attach a texture to an attachment.		 source code
 
attach(self, index, texture=None, layer=None, level=0)
Attach a texture to color attachment index.		 source code
 
attach_depth(self, texture=None, layer=None, level=0)
Attach a texture to the depth attachment.		 source code
 
attach_stencil(self, texture=None, layer=None, level=0)
Attach a texture to the stencil attachment.		 source code
 
clear(self, color=None, depth=None, stencil=None)
Clear the framebuffer.		 source code

Inherited from utils.objects.ManagedObject: __del__

Inherited from utils.objects.BindableObject: __enter__, __exit__, bind

Inherited from utils.objects.StateMixin: __call__

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

Class Variables [hide private]
  _generate_id = _libraries ['libGL.so.1'].glGenFramebuffers
Constructor function.
  _delete_id = _libraries ['libGL.so.1'].glDeleteBuffers
Destructor function.
  _db = 'framebuffers'
The name of the corresponding object database in the Context.
  _binding = 'draw_framebuffer_binding'
Name of the corresponding property in the Context.
  _target = GL_DRAW_FRAMEBUFFER(36009)
  framebuffer_status = Enum(INCOMPLETE_MULTISAMPLE, INCOMPLETE_L...
  _initialized = False

Inherited from utils.objects.ManagedObject (private): _type

Inherited from utils.objects.BindableObject (private): _bind_value

Instance Variables [hide private]

Inherited from utils.objects.ManagedObject (private): _id

Inherited from utils.objects.BindableObject (private): _stack

Inherited from utils.objects.GLObject (private): _context

Properties [hide private]
  depth
  stencil
Framebuffer.framebuffer_status enum status
The framebuffer completeness status.
  shape

Inherited from utils.objects.GLObject: context

Inherited from object: __class__

Method Details [hide private]

__init__(self, *attachments, **kwargs)
(Constructor)

source code 

Create a new framebuffer.

Parameters:
  • attachments (list of Textures) - Textures to bind to color attachments.
  • kwargs (dict) - Named arguments.
  • context (Context) - The context in which to create the framebuffer.
  • depth (Texture) - An optional depth buffer attachment.
  • stencil (Texture) - An optional stencil buffer attachment.
Overrides: object.__init__

_on_bind(self)

source code 

Function to call before binding.

ShaderPrograms, for example, bind textures here.

Overrides: _on_bind

To Do: Setup color_writemasks, depth_writemasks, blend_funcs, blend_equations, and depth_ranges after viewport.

_on_release(self)

source code 

Function to call after releasing.

ShaderPrograms, for example, release textures here.

Overrides: _on_release

To Do: Restore depth_ranges, blend_equations, blend_funcs, depth_writemasks, and color_writemasks before viewport.

_attach(self, attachment, texture=None, layer=None, level=0)

source code 

Attach a texture to an attachment.

texture may be a (texture, layer) tuple generated by Texture.__getitem__().

attach(self, index, texture=None, layer=None, level=0)

source code 

Attach a texture to color attachment index.

texture may be a (texture, layer) tuple generated by Texture.__getitem__(). Otherwise, layer specifies which texture layer is to be bound. All layers are bound when layer is None.

level specifies which resolution level of the texture is to be bound.

If texture is None, the attachment will be unbound.

attach_depth(self, texture=None, layer=None, level=0)

source code 

Attach a texture to the depth attachment.

texture may be a (texture, layer) tuple generated by Texture.__getitem__(). Otherwise, layer specifies which texture layer is to be bound. All layers are bound when layer is None.

level specifies which resolution level of the texture is to be bound.

If texture is None, the attachment will be unbound.

attach_stencil(self, texture=None, layer=None, level=0)

source code 

Attach a texture to the stencil attachment.

texture may be a (texture, layer) tuple generated by Texture.__getitem__(). Otherwise, layer specifies which texture layer is to be bound. All layers are bound when layer is None.

level specifies which resolution level of the texture is to be bound.

If texture is None, the attachment will be unbound.

clear(self, color=None, depth=None, stencil=None)

source code 

Clear the framebuffer.

Parameters:
  • color (bool or numpy.ndarray.) - Whether to clear the color buffer, and optionally, to which value.
  • depth (bool or numpy.ndarray.) - Whether to clear the depth buffer, and optionally, to which value.
  • stencil (bool or numpy.ndarray.

    If no parameters are given, color, depth and stencil are cleared with the current clear values.

    ) - Whether to clear the stencil buffer, and optionally, to which value.

To Do: Use glClearBuffer to clear selected attachments only.


Class Variable Details [hide private]

framebuffer_status

Value:
Enum(INCOMPLETE_MULTISAMPLE, INCOMPLETE_LAYER_TARGETS, COMPLETE, INCOM\
PLETE_ATTACHMENT, INCOMPLETE_MISSING_ATTACHMENT, UNDEFINED, INCOMPLETE\
_DRAW_BUFFER, INCOMPLETE_READ_BUFFER, UNSUPPORTED)

Property Details [hide private]

depth

Get Method:
unreachable.depth(self)
Set Method:
unreachable.depth(self, depth)
Delete Method:
unreachable.depth(self)

stencil

Get Method:
unreachable.stencil(self)
Set Method:
unreachable.stencil(self, stencil)
Delete Method:
unreachable.stencil(self)

status

The framebuffer completeness status.

Get Method:
unreachable.status(self) - The framebuffer completeness status.
Type:
Framebuffer.framebuffer_status enum

shape

Get Method:
unreachable.shape(self)

   Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Fri Mar 16 17:56:04 2012 http://epydoc.sourceforge.net