Open CASCADE Technology  7.3.0
Public Member Functions | Protected Attributes
OpenGl_Window Class Reference

This class represents low-level wrapper over window with GL context. The window itself should be provided to constructor. More...

#include <OpenGl_Window.hxx>

Inheritance diagram for OpenGl_Window:
Inheritance graph
[legend]

Public Member Functions

 OpenGl_Window (const Handle< OpenGl_GraphicDriver > &theDriver, const Handle< Aspect_Window > &thePlatformWindow, Aspect_RenderingContext theGContext, const Handle< OpenGl_Caps > &theCaps, const Handle< OpenGl_Context > &theShareCtx)
 Main constructor - prepare GL context for specified window. More...
 
virtual ~OpenGl_Window ()
 Destructor. More...
 
virtual void Resize ()
 Resizes the window. More...
 
Handle< Aspect_WindowPlatformWindow ()
 
Standard_Integer Width () const
 
Standard_Integer Height () const
 
const Handle< OpenGl_Context > & GetGlContext () const
 
void Init ()
 Activates GL context and setup viewport. More...
 
virtual Standard_Boolean Activate ()
 Makes GL context for this window active in current thread. More...
 
void SetSwapInterval ()
 Sets swap interval for this window according to the context's settings. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Protected Attributes

Handle< OpenGl_ContextmyGlContext
 
Standard_Boolean myOwnGContext
 set to TRUE if GL context was not created by this class More...
 
Handle< Aspect_WindowmyPlatformWindow
 software platform window wrapper More...
 
Standard_Integer myWidth
 window width in pixels More...
 
Standard_Integer myHeight
 window height in pixels More...
 
Standard_Integer mySwapInterval
 last assigned swap interval (VSync) for this window More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Detailed Description

This class represents low-level wrapper over window with GL context. The window itself should be provided to constructor.

Constructor & Destructor Documentation

◆ OpenGl_Window()

OpenGl_Window::OpenGl_Window ( const Handle< OpenGl_GraphicDriver > &  theDriver,
const Handle< Aspect_Window > &  thePlatformWindow,
Aspect_RenderingContext  theGContext,
const Handle< OpenGl_Caps > &  theCaps,
const Handle< OpenGl_Context > &  theShareCtx 
)

Main constructor - prepare GL context for specified window.

◆ ~OpenGl_Window()

virtual OpenGl_Window::~OpenGl_Window ( )
virtual

Destructor.

Member Function Documentation

◆ Activate()

virtual Standard_Boolean OpenGl_Window::Activate ( )
virtual

Makes GL context for this window active in current thread.

◆ GetGlContext()

const Handle< OpenGl_Context >& OpenGl_Window::GetGlContext ( ) const
inline

◆ Height()

Standard_Integer OpenGl_Window::Height ( ) const
inline

◆ Init()

void OpenGl_Window::Init ( )

Activates GL context and setup viewport.

◆ PlatformWindow()

Handle< Aspect_Window > OpenGl_Window::PlatformWindow ( )
inline

◆ Resize()

virtual void OpenGl_Window::Resize ( )
virtual

Resizes the window.

◆ SetSwapInterval()

void OpenGl_Window::SetSwapInterval ( )

Sets swap interval for this window according to the context's settings.

◆ Width()

Standard_Integer OpenGl_Window::Width ( ) const
inline

Field Documentation

◆ myGlContext

Handle< OpenGl_Context > OpenGl_Window::myGlContext
protected

◆ myHeight

Standard_Integer OpenGl_Window::myHeight
protected

window height in pixels

◆ myOwnGContext

Standard_Boolean OpenGl_Window::myOwnGContext
protected

set to TRUE if GL context was not created by this class

◆ myPlatformWindow

Handle< Aspect_Window > OpenGl_Window::myPlatformWindow
protected

software platform window wrapper

◆ mySwapInterval

Standard_Integer OpenGl_Window::mySwapInterval
protected

last assigned swap interval (VSync) for this window

◆ myWidth

Standard_Integer OpenGl_Window::myWidth
protected

window width in pixels


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