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

provides information about rendering capabilities. More...

#include <vtkPVRenderingCapabilitiesInformation.h>

Inheritance diagram for vtkPVRenderingCapabilitiesInformation:
Inheritance graph
[legend]
Collaboration diagram for vtkPVRenderingCapabilitiesInformation:
Collaboration graph
[legend]

Public Types

enum  CapabilitiesMask {
  NONE = 0, ONSCREEN_RENDERING = 0x01, HEADLESS_RENDERING_USES_OSMESA = 0x04, HEADLESS_RENDERING_USES_EGL = 0x08,
  HEADLESS_RENDERING = HEADLESS_RENDERING_USES_OSMESA | HEADLESS_RENDERING_USES_EGL, RENDERING = ONSCREEN_RENDERING | HEADLESS_RENDERING, OPENGL = 0x10
}
 
typedef vtkPVInformation Superclass
 
- Public Types inherited from vtkPVInformation
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual vtkTypeUInt32 GetCapabilities ()
 Returns a 32-bit unsigned integer which represents the capabilities. More...
 
bool Supports (vtkTypeUInt32 capability)
 Convenience method to check is any of the requested capabilities are supported. More...
 
void CopyFromObject (vtkObject *) override
 Transfer information about a single object into this object. More...
 
void AddInformation (vtkPVInformation *) override
 Merge another information object. More...
 
void CopyToStream (vtkClientServerStream *) override
 Manage a serialized version of the information. More...
 
void CopyFromStream (const vtkClientServerStream *) override
 Manage a serialized version of the information. More...
 
- Public Member Functions inherited from vtkPVInformation
virtual void CopyParametersToStream (vtkMultiProcessStream &)
 Serialize/Deserialize the parameters that control how/what information is gathered. More...
 
virtual void CopyParametersFromStream (vtkMultiProcessStream &)
 Serialize/Deserialize the parameters that control how/what information is gathered. More...
 
virtual int GetRootOnly ()
 Set/get whether to gather information only from the root. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
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 *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
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 *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkPVRenderingCapabilitiesInformationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVRenderingCapabilitiesInformationSafeDownCast (vtkObject *o)
 
static bool Supports (vtkTypeUInt32 capabilities, vtkTypeUInt32 mask)
 
static vtkTypeUInt32 GetLocalCapabilities ()
 Return local process' capabilities. More...
 
static vtkSmartPointer< vtkRenderWindowNewOffscreenRenderWindow ()
 This creates an off-screen render window based on capabilities of the local process. More...
 
- Static Public Member Functions inherited from vtkPVInformation
static int IsTypeOf (const char *type)
 
static vtkPVInformationSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkPVRenderingCapabilitiesInformation ()
 
 ~vtkPVRenderingCapabilitiesInformation () override
 
- Protected Member Functions inherited from vtkPVInformation
 vtkPVInformation ()
 
 ~vtkPVInformation () override
 
virtual void SetRootOnly (int)
 
 vtkPVInformation (const vtkPVInformation &)=delete
 
void operator= (const vtkPVInformation &)=delete
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
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

vtkTypeUInt32 Capabilities
 
- Protected Attributes inherited from vtkPVInformation
int RootOnly
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

provides information about rendering capabilities.

Definition at line 31 of file vtkPVRenderingCapabilitiesInformation.h.

Member Typedef Documentation

◆ Superclass

Definition at line 35 of file vtkPVRenderingCapabilitiesInformation.h.

Member Enumeration Documentation

◆ CapabilitiesMask

Enumerator
NONE 
ONSCREEN_RENDERING 

Indicates if onscreen rendering is possible.

HEADLESS_RENDERING_USES_OSMESA 

Indicates if headless rendering using OSMesa is possible.

HEADLESS_RENDERING_USES_EGL 

Indicates if headless rendering using EGL is possible.

HEADLESS_RENDERING 

Indicates if any headless rendering is possible.

RENDERING 

Indicates if any rendering is possible.

OPENGL 

If rendering is possible, this indicates that that OpenGL version is adequate for basic rendering requirements.

This flag can only be set if RENDERING is set too.

Definition at line 38 of file vtkPVRenderingCapabilitiesInformation.h.

Constructor & Destructor Documentation

◆ vtkPVRenderingCapabilitiesInformation()

vtkPVRenderingCapabilitiesInformation::vtkPVRenderingCapabilitiesInformation ( )
protected

◆ ~vtkPVRenderingCapabilitiesInformation()

vtkPVRenderingCapabilitiesInformation::~vtkPVRenderingCapabilitiesInformation ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkPVRenderingCapabilitiesInformation* vtkPVRenderingCapabilitiesInformation::New ( )
static

◆ GetClassName()

virtual const char* vtkPVRenderingCapabilitiesInformation::GetClassName ( )
virtual

Reimplemented from vtkPVInformation.

◆ IsTypeOf()

static int vtkPVRenderingCapabilitiesInformation::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkPVRenderingCapabilitiesInformation::IsA ( const char *  type)
virtual

Reimplemented from vtkPVInformation.

◆ SafeDownCast()

static vtkPVRenderingCapabilitiesInformation* vtkPVRenderingCapabilitiesInformation::SafeDownCast ( vtkObject o)
static

◆ PrintSelf()

void vtkPVRenderingCapabilitiesInformation::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkPVInformation.

◆ GetCapabilities()

virtual vtkTypeUInt32 vtkPVRenderingCapabilitiesInformation::GetCapabilities ( )
virtual

Returns a 32-bit unsigned integer which represents the capabilities.

Use CapabilitiesMask to determine which capabilities are supported by all the processes from which the information was gathered.

◆ Supports() [1/2]

bool vtkPVRenderingCapabilitiesInformation::Supports ( vtkTypeUInt32  capability)
inline

Convenience method to check is any of the requested capabilities are supported.

Definition at line 85 of file vtkPVRenderingCapabilitiesInformation.h.

◆ Supports() [2/2]

static bool vtkPVRenderingCapabilitiesInformation::Supports ( vtkTypeUInt32  capabilities,
vtkTypeUInt32  mask 
)
inlinestatic

Definition at line 87 of file vtkPVRenderingCapabilitiesInformation.h.

◆ GetLocalCapabilities()

static vtkTypeUInt32 vtkPVRenderingCapabilitiesInformation::GetLocalCapabilities ( )
static

Return local process' capabilities.

◆ NewOffscreenRenderWindow()

static vtkSmartPointer<vtkRenderWindow> vtkPVRenderingCapabilitiesInformation::NewOffscreenRenderWindow ( )
static

This creates an off-screen render window based on capabilities of the local process.

This is useful to query additional OpenGL information, for example.

This may create a non-mapped onscreen render window, if ParaView was built with onscreen GL support) or headless off-screen render window, if ParaView was built with headless GL support (e.g. EGL or OSMesa). Headless is preferred, if available.

Note the returned window hasn't been created yet, i.e. one may need to call vtkRenderWindow::Render() on it before querying OpenGL information, for example.

◆ CopyFromObject()

void vtkPVRenderingCapabilitiesInformation::CopyFromObject ( vtkObject )
overridevirtual

Transfer information about a single object into this object.

Reimplemented from vtkPVInformation.

◆ AddInformation()

void vtkPVRenderingCapabilitiesInformation::AddInformation ( vtkPVInformation )
overridevirtual

Merge another information object.

Reimplemented from vtkPVInformation.

◆ CopyToStream()

void vtkPVRenderingCapabilitiesInformation::CopyToStream ( vtkClientServerStream )
overridevirtual

Manage a serialized version of the information.

Implements vtkPVInformation.

◆ CopyFromStream()

void vtkPVRenderingCapabilitiesInformation::CopyFromStream ( const vtkClientServerStream )
overridevirtual

Manage a serialized version of the information.

Reimplemented from vtkPVInformation.

Member Data Documentation

◆ Capabilities

vtkTypeUInt32 vtkPVRenderingCapabilitiesInformation::Capabilities
protected

Definition at line 123 of file vtkPVRenderingCapabilitiesInformation.h.


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