Panda3D
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
FilterManager Class Reference
Inheritance diagram for FilterManager:
DirectObject

Public Member Functions

def __init__ (self, win, cam, forcex=0, forcey=0)
 
def cleanup (self)
 
def createBuffer (self, name, xsize, ysize, texgroup, depthbits=1)
 
def getClears (self, region)
 
def getScaledSize (self, mul, div, align)
 
def isFullscreen (self)
 
def renderQuadInto (self, name="filter-stage", mul=1, div=1, align=1, depthtex=None, colortex=None, auxtex0=None, auxtex1=None)
 
def renderSceneInto (self, depthtex=None, colortex=None, auxtex=None, auxbits=0, textures=None)
 
def resizeBuffers (self)
 
def setClears (self, region, clears)
 
def setStackedClears (self, region, clears0, clears1)
 
def windowEvent (self, win)
 
- Public Member Functions inherited from DirectObject
def __init__ (self)
 
def accept (self, event, method, extraArgs=[])
 
def acceptOnce (self, event, method, extraArgs=[])
 
def addTask (self, *args, **kwargs)
 
def detectLeaks (self)
 
def doMethodLater (self, *args, **kwargs)
 
def getAllAccepting (self)
 
def ignore (self, event)
 
def ignoreAll (self)
 
def isAccepting (self, event)
 
def isIgnoring (self, event)
 
def removeAllTasks (self)
 
def removeTask (self, taskOrName)
 

Public Attributes

 basex
 
 basey
 
 buffers
 
 camera
 
 caminit
 
 camstate
 
 engine
 
 forcex
 
 forcey
 
 nextsort
 
 rclears
 
 region
 
 sizes
 
 wclears
 
 win
 

Static Public Attributes

def create_buffer = createBuffer
 
def get_clears = getClears
 
def get_scaled_size = getScaledSize
 
def is_fullscreen = isFullscreen
 
 notify = None
 
def render_quad_into = renderQuadInto
 
def render_scene_into = renderSceneInto
 
def resize_buffers = resizeBuffers
 
def set_clears = setClears
 
def set_stacked_clears = setStackedClears
 
def window_event = windowEvent
 
- Static Public Attributes inherited from DirectObject
def accept_once = acceptOnce
 
def add_task = addTask
 
def detect_leaks = detectLeaks
 
def do_method_later = doMethodLater
 
def get_all_accepting = getAllAccepting
 
def ignore_all = ignoreAll
 
def is_accepting = isAccepting
 
def is_ignoring = isIgnoring
 
def remove_all_tasks = removeAllTasks
 
def remove_task = removeTask
 

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  win,
  cam,
  forcex = 0,
  forcey = 0 
)
The FilterManager constructor requires you to provide
a window which is rendering a scene, and the camera which is
used by that window to render the scene.  These are henceforth
called the 'original window' and the 'original camera.' 

Member Function Documentation

◆ cleanup()

def cleanup (   self)
Restore everything to its original state, deleting any
new buffers in the process. 

◆ createBuffer()

def createBuffer (   self,
  name,
  xsize,
  ysize,
  texgroup,
  depthbits = 1 
)
Low-level buffer creation.  Not intended for public use. 

◆ getClears()

def getClears (   self,
  region 
)

◆ getScaledSize()

def getScaledSize (   self,
  mul,
  div,
  align 
)
Calculate the size of the desired window. Not public. 

◆ isFullscreen()

def isFullscreen (   self)

◆ renderQuadInto()

def renderQuadInto (   self,
  name = "filter-stage",
  mul = 1,
  div = 1,
  align = 1,
  depthtex = None,
  colortex = None,
  auxtex0 = None,
  auxtex1 = None 
)
Creates an offscreen buffer for an intermediate
computation. Installs a quad into the buffer.  Returns
the fullscreen quad.  The size of the buffer is initially
equal to the size of the main window.  The parameters 'mul',
'div', and 'align' can be used to adjust that size. 

◆ renderSceneInto()

def renderSceneInto (   self,
  depthtex = None,
  colortex = None,
  auxtex = None,
  auxbits = 0,
  textures = None 
)
Causes the scene to be rendered into the supplied textures
instead of into the original window.  Puts a fullscreen quad
into the original window to show the render-to-texture results.
Returns the quad.  Normally, the caller would then apply a
shader to the quad.

To elaborate on how this all works:

* An offscreen buffer is created.  It is set up to mimic
  the original display region - it is the same size,
  uses the same clear colors, and contains a DisplayRegion
  that uses the original camera.

* A fullscreen quad and an orthographic camera to render
  that quad are both created.  The original camera is
  removed from the original window, and in its place, the
  orthographic quad-camera is installed.

* The fullscreen quad is textured with the data from the
  offscreen buffer.  A shader is applied that tints the
  results pink.

* Automatic shader generation NOT enabled.
  If you have a filter that depends on a render target from
  the auto-shader, you either need to set an auto-shader
  attrib on the main camera or scene, or, you need to provide
  these outputs in your own shader.

* All clears are disabled on the original display region.
  If the display region fills the whole window, then clears
  are disabled on the original window as well.  It is
  assumed that rendering the full-screen quad eliminates
  the need to do clears.

Hence, the original window which used to contain the actual
scene, now contains a pink-tinted quad with a texture of the
scene.  It is assumed that the user will replace the shader
on the quad with a more interesting filter. 

◆ resizeBuffers()

def resizeBuffers (   self)
Resize all buffers to match the size of the window. 

◆ setClears()

def setClears (   self,
  region,
  clears 
)

◆ setStackedClears()

def setStackedClears (   self,
  region,
  clears0,
  clears1 
)

◆ windowEvent()

def windowEvent (   self,
  win 
)
When the window changes size, automatically resize all buffers 

Member Data Documentation

◆ basex

basex

◆ basey

basey

◆ buffers

buffers

◆ camera

camera

◆ caminit

caminit

◆ camstate

camstate

◆ create_buffer

def create_buffer = createBuffer
static

◆ engine

engine

◆ forcex

forcex

◆ forcey

forcey

◆ get_clears

def get_clears = getClears
static

◆ get_scaled_size

def get_scaled_size = getScaledSize
static

◆ is_fullscreen

def is_fullscreen = isFullscreen
static

◆ nextsort

nextsort

◆ notify

notify = None
static

◆ rclears

rclears

◆ region

region

◆ render_quad_into

def render_quad_into = renderQuadInto
static

◆ render_scene_into

def render_scene_into = renderSceneInto
static

◆ resize_buffers

def resize_buffers = resizeBuffers
static

◆ set_clears

def set_clears = setClears
static

◆ set_stacked_clears

def set_stacked_clears = setStackedClears
static

◆ sizes

sizes

◆ wclears

wclears

◆ win

win

◆ window_event

def window_event = windowEvent
static