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

Blend RGBA buffers of processes. More...

#include <vtkCompositeRGBAPass.h>

Inheritance diagram for vtkCompositeRGBAPass:
[legend]
Collaboration diagram for vtkCompositeRGBAPass:
[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...
 
vtkCompositeRGBAPassNewInstance () 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...
 
bool IsSupported (vtkOpenGLRenderWindow *context)
 Is the pass supported by the OpenGL context? More...
 
virtual vtkMultiProcessControllerGetController ()
 Controller If it is NULL, nothing will be rendered and a warning will be emitted. More...
 
virtual void SetController (vtkMultiProcessController *controller)
 Controller If it is NULL, nothing will be rendered and a warning will be emitted. More...
 
virtual vtkPKdTreeGetKdtree ()
 kd tree that gives processes ordering. More...
 
virtual void SetKdtree (vtkPKdTree *kdtree)
 kd tree that gives processes ordering. More...
 
- 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...
 
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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output. 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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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...
 
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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkCompositeRGBAPassNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCompositeRGBAPassSafeDownCast (vtkObjectBase *o)
 
- 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 (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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 vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCompositeRGBAPass ()
 Default constructor. More...
 
 ~vtkCompositeRGBAPass () override
 Destructor. 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkMultiProcessControllerController
 
vtkPKdTreeKdtree
 
vtkPixelBufferObjectPBO
 
vtkTextureObjectRGBATexture
 
vtkTextureObjectRootTexture
 
float * RawRGBABuffer
 
size_t RawRGBABufferSize
 
- Protected Attributes inherited from vtkRenderPass
int NumberOfRenderedProps
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

Blend RGBA buffers of processes.

Blend the RGBA buffers of satellite processes over the root process RGBA buffer. The RGBA buffer of the satellite processes are not changed.

This pass requires a OpenGL context that supports texture objects (TO), and pixel buffer objects (PBO). If not, it will emit an error message and will render its delegate and return.

See also
vtkRenderPass
Tests:
vtkCompositeRGBAPass (Tests)

Definition at line 36 of file vtkCompositeRGBAPass.h.

Member Typedef Documentation

◆ Superclass

Definition at line 40 of file vtkCompositeRGBAPass.h.

Constructor & Destructor Documentation

◆ vtkCompositeRGBAPass()

vtkCompositeRGBAPass::vtkCompositeRGBAPass ( )
protected

Default constructor.

Controller is set to NULL.

◆ ~vtkCompositeRGBAPass()

vtkCompositeRGBAPass::~vtkCompositeRGBAPass ( )
overrideprotected

Destructor.

Member Function Documentation

◆ New()

static vtkCompositeRGBAPass* vtkCompositeRGBAPass::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkCompositeRGBAPass::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 vtkRenderPass.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkCompositeRGBAPass::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkRenderPass.

◆ NewInstance()

vtkCompositeRGBAPass* vtkCompositeRGBAPass::NewInstance ( ) const

◆ PrintSelf()

void vtkCompositeRGBAPass::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.

◆ Render()

void vtkCompositeRGBAPass::Render ( const vtkRenderState s)
overridevirtual

Perform rendering according to a render state s.

Precondition
s_exists: s!=0

Implements vtkRenderPass.

◆ ReleaseGraphicsResources()

void vtkCompositeRGBAPass::ReleaseGraphicsResources ( vtkWindow w)
overridevirtual

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

Precondition
w_exists: w!=0

Reimplemented from vtkRenderPass.

◆ GetController()

virtual vtkMultiProcessController* vtkCompositeRGBAPass::GetController ( )
virtual

Controller If it is NULL, nothing will be rendered and a warning will be emitted.

Initial value is a NULL pointer.

◆ SetController()

virtual void vtkCompositeRGBAPass::SetController ( vtkMultiProcessController controller)
virtual

Controller If it is NULL, nothing will be rendered and a warning will be emitted.

Initial value is a NULL pointer.

◆ GetKdtree()

virtual vtkPKdTree* vtkCompositeRGBAPass::GetKdtree ( )
virtual

kd tree that gives processes ordering.

Initial value is a NULL pointer.

◆ SetKdtree()

virtual void vtkCompositeRGBAPass::SetKdtree ( vtkPKdTree kdtree)
virtual

kd tree that gives processes ordering.

Initial value is a NULL pointer.

◆ IsSupported()

bool vtkCompositeRGBAPass::IsSupported ( vtkOpenGLRenderWindow context)

Is the pass supported by the OpenGL context?

Member Data Documentation

◆ Controller

vtkMultiProcessController* vtkCompositeRGBAPass::Controller
protected

Definition at line 90 of file vtkCompositeRGBAPass.h.

◆ Kdtree

vtkPKdTree* vtkCompositeRGBAPass::Kdtree
protected

Definition at line 91 of file vtkCompositeRGBAPass.h.

◆ PBO

vtkPixelBufferObject* vtkCompositeRGBAPass::PBO
protected

Definition at line 93 of file vtkCompositeRGBAPass.h.

◆ RGBATexture

vtkTextureObject* vtkCompositeRGBAPass::RGBATexture
protected

Definition at line 94 of file vtkCompositeRGBAPass.h.

◆ RootTexture

vtkTextureObject* vtkCompositeRGBAPass::RootTexture
protected

Definition at line 95 of file vtkCompositeRGBAPass.h.

◆ RawRGBABuffer

float* vtkCompositeRGBAPass::RawRGBABuffer
protected

Definition at line 96 of file vtkCompositeRGBAPass.h.

◆ RawRGBABufferSize

size_t vtkCompositeRGBAPass::RawRGBABufferSize
protected

Definition at line 97 of file vtkCompositeRGBAPass.h.


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