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 occ::handle< OpenGl_GraphicDriver > &theDriver, const occ::handle< Aspect_Window > &thePlatformWindow, const occ::handle< Aspect_Window > &theSizeWindow, Aspect_RenderingContext theGContext, const occ::handle< OpenGl_Caps > &theCaps, const occ::handle< OpenGl_Context > &theShareCtx)
	Initialize the new window - prepare GL context for specified window. Throws exception in case of failure.

	~OpenGl_Window () override
	Destructor.

virtual void	Resize ()
	Resizes the window.

const occ::handle< Aspect_Window > &	PlatformWindow ()
	Return platform window.

const occ::handle< Aspect_Window > &	SizeWindow ()
	Return window object defining dimensions.

int	Width () const

int	Height () const

const occ::handle< OpenGl_Context > &	GetGlContext () const
	Return OpenGL context.

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

void	SetSwapInterval (bool 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 ()=default
	Destructor must be virtual.

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

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

bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.

bool	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.

bool	IsKind (const char *const 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.

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

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.

int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.

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

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

Protected Attributes
occ::handle< OpenGl_Context >	myGlContext

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

occ::handle< Aspect_Window >	myPlatformWindow
	software platform window wrapper

occ::handle< Aspect_Window >	mySizeWindow
	window object defining dimensions

NCollection_Vec2< int >	mySize
	window width x height in pixels

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

OpenGl_Window::~OpenGl_Window ( )

override

Destructor.

Member Function Documentation

◆ Activate()

virtual bool OpenGl_Window::Activate ( )

virtual

Makes GL context for this window active in current thread.

◆ GetGlContext()

const occ::handle< OpenGl_Context > & OpenGl_Window::GetGlContext ( ) const

inline

Return OpenGL context.

◆ Height()

int OpenGl_Window::Height ( ) const

inline

◆ init()

void OpenGl_Window::init ( )

protected

Activates GL context and setup viewport.

◆ Init()

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

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

◆ PlatformWindow()

const occ::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 ( bool theToForceNoSync )

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

◆ SizeWindow()

const occ::handle< Aspect_Window > & OpenGl_Window::SizeWindow ( )

inline

Return window object defining dimensions.

◆ Width()

int OpenGl_Window::Width ( ) const

inline

Field Documentation

◆ myGlContext

occ::handle<OpenGl_Context> OpenGl_Window::myGlContext

protected

◆ myOwnGContext

bool OpenGl_Window::myOwnGContext

protected

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

◆ myPlatformWindow

occ::handle<Aspect_Window> OpenGl_Window::myPlatformWindow

protected

software platform window wrapper

◆ mySize

NCollection_Vec2<int> OpenGl_Window::mySize

protected

window width x height in pixels

◆ mySizeWindow

occ::handle<Aspect_Window> OpenGl_Window::mySizeWindow

protected

window object defining dimensions

◆ mySwapInterval

int 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