OpenFrames
Public Member Functions | Protected Attributes | List of all members
OpenFrames::EmbeddedGraphics Class Reference

The class of GraphicsWindow used for embedded graphics. More...

#include <WindowProxy.hpp>

Inheritance diagram for OpenFrames::EmbeddedGraphics:

Public Member Functions

 EmbeddedGraphics (int x, int y, int width, int height, WindowProxy *window)
 
virtual bool isSameKindAs (const Object *object) const
 
virtual const char * libraryName () const
 
virtual const char * className () const
 
virtual void setWindowName (const std::string &name)
 
virtual bool makeCurrentImplementation ()
 
virtual void swapBuffersImplementation ()
 
void setMakeCurrentFunction (void(*fcn)(unsigned int *winID, bool *success))
 
void setUpdateContextFunction (void(*fcn)(unsigned int *winID, bool *success))
 
bool updateContextImplementation ()
 
void setSwapBuffersFunction (void(*fcn)(unsigned int *winID))
 
virtual bool realizeImplementation ()
 
virtual bool isRealizedImplementation () const
 
virtual bool valid () const
 
virtual bool releaseContextImplementation ()
 
virtual void closeImplementation ()
 
virtual void grabFocus ()
 
virtual void grabFocusIfPointerInWindow ()
 
virtual void raiseWindow ()
 

Protected Attributes

void(* _makeCurrent )(unsigned int *winID, bool *success)
 
void(* _updateContext )(unsigned int *winID, bool *success)
 
void(* _swapBuffers )(unsigned int *winID)
 
WindowProxy_window
 
bool _realized
 

Detailed Description

The class of GraphicsWindow used for embedded graphics.

If a user provides their own OpenGL window, this is the GraphicsWindow that is used for embedded graphics.

Member Function Documentation

◆ makeCurrentImplementation()

virtual bool OpenFrames::EmbeddedGraphics::makeCurrentImplementation ( )
virtual

Inherited from GraphicsWindow, these functions manage the OpenGL context

◆ realizeImplementation()

virtual bool OpenFrames::EmbeddedGraphics::realizeImplementation ( )
virtual

Callback function for realizing a window (TBD as needed)

◆ setMakeCurrentFunction()

void OpenFrames::EmbeddedGraphics::setMakeCurrentFunction ( void(*)(unsigned int *winID, bool *success)  fcn)

Callback function for making the OpenGL context current (so it can be drawn on)

◆ setSwapBuffersFunction()

void OpenFrames::EmbeddedGraphics::setSwapBuffersFunction ( void(*)(unsigned int *winID)  fcn)

Callback function for swapping the front/back buffers

◆ setUpdateContextFunction()

void OpenFrames::EmbeddedGraphics::setUpdateContextFunction ( void(*)(unsigned int *winID, bool *success)  fcn)

Callback function for updating the OpenGL context after qualifying events (e.g. resize) This applies on OSX Cocoa, in which the context must be updated when the window is reshaped

◆ setWindowName()

virtual void OpenFrames::EmbeddedGraphics::setWindowName ( const std::string &  name)
inlinevirtual

Save a name to this GraphicsWindow's traits This is used by WindowProxy when creating a non-embedded window

◆ valid()

virtual bool OpenFrames::EmbeddedGraphics::valid ( ) const
inlinevirtual

Dummy implementations, assume that graphics context is always current and valid.

Member Data Documentation

◆ _makeCurrent

void(* OpenFrames::EmbeddedGraphics::_makeCurrent) (unsigned int *winID, bool *success)
protected

Context management callback functions.


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