VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSSAOPass Class Reference

Implement a screen-space ambient occlusion pass. More...

#include <vtkSSAOPass.h>

Inheritance diagram for vtkSSAOPass:
[legend]
Collaboration diagram for vtkSSAOPass:
[legend]

Public Types

typedef vtkImageProcessingPass Superclass
 
- Public Types inherited from vtkImageProcessingPass
typedef vtkOpenGLRenderPass Superclass
 
- Public Types inherited from vtkOpenGLRenderPass
typedef vtkRenderPass Superclass
 
- Public Types inherited from vtkRenderPass
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkSSAOPassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Render (const vtkRenderState *s) override
 Perform rendering according to a render state. More...
 
void ReleaseGraphicsResources (vtkWindow *w) override
 Release graphics resources and ask components to release their own resources. More...
 
bool PreReplaceShaderValues (std::string &vertexShader, std::string &geometryShader, std::string &fragmentShader, vtkAbstractMapper *mapper, vtkProp *prop) override
 Pre replace shader values. More...
 
bool PostReplaceShaderValues (std::string &vertexShader, std::string &geometryShader, std::string &fragmentShader, vtkAbstractMapper *mapper, vtkProp *prop) override
 Post replace shader values. More...
 
bool SetShaderParameters (vtkShaderProgram *program, vtkAbstractMapper *mapper, vtkProp *prop, vtkOpenGLVertexArrayObject *VAO=nullptr) override
 Set shader parameters. More...
 
virtual double GetRadius ()
 Get/Set the SSAO hemisphere radius. More...
 
virtual void SetRadius (double)
 
virtual unsigned int GetKernelSize ()
 Get/Set the number of samples. More...
 
virtual void SetKernelSize (unsigned int)
 
virtual double GetBias ()
 Get/Set the bias when comparing samples. More...
 
virtual void SetBias (double)
 
virtual bool GetBlur ()
 Get/Set blurring of the ambient occlusion. More...
 
virtual void SetBlur (bool)
 
virtual void BlurOn ()
 
virtual void BlurOff ()
 
- Public Member Functions inherited from vtkImageProcessingPass
vtkImageProcessingPassNewInstance () const
 
virtual vtkRenderPassGetDelegatePass ()
 Delegate for rendering the image to be processed. More...
 
virtual void SetDelegatePass (vtkRenderPass *delegatePass)
 
- Public Member Functions inherited from vtkOpenGLRenderPass
vtkOpenGLRenderPassNewInstance () const
 
virtual vtkMTimeType GetShaderStageMTime ()
 For multi-stage render passes that need to change shader code during a single pass, use this method to notify a mapper that the shader needs to be rebuilt (rather than reuse the last cached shader. More...
 
virtual void SetActiveDrawBuffers (unsigned int)
 Number of active draw buffers. More...
 
virtual unsigned int GetActiveDrawBuffers ()
 
- Public Member Functions inherited from vtkRenderPass
vtkRenderPassNewInstance () const
 
virtual int GetNumberOfRenderedProps ()
 Number of props rendered at the last Render call. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkSSAOPassNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkSSAOPassSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImageProcessingPass
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageProcessingPassSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkOpenGLRenderPass
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenGLRenderPassSafeDownCast (vtkObjectBase *o)
 
static vtkInformationObjectBaseVectorKeyRenderPasses ()
 Key containing information about the current pass. More...
 
- Static Public Member Functions inherited from vtkRenderPass
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRenderPassSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkSSAOPass ()=default
 
 ~vtkSSAOPass () override=default
 
void ComputeKernel ()
 
void InitializeGraphicsResources (vtkOpenGLRenderWindow *renWin, int w, int h)
 
void RenderDelegate (const vtkRenderState *s, int w, int h)
 
void RenderSSAO (vtkOpenGLRenderWindow *renWin, vtkMatrix4x4 *projection, int w, int h)
 
void RenderCombine (vtkOpenGLRenderWindow *renWin)
 
- Protected Member Functions inherited from vtkImageProcessingPass
 vtkImageProcessingPass ()
 Default constructor. More...
 
 ~vtkImageProcessingPass () override
 Destructor. More...
 
void RenderDelegate (const vtkRenderState *s, int width, int height, int newWidth, int newHeight, vtkOpenGLFramebufferObject *fbo, vtkTextureObject *target)
 Render delegate with a image of different dimensions than the original one. More...
 
- Protected Member Functions inherited from vtkOpenGLRenderPass
 vtkOpenGLRenderPass ()
 
 ~vtkOpenGLRenderPass () override
 
void PreRender (const vtkRenderState *s)
 Call before rendering to update the actors' information keys. More...
 
void PostRender (const vtkRenderState *s)
 Call after rendering to clean up the actors' information keys. More...
 
- Protected Member Functions inherited from vtkRenderPass
 vtkRenderPass ()
 Default constructor. More...
 
 ~vtkRenderPass () override
 Destructor. More...
 
void UpdateCamera (vtkRenderer *renderer)
 Call UpdateCamera() on Renderer. More...
 
void ClearLights (vtkRenderer *renderer)
 Call ClearLights() on Renderer. More...
 
void UpdateLightGeometry (vtkRenderer *renderer)
 Call UpdateLightGeometry() on Renderer. More...
 
void UpdateLights (vtkRenderer *renderer)
 Call UpdateLights() on Renderer. More...
 
void UpdateGeometry (vtkRenderer *renderer, vtkFrameBufferObjectBase *fbo=nullptr)
 Call UpdateGeometry() on Renderer. More...
 
void SetLastRenderingUsedDepthPeeling (vtkRenderer *renderer, bool value)
 Modify protected member LastRenderingUsedDepthPeeling on Renderer. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkTextureObjectColorTexture = nullptr
 
vtkTextureObjectPositionTexture = nullptr
 
vtkTextureObjectNormalTexture = nullptr
 
vtkTextureObjectSSAOTexture = nullptr
 
vtkTextureObjectDepthTexture = nullptr
 
vtkOpenGLFramebufferObjectFrameBufferObject = nullptr
 
vtkOpenGLQuadHelperSSAOQuadHelper = nullptr
 
vtkOpenGLQuadHelperCombineQuadHelper = nullptr
 
std::vector< floatKernel
 
unsigned int KernelSize = 32
 
double Radius = 0.5
 
double Bias = 0.01
 
bool Blur = false
 
- Protected Attributes inherited from vtkImageProcessingPass
vtkRenderPassDelegatePass
 
- Protected Attributes inherited from vtkOpenGLRenderPass
unsigned int ActiveDrawBuffers = 0
 
- Protected Attributes inherited from vtkRenderPass
int NumberOfRenderedProps
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Implement a screen-space ambient occlusion pass.

SSAO darkens some pixels to improve depth perception simulating ambient occlusion in screen space. For each fragment, random samples inside a hemisphere at the fragment position oriented with the normal are tested against other fragments to compute an average occlusion. The number of samples and the radius of the hemisphere are configurables.

See also
vtkRenderPass

Definition at line 42 of file vtkSSAOPass.h.

Member Typedef Documentation

◆ Superclass

Definition at line 46 of file vtkSSAOPass.h.

Constructor & Destructor Documentation

◆ vtkSSAOPass()

vtkSSAOPass::vtkSSAOPass ( )
protecteddefault

◆ ~vtkSSAOPass()

vtkSSAOPass::~vtkSSAOPass ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkSSAOPass* vtkSSAOPass::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkSSAOPass::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkSSAOPass::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageProcessingPass.

◆ SafeDownCast()

static vtkSSAOPass* vtkSSAOPass::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkSSAOPass::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImageProcessingPass.

◆ NewInstance()

vtkSSAOPass* vtkSSAOPass::NewInstance ( ) const

◆ PrintSelf()

void vtkSSAOPass::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkImageProcessingPass.

◆ Render()

void vtkSSAOPass::Render ( const vtkRenderState s)
overridevirtual

Perform rendering according to a render state.

Implements vtkRenderPass.

◆ ReleaseGraphicsResources()

void vtkSSAOPass::ReleaseGraphicsResources ( vtkWindow w)
overridevirtual

Release graphics resources and ask components to release their own resources.

Reimplemented from vtkImageProcessingPass.

◆ PreReplaceShaderValues()

bool vtkSSAOPass::PreReplaceShaderValues ( std::string &  vertexShader,
std::string &  geometryShader,
std::string &  fragmentShader,
vtkAbstractMapper mapper,
vtkProp prop 
)
overridevirtual

Pre replace shader values.

Reimplemented from vtkOpenGLRenderPass.

◆ PostReplaceShaderValues()

bool vtkSSAOPass::PostReplaceShaderValues ( std::string &  vertexShader,
std::string &  geometryShader,
std::string &  fragmentShader,
vtkAbstractMapper mapper,
vtkProp prop 
)
overridevirtual

Post replace shader values.

Reimplemented from vtkOpenGLRenderPass.

◆ SetShaderParameters()

bool vtkSSAOPass::SetShaderParameters ( vtkShaderProgram program,
vtkAbstractMapper mapper,
vtkProp prop,
vtkOpenGLVertexArrayObject VAO = nullptr 
)
overridevirtual

Set shader parameters.

Set the draw buffers depending on the mapper.

Reimplemented from vtkOpenGLRenderPass.

◆ GetRadius()

virtual double vtkSSAOPass::GetRadius ( )
virtual

Get/Set the SSAO hemisphere radius.

Default is 0.5

◆ SetRadius()

virtual void vtkSSAOPass::SetRadius ( double  )
virtual

◆ GetKernelSize()

virtual unsigned int vtkSSAOPass::GetKernelSize ( )
virtual

Get/Set the number of samples.

Default is 32

◆ SetKernelSize()

virtual void vtkSSAOPass::SetKernelSize ( unsigned int  )
virtual

◆ GetBias()

virtual double vtkSSAOPass::GetBias ( )
virtual

Get/Set the bias when comparing samples.

Default is 0.01

◆ SetBias()

virtual void vtkSSAOPass::SetBias ( double  )
virtual

◆ GetBlur()

virtual bool vtkSSAOPass::GetBlur ( )
virtual

Get/Set blurring of the ambient occlusion.

Blurring can help to improve the result if samples number is low. Default is false

◆ SetBlur()

virtual void vtkSSAOPass::SetBlur ( bool  )
virtual

◆ BlurOn()

virtual void vtkSSAOPass::BlurOn ( )
virtual

◆ BlurOff()

virtual void vtkSSAOPass::BlurOff ( )
virtual

◆ ComputeKernel()

void vtkSSAOPass::ComputeKernel ( )
protected

◆ InitializeGraphicsResources()

void vtkSSAOPass::InitializeGraphicsResources ( vtkOpenGLRenderWindow renWin,
int  w,
int  h 
)
protected

◆ RenderDelegate()

void vtkSSAOPass::RenderDelegate ( const vtkRenderState s,
int  w,
int  h 
)
protected

◆ RenderSSAO()

void vtkSSAOPass::RenderSSAO ( vtkOpenGLRenderWindow renWin,
vtkMatrix4x4 projection,
int  w,
int  h 
)
protected

◆ RenderCombine()

void vtkSSAOPass::RenderCombine ( vtkOpenGLRenderWindow renWin)
protected

Member Data Documentation

◆ ColorTexture

vtkTextureObject* vtkSSAOPass::ColorTexture = nullptr
protected

Definition at line 126 of file vtkSSAOPass.h.

◆ PositionTexture

vtkTextureObject* vtkSSAOPass::PositionTexture = nullptr
protected

Definition at line 127 of file vtkSSAOPass.h.

◆ NormalTexture

vtkTextureObject* vtkSSAOPass::NormalTexture = nullptr
protected

Definition at line 128 of file vtkSSAOPass.h.

◆ SSAOTexture

vtkTextureObject* vtkSSAOPass::SSAOTexture = nullptr
protected

Definition at line 129 of file vtkSSAOPass.h.

◆ DepthTexture

vtkTextureObject* vtkSSAOPass::DepthTexture = nullptr
protected

Definition at line 130 of file vtkSSAOPass.h.

◆ FrameBufferObject

vtkOpenGLFramebufferObject* vtkSSAOPass::FrameBufferObject = nullptr
protected

Definition at line 132 of file vtkSSAOPass.h.

◆ SSAOQuadHelper

vtkOpenGLQuadHelper* vtkSSAOPass::SSAOQuadHelper = nullptr
protected

Definition at line 134 of file vtkSSAOPass.h.

◆ CombineQuadHelper

vtkOpenGLQuadHelper* vtkSSAOPass::CombineQuadHelper = nullptr
protected

Definition at line 135 of file vtkSSAOPass.h.

◆ Kernel

std::vector<float> vtkSSAOPass::Kernel
protected

Definition at line 137 of file vtkSSAOPass.h.

◆ KernelSize

unsigned int vtkSSAOPass::KernelSize = 32
protected

Definition at line 138 of file vtkSSAOPass.h.

◆ Radius

double vtkSSAOPass::Radius = 0.5
protected

Definition at line 139 of file vtkSSAOPass.h.

◆ Bias

double vtkSSAOPass::Bias = 0.01
protected

Definition at line 140 of file vtkSSAOPass.h.

◆ Blur

bool vtkSSAOPass::Blur = false
protected

Definition at line 141 of file vtkSSAOPass.h.


The documentation for this class was generated from the following file: