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

Render into a FO. More...

#include <vtkFramebufferPass.h>

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

Public Types

typedef vtkDepthImageProcessingPass Superclass
 
- Public Types inherited from vtkDepthImageProcessingPass
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...
 
vtkFramebufferPassNewInstance () 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 s. More...
 
void ReleaseGraphicsResources (vtkWindow *w) override
 Release graphics resources and ask components to release their own resources. More...
 
virtual void SetDepthFormat (int)
 Set the format to use for the depth texture e.g. More...
 
virtual void SetColorFormat (int)
 Set the format to use for the color texture vtkTextureObject::Float16 vtkTextureObject::Float32 and vtkTextureObject::Fixed8 are supported. More...
 
virtual vtkTextureObjectGetDepthTexture ()
 
virtual vtkTextureObjectGetColorTexture ()
 
- Public Member Functions inherited from vtkDepthImageProcessingPass
vtkDepthImageProcessingPassNewInstance () const
 
- Public Member Functions inherited from vtkImageProcessingPass
vtkImageProcessingPassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void ReleaseGraphicsResources (vtkWindow *w) override
 Release graphics resources and ask components to release their own resources. More...
 
virtual vtkRenderPassGetDelegatePass ()
 Delegate for rendering the image to be processed. More...
 
virtual void SetDelegatePass (vtkRenderPass *delegatePass)
 
- Public Member Functions inherited from vtkOpenGLRenderPass
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 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 vtkFramebufferPassNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkFramebufferPassSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkDepthImageProcessingPass
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDepthImageProcessingPassSafeDownCast (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
 
 vtkFramebufferPass ()
 Default constructor. More...
 
 ~vtkFramebufferPass () override
 Destructor. More...
 
- Protected Member Functions inherited from vtkDepthImageProcessingPass
 vtkDepthImageProcessingPass ()
 Default constructor. More...
 
 ~vtkDepthImageProcessingPass () override
 Destructor. More...
 
virtual void RenderDelegate (const vtkRenderState *s, int width, int height, int newWidth, int newHeight, vtkOpenGLFramebufferObject *fbo, vtkTextureObject *colortarget, vtkTextureObject *depthtarget)
 Render delegate with a image of different dimensions than the original one. More...
 
void ReadWindowSize (const vtkRenderState *s)
 Read parent size - for sake of code clarity This function is generic, can be useful in multiple image-based rendering classes. More...
 
- 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

vtkOpenGLFramebufferObjectFrameBufferObject
 Graphics resources. More...
 
vtkTextureObjectColorTexture
 
vtkTextureObjectDepthTexture
 
int ViewportX
 Cache viewport values for depth peeling. More...
 
int ViewportY
 
int ViewportWidth
 
int ViewportHeight
 
int DepthFormat
 
int ColorFormat
 
- Protected Attributes inherited from vtkDepthImageProcessingPass
int Origin [2]
 
int Width
 
int Height
 
int W
 
int H
 
int ExtraPixels
 
- 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

Render into a FO.

See also
vtkRenderPass

Definition at line 34 of file vtkFramebufferPass.h.

Member Typedef Documentation

◆ Superclass

Definition at line 38 of file vtkFramebufferPass.h.

Constructor & Destructor Documentation

◆ vtkFramebufferPass()

vtkFramebufferPass::vtkFramebufferPass ( )
protected

Default constructor.

DelegatePass is set to NULL.

◆ ~vtkFramebufferPass()

vtkFramebufferPass::~vtkFramebufferPass ( )
overrideprotected

Destructor.

Member Function Documentation

◆ New()

static vtkFramebufferPass* vtkFramebufferPass::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkFramebufferPass::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 vtkDepthImageProcessingPass.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkFramebufferPass::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDepthImageProcessingPass.

◆ NewInstance()

vtkFramebufferPass* vtkFramebufferPass::NewInstance ( ) const

◆ PrintSelf()

void vtkFramebufferPass::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 vtkDepthImageProcessingPass.

◆ Render()

void vtkFramebufferPass::Render ( const vtkRenderState s)
overridevirtual

Perform rendering according to a render state s.

Precondition
s_exists: s!=0

Implements vtkRenderPass.

◆ ReleaseGraphicsResources()

void vtkFramebufferPass::ReleaseGraphicsResources ( vtkWindow w)
overridevirtual

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

Precondition
w_exists: w!=0

Reimplemented from vtkRenderPass.

◆ SetDepthFormat()

virtual void vtkFramebufferPass::SetDepthFormat ( int  )
virtual

Set the format to use for the depth texture e.g.

vtkTextureObject::Float32

◆ SetColorFormat()

virtual void vtkFramebufferPass::SetColorFormat ( int  )
virtual

Set the format to use for the color texture vtkTextureObject::Float16 vtkTextureObject::Float32 and vtkTextureObject::Fixed8 are supported.

Fixed8 is the default.

◆ GetDepthTexture()

virtual vtkTextureObject* vtkFramebufferPass::GetDepthTexture ( )
virtual

◆ GetColorTexture()

virtual vtkTextureObject* vtkFramebufferPass::GetColorTexture ( )
virtual

Member Data Documentation

◆ FrameBufferObject

vtkOpenGLFramebufferObject* vtkFramebufferPass::FrameBufferObject
protected

Graphics resources.

Definition at line 88 of file vtkFramebufferPass.h.

◆ ColorTexture

vtkTextureObject* vtkFramebufferPass::ColorTexture
protected

Definition at line 89 of file vtkFramebufferPass.h.

◆ DepthTexture

vtkTextureObject* vtkFramebufferPass::DepthTexture
protected

Definition at line 90 of file vtkFramebufferPass.h.

◆ ViewportX

int vtkFramebufferPass::ViewportX
protected

Cache viewport values for depth peeling.

Definition at line 96 of file vtkFramebufferPass.h.

◆ ViewportY

int vtkFramebufferPass::ViewportY
protected

Definition at line 97 of file vtkFramebufferPass.h.

◆ ViewportWidth

int vtkFramebufferPass::ViewportWidth
protected

Definition at line 98 of file vtkFramebufferPass.h.

◆ ViewportHeight

int vtkFramebufferPass::ViewportHeight
protected

Definition at line 99 of file vtkFramebufferPass.h.

◆ DepthFormat

int vtkFramebufferPass::DepthFormat
protected

Definition at line 102 of file vtkFramebufferPass.h.

◆ ColorFormat

int vtkFramebufferPass::ColorFormat
protected

Definition at line 103 of file vtkFramebufferPass.h.


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