vtkOSOpenGLRenderWindow Class Reference
#include <vtkOSOpenGLRenderWindow.h>
Detailed Description
OffScreen Mesa rendering window.vtkOSOpenGLRenderWindow is a concrete implementation of the abstract class vtkOpenGLRenderWindow. vtkOSOpenGLRenderWindow interfaces to the OffScreen Mesa software implementation of the OpenGL library. The framebuffer resides on host memory. The framebuffer is the collection of logical buffers (color buffer(s), depth buffer, stencil buffer, accumulation buffer, multisample buffer) defining where the output of GL rendering is directed. Application programmers should normally use vtkRenderWindow instead of the OpenGL specific version.
Definition at line 39 of file vtkOSOpenGLRenderWindow.h.
Public Types | |
| typedef vtkOpenGLRenderWindow | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual void | Start (void) |
| virtual void | Frame (void) |
| virtual void | WindowInitialize (void) |
| virtual void | Initialize (void) |
| virtual void | Finalize (void) |
| virtual void | SetFullScreen (int) |
| virtual int * | GetScreenSize () |
| virtual int * | GetPosition () |
| virtual void | SetStereoCapableWindow (int capable) |
| void | MakeCurrent () |
| virtual bool | IsCurrent () |
| void | SetForceMakeCurrent () |
| const char * | ReportCapabilities () |
| int | SupportsOpenGL () |
| int | IsDirect () |
| virtual void | WindowRemap (void) |
| void | SetDisplayId (void *) |
| void | SetParentId (void *) |
| void | SetWindowId (void *) |
| void | SetNextWindowId (void *) |
| void | SetWindowName (const char *) |
| virtual void | SetCurrentCursor (int) |
| virtual int | GetEventPending () |
| void | SetWindowInfo (char *info) |
| void | SetNextWindowInfo (char *info) |
| void | SetParentInfo (char *info) |
| void | SetOffScreenRendering (int i) |
| virtual void | SetSize (int x, int y) |
| virtual void | SetSize (int a[2]) |
| void | SetPosition (int x, int y) |
| void | SetPosition (int a[2]) |
| virtual void * | GetGenericDisplayId () |
| virtual void * | GetGenericWindowId () |
| virtual void * | GetGenericParentId () |
| virtual void * | GetGenericContext () |
| virtual void * | GetGenericDrawable () |
| void | HideCursor () |
| void | ShowCursor () |
Static Public Member Functions | |
| static vtkOSOpenGLRenderWindow * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkOSOpenGLRenderWindow * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkOSOpenGLRenderWindow () | |
| ~vtkOSOpenGLRenderWindow () | |
| void | CreateAWindow () |
| void | DestroyWindow () |
| void | CreateOffScreenWindow (int width, int height) |
| void | DestroyOffScreenWindow () |
| void | ResizeOffScreenWindow (int width, int height) |
Protected Attributes | |
| vtkOSOpenGLRenderWindowInternal * | Internal |
| int | OwnWindow |
| int | OwnDisplay |
| int | ScreenSize [2] |
| int | CursorHidden |
| int | ForceMakeCurrent |
| char * | Capabilities |
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkOSOpenGLRenderWindow::vtkOSOpenGLRenderWindow | ( | ) | [protected] |
| vtkOSOpenGLRenderWindow::~vtkOSOpenGLRenderWindow | ( | ) | [protected] |
Member Function Documentation
| static vtkOSOpenGLRenderWindow* vtkOSOpenGLRenderWindow::New | ( | ) | [static] |
Construct an instance of vtkRenderWindow with its screen size set to 300x300, borders turned on, positioned at (0,0), double buffering turned on.
Reimplemented from vtkRenderWindow.
| virtual const char* vtkOSOpenGLRenderWindow::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkOpenGLRenderWindow.
| static int vtkOSOpenGLRenderWindow::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkOpenGLRenderWindow.
| virtual int vtkOSOpenGLRenderWindow::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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkOpenGLRenderWindow.
| static vtkOSOpenGLRenderWindow* vtkOSOpenGLRenderWindow::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkOpenGLRenderWindow.
| void vtkOSOpenGLRenderWindow::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
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 vtkOpenGLRenderWindow.
| virtual void vtkOSOpenGLRenderWindow::Start | ( | void | ) | [virtual] |
Begin the rendering process.
Implements vtkRenderWindow.
| virtual void vtkOSOpenGLRenderWindow::Frame | ( | void | ) | [virtual] |
End the rendering process and display the image.
Implements vtkRenderWindow.
| virtual void vtkOSOpenGLRenderWindow::WindowInitialize | ( | void | ) | [virtual] |
Initialize the window for rendering.
| virtual void vtkOSOpenGLRenderWindow::Initialize | ( | void | ) | [virtual] |
Initialize the rendering window. This will setup all system-specific resources. This method and Finalize() must be symmetric and it should be possible to call them multiple times, even changing WindowId in-between. This is what WindowRemap does.
| virtual void vtkOSOpenGLRenderWindow::Finalize | ( | void | ) | [virtual] |
"Deinitialize" the rendering window. This will shutdown all system-specific resources. After having called this, it should be possible to destroy a window that was used for a SetWindowId() call without any ill effects.
Implements vtkRenderWindow.
| virtual void vtkOSOpenGLRenderWindow::SetFullScreen | ( | int | ) | [virtual] |
Change the window to fill the entire screen.
Implements vtkRenderWindow.
| virtual void vtkOSOpenGLRenderWindow::SetSize | ( | int | x, | |
| int | y | |||
| ) | [virtual] |
Specify the size of the rendering window in pixels.
Reimplemented from vtkWindow.
| virtual void vtkOSOpenGLRenderWindow::SetSize | ( | int | a[2] | ) | [inline, virtual] |
Specify the size of the rendering window in pixels.
Reimplemented from vtkWindow.
Definition at line 73 of file vtkOSOpenGLRenderWindow.h.
| virtual int* vtkOSOpenGLRenderWindow::GetScreenSize | ( | ) | [virtual] |
Get the current size of the screen in pixels.
Implements vtkWindow.
| virtual int* vtkOSOpenGLRenderWindow::GetPosition | ( | ) | [virtual] |
Get the position in screen coordinates (pixels) of the window.
Reimplemented from vtkWindow.
| void vtkOSOpenGLRenderWindow::SetPosition | ( | int | x, | |
| int | y | |||
| ) | [virtual] |
Move the window to a new position on the display.
Reimplemented from vtkWindow.
| void vtkOSOpenGLRenderWindow::SetPosition | ( | int | a[2] | ) | [inline, virtual] |
Move the window to a new position on the display.
Reimplemented from vtkWindow.
Definition at line 85 of file vtkOSOpenGLRenderWindow.h.
| virtual void vtkOSOpenGLRenderWindow::SetStereoCapableWindow | ( | int | capable | ) | [virtual] |
Prescribe that the window be created in a stereo-capable mode. This method must be called before the window is realized. This method overrides the superclass method since this class can actually check whether the window has been realized yet.
Reimplemented from vtkRenderWindow.
| void vtkOSOpenGLRenderWindow::MakeCurrent | ( | ) | [virtual] |
Make this window the current OpenGL context.
Implements vtkOpenGLRenderWindow.
| virtual bool vtkOSOpenGLRenderWindow::IsCurrent | ( | ) | [virtual] |
Tells if this window is the current OpenGL context for the calling thread.
Implements vtkOpenGLRenderWindow.
| void vtkOSOpenGLRenderWindow::SetForceMakeCurrent | ( | ) | [virtual] |
If called, allow MakeCurrent() to skip cache-check when called. MakeCurrent() reverts to original behavior of cache-checking on the next render.
Reimplemented from vtkRenderWindow.
| const char* vtkOSOpenGLRenderWindow::ReportCapabilities | ( | ) | [virtual] |
Get report of capabilities for the render window
Reimplemented from vtkRenderWindow.
| int vtkOSOpenGLRenderWindow::SupportsOpenGL | ( | ) | [virtual] |
Does this render window support OpenGL? 0-false, 1-true
Reimplemented from vtkRenderWindow.
| int vtkOSOpenGLRenderWindow::IsDirect | ( | ) | [virtual] |
Is this render window using hardware acceleration? 0-false, 1-true
Reimplemented from vtkRenderWindow.
| virtual void vtkOSOpenGLRenderWindow::WindowRemap | ( | void | ) | [virtual] |
Resize the window.
Implements vtkRenderWindow.
| virtual void* vtkOSOpenGLRenderWindow::GetGenericDisplayId | ( | ) | [inline, virtual] |
Xwindow get set functions
Implements vtkRenderWindow.
Definition at line 120 of file vtkOSOpenGLRenderWindow.h.
| virtual void* vtkOSOpenGLRenderWindow::GetGenericWindowId | ( | ) | [virtual] |
Xwindow get set functions
Implements vtkRenderWindow.
| virtual void* vtkOSOpenGLRenderWindow::GetGenericParentId | ( | ) | [inline, virtual] |
Xwindow get set functions
Implements vtkRenderWindow.
Definition at line 122 of file vtkOSOpenGLRenderWindow.h.
| virtual void* vtkOSOpenGLRenderWindow::GetGenericContext | ( | ) | [virtual] |
Xwindow get set functions
Implements vtkRenderWindow.
| virtual void* vtkOSOpenGLRenderWindow::GetGenericDrawable | ( | ) | [inline, virtual] |
Xwindow get set functions
Implements vtkRenderWindow.
Definition at line 124 of file vtkOSOpenGLRenderWindow.h.
| void vtkOSOpenGLRenderWindow::SetDisplayId | ( | void * | ) | [inline, virtual] |
Set the X display id for this RenderWindow to use to a pre-existing X display id.
Implements vtkRenderWindow.
Definition at line 129 of file vtkOSOpenGLRenderWindow.h.
| void vtkOSOpenGLRenderWindow::SetParentId | ( | void * | ) | [virtual] |
Sets the parent of the window that WILL BE created.
Implements vtkRenderWindow.
| void vtkOSOpenGLRenderWindow::SetWindowId | ( | void * | ) | [virtual] |
Set this RenderWindow's X window id to a pre-existing window.
Implements vtkRenderWindow.
| void vtkOSOpenGLRenderWindow::SetNextWindowId | ( | void * | ) | [virtual] |
Set the window id of the new window once a WindowRemap is done. This is the generic prototype as required by the vtkRenderWindow parent.
Implements vtkRenderWindow.
| void vtkOSOpenGLRenderWindow::SetWindowName | ( | const char * | ) | [virtual] |
Get name of rendering window
Reimplemented from vtkWindow.
| void vtkOSOpenGLRenderWindow::HideCursor | ( | ) | [inline, virtual] |
Hide or Show the mouse cursor, it is nice to be able to hide the default cursor if you want VTK to display a 3D cursor instead.
Implements vtkRenderWindow.
Definition at line 146 of file vtkOSOpenGLRenderWindow.h.
| void vtkOSOpenGLRenderWindow::ShowCursor | ( | ) | [inline, virtual] |
Hide or Show the mouse cursor, it is nice to be able to hide the default cursor if you want VTK to display a 3D cursor instead.
Implements vtkRenderWindow.
Definition at line 147 of file vtkOSOpenGLRenderWindow.h.
| virtual void vtkOSOpenGLRenderWindow::SetCurrentCursor | ( | int | ) | [virtual] |
Change the shape of the cursor
Reimplemented from vtkRenderWindow.
| virtual int vtkOSOpenGLRenderWindow::GetEventPending | ( | ) | [virtual] |
Check to see if a mouse button has been pressed. All other events are ignored by this method. This is a useful check to abort a long render.
Implements vtkRenderWindow.
| void vtkOSOpenGLRenderWindow::SetWindowInfo | ( | char * | info | ) | [virtual] |
Set this RenderWindow's X window id to a pre-existing window.
Implements vtkRenderWindow.
| void vtkOSOpenGLRenderWindow::SetNextWindowInfo | ( | char * | info | ) | [virtual] |
Set the window info that will be used after WindowRemap()
Implements vtkRenderWindow.
| void vtkOSOpenGLRenderWindow::SetParentInfo | ( | char * | info | ) | [virtual] |
Sets the X window id of the window that WILL BE created.
Implements vtkRenderWindow.
| void vtkOSOpenGLRenderWindow::SetOffScreenRendering | ( | int | i | ) | [virtual] |
Render without displaying the window.
Reimplemented from vtkWindow.
| void vtkOSOpenGLRenderWindow::CreateAWindow | ( | ) | [protected, virtual] |
Create a not-off-screen window.
Implements vtkOpenGLRenderWindow.
| void vtkOSOpenGLRenderWindow::DestroyWindow | ( | ) | [protected, virtual] |
Destroy a not-off-screen window.
Implements vtkOpenGLRenderWindow.
| void vtkOSOpenGLRenderWindow::CreateOffScreenWindow | ( | int | width, | |
| int | height | |||
| ) | [protected] |
| void vtkOSOpenGLRenderWindow::DestroyOffScreenWindow | ( | ) | [protected] |
| void vtkOSOpenGLRenderWindow::ResizeOffScreenWindow | ( | int | width, | |
| int | height | |||
| ) | [protected] |
Member Data Documentation
vtkOSOpenGLRenderWindowInternal* vtkOSOpenGLRenderWindow::Internal [protected] |
Definition at line 174 of file vtkOSOpenGLRenderWindow.h.
int vtkOSOpenGLRenderWindow::OwnWindow [protected] |
Definition at line 176 of file vtkOSOpenGLRenderWindow.h.
int vtkOSOpenGLRenderWindow::OwnDisplay [protected] |
Definition at line 177 of file vtkOSOpenGLRenderWindow.h.
int vtkOSOpenGLRenderWindow::ScreenSize[2] [protected] |
Definition at line 178 of file vtkOSOpenGLRenderWindow.h.
int vtkOSOpenGLRenderWindow::CursorHidden [protected] |
Definition at line 179 of file vtkOSOpenGLRenderWindow.h.
int vtkOSOpenGLRenderWindow::ForceMakeCurrent [protected] |
Definition at line 180 of file vtkOSOpenGLRenderWindow.h.
char* vtkOSOpenGLRenderWindow::Capabilities [protected] |
Definition at line 181 of file vtkOSOpenGLRenderWindow.h.
The documentation for this class was generated from the following file:
- dox/Rendering/vtkOSOpenGLRenderWindow.h
