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

Storage for FBO's. More...

#include <vtkRenderbuffer.h>

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

Public Types

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...
 
vtkRenderbufferNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual unsigned int GetHandle ()
 Get the name of the buffer for use opengl code. More...
 
void SetContext (vtkRenderWindow *win)
 Setting the context has the side affect of initializing OpenGL required extensions and allocates an OpenGL name(handle) that is released when the object is destroyed. More...
 
vtkRenderWindowGetContext ()
 
int CreateColorAttachment (unsigned int width, unsigned int height)
 Sets up an RGBAF renderbufffer for use as a color attachment. More...
 
int CreateDepthAttachment (unsigned int width, unsigned int height)
 Sets up an DEPTH renderbufffer for use as a color attachment. More...
 
int Create (unsigned int format, unsigned int width, unsigned int height)
 Sets up an renderbufffer. More...
 
int Create (unsigned int format, unsigned int width, unsigned int height, unsigned int samples)
 
void ReleaseGraphicsResources (vtkWindow *win)
 
void Resize (unsigned int width, unsigned int height)
 
virtual unsigned int GetWidth ()
 Get the buffer dimensions. More...
 
virtual unsigned int GetHeight ()
 
virtual unsigned int GetSamples ()
 
- 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 vtkRenderbufferNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRenderbufferSafeDownCast (vtkObjectBase *o)
 
static bool IsSupported (vtkRenderWindow *renWin)
 Returns if the context supports the required extensions. 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
 
 vtkRenderbuffer ()
 
 ~vtkRenderbuffer () override
 
bool LoadRequiredExtensions (vtkRenderWindow *renWin)
 
void Alloc ()
 
void Free ()
 
- 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

int DepthBufferFloat
 
unsigned int Width
 
unsigned int Height
 
unsigned int Format
 
unsigned int Samples
 
- 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

Storage for FBO's.

Lightweight API to OpenGL Framebuffer Object EXT renderbuffers.

Definition at line 32 of file vtkRenderbuffer.h.

Member Typedef Documentation

◆ Superclass

Definition at line 36 of file vtkRenderbuffer.h.

Constructor & Destructor Documentation

◆ vtkRenderbuffer()

vtkRenderbuffer::vtkRenderbuffer ( )
protected

◆ ~vtkRenderbuffer()

vtkRenderbuffer::~vtkRenderbuffer ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkRenderbuffer* vtkRenderbuffer::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkRenderbuffer::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 vtkRenderbuffer* vtkRenderbuffer::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkRenderbuffer::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkRenderbuffer* vtkRenderbuffer::NewInstance ( ) const

◆ PrintSelf()

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

◆ IsSupported()

static bool vtkRenderbuffer::IsSupported ( vtkRenderWindow renWin)
static

Returns if the context supports the required extensions.

Extension will be loaded when the context is set.

◆ GetHandle()

virtual unsigned int vtkRenderbuffer::GetHandle ( )
virtual

Get the name of the buffer for use opengl code.

◆ SetContext()

void vtkRenderbuffer::SetContext ( vtkRenderWindow win)

Setting the context has the side affect of initializing OpenGL required extensions and allocates an OpenGL name(handle) that is released when the object is destroyed.

NOTE: the reference count to the passed in object is not incremented. Contex must be set prior to other use.

◆ GetContext()

vtkRenderWindow* vtkRenderbuffer::GetContext ( )

◆ CreateColorAttachment()

int vtkRenderbuffer::CreateColorAttachment ( unsigned int  width,
unsigned int  height 
)

Sets up an RGBAF renderbufffer for use as a color attachment.

Use mode to control READ or DRAW operation.

◆ CreateDepthAttachment()

int vtkRenderbuffer::CreateDepthAttachment ( unsigned int  width,
unsigned int  height 
)

Sets up an DEPTH renderbufffer for use as a color attachment.

Use mode to control READ or DRAW operation.

◆ Create() [1/2]

int vtkRenderbuffer::Create ( unsigned int  format,
unsigned int  width,
unsigned int  height 
)

Sets up an renderbufffer.

Use mode to control READ or DRAW operation and format to control the internal format. (see OpenGL doc for more info)

◆ Create() [2/2]

int vtkRenderbuffer::Create ( unsigned int  format,
unsigned int  width,
unsigned int  height,
unsigned int  samples 
)

◆ ReleaseGraphicsResources()

void vtkRenderbuffer::ReleaseGraphicsResources ( vtkWindow win)

◆ Resize()

void vtkRenderbuffer::Resize ( unsigned int  width,
unsigned int  height 
)

◆ GetWidth()

virtual unsigned int vtkRenderbuffer::GetWidth ( )
virtual

Get the buffer dimensions.

These are the properties of the OpenGL renderbuffer this instance represents.

◆ GetHeight()

virtual unsigned int vtkRenderbuffer::GetHeight ( )
virtual

◆ GetSamples()

virtual unsigned int vtkRenderbuffer::GetSamples ( )
virtual

◆ LoadRequiredExtensions()

bool vtkRenderbuffer::LoadRequiredExtensions ( vtkRenderWindow renWin)
protected

◆ Alloc()

void vtkRenderbuffer::Alloc ( )
protected

◆ Free()

void vtkRenderbuffer::Free ( )
protected

Member Data Documentation

◆ DepthBufferFloat

int vtkRenderbuffer::DepthBufferFloat
protected

Definition at line 106 of file vtkRenderbuffer.h.

◆ Width

unsigned int vtkRenderbuffer::Width
protected

Definition at line 108 of file vtkRenderbuffer.h.

◆ Height

unsigned int vtkRenderbuffer::Height
protected

Definition at line 109 of file vtkRenderbuffer.h.

◆ Format

unsigned int vtkRenderbuffer::Format
protected

Definition at line 110 of file vtkRenderbuffer.h.

◆ Samples

unsigned int vtkRenderbuffer::Samples
protected

Definition at line 111 of file vtkRenderbuffer.h.


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