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:

[legend]

Public Member Functions
	OpenGl_Window ()
	Empty constructor.

void	Init (const Handle< OpenGl_GraphicDriver > &theDriver, const Handle< Aspect_Window > &thePlatformWindow, const Handle< Aspect_Window > &theSizeWindow, Aspect_RenderingContext theGContext, const Handle< OpenGl_Caps > &theCaps, const Handle< OpenGl_Context > &theShareCtx)
	Initialize the new window - prepare GL context for specified window. Throws exception in case of failure.

virtual	~OpenGl_Window ()
	Destructor.

virtual void	Resize ()
	Resizes the window.

const Handle< Aspect_Window > &	PlatformWindow ()
	Return platform window.

const Handle< Aspect_Window > &	SizeWindow ()
	Return window object defining dimensions.

Standard_Integer	Width () const

Standard_Integer	Height () const

const Handle< OpenGl_Context > &	GetGlContext () const
	Return OpenGL context.

virtual Standard_Boolean	Activate ()
	Makes GL context for this window active in current thread.

void	SetSwapInterval (Standard_Boolean theToForceNoSync)
	Sets swap interval for this window according to the context's settings.

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

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.

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.

Standard_Transient *	This () 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.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Member Functions
void	init ()
	Activates GL context and setup viewport.

Protected Attributes
Handle< OpenGl_Context >	myGlContext

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

Handle< Aspect_Window >	myPlatformWindow
	software platform window wrapper

Handle< Aspect_Window >	mySizeWindow
	window object defining dimensions

Graphic3d_Vec2i	mySize
	window width x height in pixels

Standard_Integer	mySwapInterval
	last assigned swap interval (VSync) for this window

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

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 ( )

Empty constructor.

◆ ~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

Return OpenGL context.

◆ Height()

Standard_Integer OpenGl_Window::Height ( ) const

inline

◆ Init()

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

Initialize the new window - prepare GL context for specified window. Throws exception in case of failure.

◆ init()

void OpenGl_Window::init ( )

protected

Activates GL context and setup viewport.

◆ PlatformWindow()

const Handle< Aspect_Window > & OpenGl_Window::PlatformWindow ( )

inline

Return platform window.

◆ Resize()

virtual void OpenGl_Window::Resize ( )

virtual

Resizes the window.

◆ SetSwapInterval()

void OpenGl_Window::SetSwapInterval ( Standard_Boolean theToForceNoSync )

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

◆ SizeWindow()

const Handle< Aspect_Window > & OpenGl_Window::SizeWindow ( )

inline

Return window object defining dimensions.

◆ Width()

Standard_Integer OpenGl_Window::Width ( ) const

inline

Field Documentation

◆ myGlContext

Handle< OpenGl_Context > OpenGl_Window::myGlContext

protected

◆ 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

◆ mySize

Graphic3d_Vec2i OpenGl_Window::mySize

protected

window width x height in pixels

◆ mySizeWindow

Handle< Aspect_Window > OpenGl_Window::mySizeWindow

protected

window object defining dimensions

◆ mySwapInterval

Standard_Integer OpenGl_Window::mySwapInterval

protected

last assigned swap interval (VSync) for this window

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

OpenGl_Window.hxx

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OpenGl_Window()

◆ ~OpenGl_Window()

Member Function Documentation

◆ Activate()

◆ GetGlContext()

◆ Height()

◆ Init()

◆ init()

◆ PlatformWindow()

◆ Resize()

◆ SetSwapInterval()

◆ SizeWindow()

◆ Width()

Field Documentation

◆ myGlContext

◆ myOwnGContext

◆ myPlatformWindow

◆ mySize

◆ mySizeWindow

◆ mySwapInterval