VTK
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkTransformFeedback Class Reference

Manages a TransformFeedback buffer. More...

#include <vtkTransformFeedback.h>

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

Classes

struct  VaryingMetaData
 

Public Types

enum  VaryingRole { Vertex_ClipCoordinate_F, Color_RGBA_F, Normal_F, Next_Buffer }
 The role a captured varying fills. More...
 
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...
 
vtkTransformFeedbackNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void ClearVaryings ()
 Clear the list of varying attributes to capture. More...
 
void AddVarying (VaryingRole role, const std::string &var)
 Capture the varying 'var' with the indicated role. More...
 
const std::vector< VaryingMetaData > & GetVaryings () const
 Get the list of captured varyings,. More...
 
size_t GetBytesPerVertex () const
 Returns the number of bytes per vertexs, accounting for all roles. More...
 
virtual void SetNumberOfVertices (size_t)
 The number of vertices expected to be captured. More...
 
void SetNumberOfVertices (int drawMode, size_t inputVerts)
 
virtual size_t GetNumberOfVertices ()
 
size_t GetBufferSize () const
 The size (in bytes) of the capture buffer. More...
 
void BindVaryings (vtkShaderProgram *prog)
 GL_SEPARATE_ATTRIBS is not supported yet. More...
 
vtkOpenGLBufferObjectGetBuffer (int index)
 Get the transform buffer object. More...
 
int GetBufferHandle (int index=0)
 Get the transform buffer object handle. More...
 
virtual void SetPrimitiveMode (int)
 The type of primitive to capture. More...
 
virtual int GetPrimitiveMode ()
 
void Allocate (int nbBuffers, size_t size, unsigned int hint)
 Generates and allocates the transform feedback buffers. More...
 
void BindBuffer (bool allocateOneBuffer=true)
 Binds the feedback buffer, then call glBeginTransformFeedback with the specified PrimitiveMode. More...
 
void ReadBuffer (int index=0)
 Calls glEndTransformFeedback(), flushes the OpenGL command stream, and reads the transform feedback buffer into BufferData. More...
 
virtual void * GetBufferData ()
 Get the transform buffer data as a void pointer. More...
 
void ReleaseGraphicsResources ()
 Release any graphics resources used by this object. More...
 
void ReleaseBufferData (bool freeBuffer=true)
 Release the memory used by the buffer data. 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 vtkTransformFeedbackNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkTransformFeedbackSafeDownCast (vtkObjectBase *o)
 
static size_t GetBytesPerVertex (VaryingRole role)
 Returns the number of data elements each vertex requires for a given role. More...
 
- 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
 
 vtkTransformFeedback ()
 
 ~vtkTransformFeedback () override
 
- 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 &)
 

Additional Inherited Members

- 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

Manages a TransformFeedback buffer.

OpenGL's TransformFeedback allows varying attributes from a vertex/geometry shader to be captured into a buffer for later processing. This is used in VTK to capture vertex information during GL2PS export when using the OpenGL2 backend as a replacement for the deprecated OpenGL feedback buffer.

Definition at line 40 of file vtkTransformFeedback.h.

Member Typedef Documentation

◆ Superclass

Definition at line 44 of file vtkTransformFeedback.h.

Member Enumeration Documentation

◆ VaryingRole

The role a captured varying fills.

Useful for parsing later.

Enumerator
Vertex_ClipCoordinate_F 
Color_RGBA_F 
Normal_F 
Next_Buffer 

Definition at line 50 of file vtkTransformFeedback.h.

Constructor & Destructor Documentation

◆ vtkTransformFeedback()

vtkTransformFeedback::vtkTransformFeedback ( )
protected

◆ ~vtkTransformFeedback()

vtkTransformFeedback::~vtkTransformFeedback ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkTransformFeedback* vtkTransformFeedback::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkTransformFeedback::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 vtkObjectBase.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkTransformFeedback::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkTransformFeedback* vtkTransformFeedback::NewInstance ( ) const

◆ PrintSelf()

void vtkTransformFeedback::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 vtkObject.

◆ ClearVaryings()

void vtkTransformFeedback::ClearVaryings ( )

Clear the list of varying attributes to capture.

◆ AddVarying()

void vtkTransformFeedback::AddVarying ( VaryingRole  role,
const std::string &  var 
)

Capture the varying 'var' with the indicated role.

◆ GetVaryings()

const std::vector<VaryingMetaData>& vtkTransformFeedback::GetVaryings ( ) const
inline

Get the list of captured varyings,.

Definition at line 79 of file vtkTransformFeedback.h.

◆ GetBytesPerVertex() [1/2]

size_t vtkTransformFeedback::GetBytesPerVertex ( vtkTransformFeedback::VaryingRole  role)
inlinestatic

Returns the number of data elements each vertex requires for a given role.

Definition at line 217 of file vtkTransformFeedback.h.

◆ GetBytesPerVertex() [2/2]

size_t vtkTransformFeedback::GetBytesPerVertex ( ) const

Returns the number of bytes per vertexs, accounting for all roles.

◆ SetNumberOfVertices() [1/2]

virtual void vtkTransformFeedback::SetNumberOfVertices ( size_t  )
virtual

The number of vertices expected to be captured.

If the drawMode setter is used, PrimitiveMode will also be set appropriately. For the single argument version set function, set the exact number of vertices expected to be emitted, accounting for primitive expansion (e.g. triangle strips -> triangle strips). The two argument setter is for convenience. Given the number of vertices used as input to a draw command and the draw mode, it will calculate the total number of vertices.

◆ SetNumberOfVertices() [2/2]

void vtkTransformFeedback::SetNumberOfVertices ( int  drawMode,
size_t  inputVerts 
)

◆ GetNumberOfVertices()

virtual size_t vtkTransformFeedback::GetNumberOfVertices ( )
virtual

◆ GetBufferSize()

size_t vtkTransformFeedback::GetBufferSize ( ) const

The size (in bytes) of the capture buffer.

Available after adding all Varyings and setting NumberOfVertices.

◆ BindVaryings()

void vtkTransformFeedback::BindVaryings ( vtkShaderProgram prog)

GL_SEPARATE_ATTRIBS is not supported yet.

The bufferMode argument to glTransformFeedbackVaryings. Must be GL_INTERLEAVED_ATTRIBS or GL_SEPARATE_ATTRIBS. Default is interleaved. Must be set prior to calling BindVaryings. vtkSetMacro(BufferMode, int) vtkGetMacro(BufferMode, int) Call glTransformFeedbackVaryings(). Must be called after the shaders are attached to prog, but before the program is linked.

◆ GetBuffer()

vtkOpenGLBufferObject* vtkTransformFeedback::GetBuffer ( int  index)

Get the transform buffer object.

Only valid after calling BindBuffer.

◆ GetBufferHandle()

int vtkTransformFeedback::GetBufferHandle ( int  index = 0)

Get the transform buffer object handle.

Only valid after calling BindBuffer.

◆ SetPrimitiveMode()

virtual void vtkTransformFeedback::SetPrimitiveMode ( int  )
virtual

The type of primitive to capture.

Must be one of GL_POINTS, GL_LINES, or GL_TRIANGLES. Default is GL_POINTS. Must be set prior to calling BindBuffer.

◆ GetPrimitiveMode()

virtual int vtkTransformFeedback::GetPrimitiveMode ( )
virtual

◆ Allocate()

void vtkTransformFeedback::Allocate ( int  nbBuffers,
size_t  size,
unsigned int  hint 
)

Generates and allocates the transform feedback buffers.

Must be called before BindBuffer. This releases old buffers. nbBuffers is the number of buffers to allocate. size if the size in byte to allocate per buffer. hint is the type of buffer (for example, GL_DYNAMIC_COPY)

◆ BindBuffer()

void vtkTransformFeedback::BindBuffer ( bool  allocateOneBuffer = true)

Binds the feedback buffer, then call glBeginTransformFeedback with the specified PrimitiveMode.

Must be called after BindVaryings and before any relevant glDraw commands. If allocateOneBuffer is true, allocates 1 buffer (used for retro compatibility).

◆ ReadBuffer()

void vtkTransformFeedback::ReadBuffer ( int  index = 0)

Calls glEndTransformFeedback(), flushes the OpenGL command stream, and reads the transform feedback buffer into BufferData.

Must be called after any relevant glDraw commands. If index is positive, data of specified buffer is copied to BufferData.

◆ GetBufferData()

virtual void* vtkTransformFeedback::GetBufferData ( )
virtual

Get the transform buffer data as a void pointer.

Only valid after calling ReadBuffer.

◆ ReleaseGraphicsResources()

void vtkTransformFeedback::ReleaseGraphicsResources ( )

Release any graphics resources used by this object.

◆ ReleaseBufferData()

void vtkTransformFeedback::ReleaseBufferData ( bool  freeBuffer = true)

Release the memory used by the buffer data.

If freeBuffer == true (default), the data is deleted. If false, the caller is responsible for deleting the BufferData with delete[].


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