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

Abstract render pass with shader modifications. More...

#include <vtkOpenGLRenderPass.h>

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

Public Types

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...
 
vtkOpenGLRenderPassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual bool PreReplaceShaderValues (std::string &vertexShader, std::string &geometryShader, std::string &fragmentShader, vtkAbstractMapper *mapper, vtkProp *prop)
 Use vtkShaderProgram::Substitute to replace //VTK::XXX:YYY declarations in the shader sources. More...
 
virtual bool PostReplaceShaderValues (std::string &vertexShader, std::string &geometryShader, std::string &fragmentShader, vtkAbstractMapper *mapper, vtkProp *prop)
 Use vtkShaderProgram::Substitute to replace //VTK::XXX:YYY declarations in the shader sources. More...
 
virtual bool SetShaderParameters (vtkShaderProgram *program, vtkAbstractMapper *mapper, vtkProp *prop, vtkOpenGLVertexArrayObject *VAO=nullptr)
 Update the uniforms of the shader program. More...
 
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 void Render (const vtkRenderState *s)=0
 Perform rendering according to a render state s. More...
 
virtual int GetNumberOfRenderedProps ()
 Number of props rendered at the last Render call. More...
 
virtual void ReleaseGraphicsResources (vtkWindow *w)
 Release graphics resources and ask components to release their own resources. 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 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
 
 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

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

Abstract render pass with shader modifications.

Allows a render pass to update shader code using a new virtual API.

Definition at line 38 of file vtkOpenGLRenderPass.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkOpenGLRenderPass.h.

Constructor & Destructor Documentation

◆ vtkOpenGLRenderPass()

vtkOpenGLRenderPass::vtkOpenGLRenderPass ( )
protected

◆ ~vtkOpenGLRenderPass()

vtkOpenGLRenderPass::~vtkOpenGLRenderPass ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOpenGLRenderPass::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkOpenGLRenderPass* vtkOpenGLRenderPass::NewInstance ( ) const

◆ PrintSelf()

void vtkOpenGLRenderPass::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 vtkRenderPass.

Reimplemented in vtkSobelGradientMagnitudePass, vtkValuePass, vtkShadowMapPass, vtkShadowMapBakerPass, vtkSSAOPass, vtkToneMappingPass, vtkPanoramicProjectionPass, vtkPointFillPass, vtkSimpleMotionBlurPass, and vtkOrderIndependentTranslucentPass.

◆ PreReplaceShaderValues()

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

Use vtkShaderProgram::Substitute to replace //VTK::XXX:YYY declarations in the shader sources.

Gets called before other mapper shader replacements Return false on error.

Reimplemented in vtkShadowMapBakerPass, vtkShadowMapPass, vtkDualDepthPeelingPass, and vtkSSAOPass.

◆ PostReplaceShaderValues()

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

Use vtkShaderProgram::Substitute to replace //VTK::XXX:YYY declarations in the shader sources.

Gets called after other mapper shader replacements. Return false on error.

Reimplemented in vtkValuePass, vtkShadowMapPass, vtkDepthPeelingPass, vtkDualDepthPeelingPass, vtkOrderIndependentTranslucentPass, and vtkSSAOPass.

◆ SetShaderParameters()

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

Update the uniforms of the shader program.

Return false on error.

Reimplemented in vtkShadowMapBakerPass, vtkValuePass, vtkShadowMapPass, vtkDepthPeelingPass, vtkDualDepthPeelingPass, and vtkSSAOPass.

◆ GetShaderStageMTime()

virtual vtkMTimeType vtkOpenGLRenderPass::GetShaderStageMTime ( )
virtual

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.

This method should return the last time that the shader stage changed, or 0 if the shader is single-stage.

Reimplemented in vtkValuePass, and vtkDualDepthPeelingPass.

◆ RenderPasses()

static vtkInformationObjectBaseVectorKey* vtkOpenGLRenderPass::RenderPasses ( )
static

Key containing information about the current pass.

◆ SetActiveDrawBuffers()

virtual void vtkOpenGLRenderPass::SetActiveDrawBuffers ( unsigned int  )
virtual

Number of active draw buffers.

◆ GetActiveDrawBuffers()

virtual unsigned int vtkOpenGLRenderPass::GetActiveDrawBuffers ( )
virtual

◆ PreRender()

void vtkOpenGLRenderPass::PreRender ( const vtkRenderState s)
protected

Call before rendering to update the actors' information keys.

◆ PostRender()

void vtkOpenGLRenderPass::PostRender ( const vtkRenderState s)
protected

Call after rendering to clean up the actors' information keys.

Member Data Documentation

◆ ActiveDrawBuffers

unsigned int vtkOpenGLRenderPass::ActiveDrawBuffers = 0
protected

Definition at line 101 of file vtkOpenGLRenderPass.h.


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