OpenGLContext Class Reference

#include <OpenGLContext.hxx>

Inheritance diagram for OpenGLContext:

Collaboration diagram for OpenGLContext:

Public Member Functions
virtual	~OpenGLContext ()
void	acquire ()
void	release ()
void	dispose ()
void	requestLegacyContext ()
bool	init (vcl::Window *pParent)
void	reset ()
void	BindFramebuffer (OpenGLFramebuffer *pFramebuffer)
void	AcquireDefaultFramebuffer ()
OpenGLFramebuffer *	AcquireFramebuffer (const OpenGLTexture &rTexture)
void	UnbindTextureFromFramebuffers (GLuint nTexture)
void	ReleaseFramebuffer (const OpenGLTexture &rTexture)
void	ReleaseFramebuffers ()
OpenGLProgram *	GetProgram (const OUString &rVertexShader, const OUString &rFragmentShader, const OString &preamble="")
OpenGLProgram *	UseProgram (const OUString &rVertexShader, const OUString &rFragmentShader, const OString &preamble="")
RenderState &	state ()
OpenGLCapabilitySwitch &	getOpenGLCapabilitySwitch ()
virtual bool	isCurrent ()
	Is this GL context the current context ? More...
virtual bool	isAnyCurrent ()
	Is any GL context the current context ? More...
virtual void	makeCurrent ()
	make this GL context current - so it is implicit in subsequent GL calls More...
void	registerAsCurrent ()
	Put this GL context to the end of the context list. More...
virtual void	resetCurrent ()
	reset the GL context so this context is not implicit in subsequent GL calls. More...
virtual void	restoreDefaultFramebuffer ()
	unbind the GL_FRAMEBUFFER to its default state, needed for gtk3 More...
virtual void	swapBuffers ()
virtual void	sync ()
void	show ()
void	setWinPosAndSize (const Point &rPos, const Size &rSize)
virtual const GLWindow &	getOpenGLWindow () const =0
SystemChildWindow *	getChildWindow ()
const SystemChildWindow *	getChildWindow () const
bool	isInitialized () const
void	setVCLOnly ()
	VCL promiscuously re-uses its own contexts: More...
bool	isVCLOnly () const
virtual SystemWindowData	generateWinData (vcl::Window *pParent, bool bRequestLegacyContext)

Static Public Member Functions
static rtl::Reference< OpenGLContext >	Create ()
static void	ReleaseFramebuffer (OpenGLFramebuffer *pFramebuffer)
static bool	IsTextureAttachedAnywhere (GLuint nTexture)
	Method for debugging; check texture is not already attached. More...
static void	clearCurrent ()
	release bound resources from the current context More...
static void	prepareForYield ()
	release contexts etc. before (potentially) allowing another thread run. More...
static bool	hasCurrent ()
	Is there a current GL context ? More...
static void	makeVCLCurrent ()
	make a VCL context (any context) current, create it if necessary. More...
static rtl::Reference< OpenGLContext >	getVCLContext (bool bMakeIfNecessary=true)
	fetch any VCL context, creating one if bMakeIfNecessary is set. More...

Public Attributes
vcl::Region	maClipRegion
OpenGLContext *	mpPrevContext
OpenGLContext *	mpNextContext

Protected Member Functions
	OpenGLContext ()
bool	InitGL ()
virtual GLWindow &	getModifiableOpenGLWindow ()=0
virtual bool	ImplInit ()

Static Protected Member Functions
static void	InitGLDebugging ()
static void	InitChildWindow (SystemChildWindow *pChildWindow)
static void	BuffersSwapped ()

Protected Attributes
VclPtr< vcl::Window >	m_xWindow
VclPtr< vcl::Window >	mpWindow
VclPtr< SystemChildWindow >	m_pChildWindow
bool	mbInitialized
int	mnRefCount
bool	mbRequestLegacyContext
bool	mbVCLOnly
int	mnFramebufferCount
OpenGLFramebuffer *	mpCurrentFramebuffer
OpenGLFramebuffer *	mpFirstFramebuffer
OpenGLFramebuffer *	mpLastFramebuffer
OpenGLCapabilitySwitch	maOpenGLCapabilitySwitch

Private Types
typedef std::unordered_map< OString, std::shared_ptr< OpenGLProgram > >	ProgramCollection

Private Member Functions
virtual void	initWindow ()
virtual void	destroyCurrentContext ()
virtual void	adjustToNewSize ()

Private Attributes
ProgramCollection	maPrograms
OpenGLProgram *	mpCurrentProgram
std::unique_ptr< RenderState >	mpRenderState

Friends
class	OpenGLTests

Detailed Description

Definition at line 55 of file OpenGLContext.hxx.

Member Typedef Documentation

typedef std::unordered_map< OString, std::shared_ptr<OpenGLProgram> > OpenGLContext::ProgramCollection

private

Definition at line 172 of file OpenGLContext.hxx.

Constructor & Destructor Documentation

OpenGLContext::OpenGLContext ( )

protected

Definition at line 49 of file OpenGLContext.cxx.

References ImplGetSVData(), ImplSVData::maGDIData, mbInitialized, ImplSVGDIData::mpLastContext, mpNextContext, mpPrevContext, mpWindow, and VCL_GL_INFO.

OpenGLContext::~OpenGLContext ( )

virtual

Definition at line 79 of file OpenGLContext.cxx.

References assert(), VclPtr< reference_type >::disposeAndClear(), ImplGetSVData(), m_pChildWindow, ImplSVData::maGDIData, mnRefCount, ImplSVGDIData::mpLastContext, mpNextContext, mpPrevContext, reset(), and VCL_GL_INFO.

Member Function Documentation

void OpenGLContext::acquire ( )

inline

Definition at line 63 of file OpenGLContext.hxx.

void OpenGLContext::AcquireDefaultFramebuffer

(

)

Definition at line 601 of file OpenGLContext.cxx.

References BindFramebuffer().

OpenGLFramebuffer * OpenGLContext::AcquireFramebuffer

(

const OpenGLTexture &

rTexture

)

Definition at line 606 of file OpenGLContext.cxx.

References assert(), OpenGLFramebuffer::AttachTexture(), BindFramebuffer(), OpenGLFramebuffer::GetHeight(), OpenGLTexture::GetHeight(), OpenGLFramebuffer::GetWidth(), OpenGLTexture::GetWidth(), OpenGLFramebuffer::IsAttached(), OpenGLFramebuffer::IsFree(), MAX_FRAMEBUFFER_COUNT, mnFramebufferCount, mpFirstFramebuffer, mpLastFramebuffer, OpenGLFramebuffer::mpPrevFramebuffer, Point, state(), and RenderState::viewport().

void OpenGLContext::adjustToNewSize ( )

privatevirtual

Definition at line 324 of file OpenGLContext.cxx.

References getOpenGLWindow(), GLWindow::Height, and GLWindow::Width.

Referenced by setWinPosAndSize().

void OpenGLContext::BindFramebuffer

(

OpenGLFramebuffer *

pFramebuffer

)

Definition at line 587 of file OpenGLContext.cxx.

References OpenGLFramebuffer::Bind(), mpCurrentFramebuffer, and OpenGLFramebuffer::Unbind().

Referenced by AcquireDefaultFramebuffer(), AcquireFramebuffer(), ReleaseFramebuffer(), ReleaseFramebuffers(), and UnbindTextureFromFramebuffers().

void OpenGLContext::BuffersSwapped ( )

staticprotected

Definition at line 545 of file OpenGLContext.cxx.

References nBufferSwapCounter.

Referenced by swapBuffers().

void OpenGLContext::clearCurrent ( )

static

release bound resources from the current context

Definition at line 429 of file OpenGLContext.cxx.

References ImplGetSVData(), ImplSVData::maGDIData, and ImplSVGDIData::mpLastContext.

Referenced by makeCurrent(), and resetCurrent().

rtl::Reference< OpenGLContext > OpenGLContext::Create ( )

static

Definition at line 107 of file OpenGLContext.cxx.

References SalInstance::CreateOpenGLContext(), ImplGetSVData(), and ImplSVData::mpDefInst.

void OpenGLContext::destroyCurrentContext ( )

privatevirtual

Reimplemented in Qt5OpenGLContext.

Definition at line 343 of file OpenGLContext.cxx.

Referenced by reset().

void OpenGLContext::dispose

(

void

)

Definition at line 101 of file OpenGLContext.cxx.

References VclPtr< reference_type >::disposeAndClear(), m_pChildWindow, and reset().

SystemWindowData OpenGLContext::generateWinData ( vcl::Window *  pParent, bool  bRequestLegacyContext  )

virtual

Definition at line 392 of file OpenGLContext.cxx.

SystemChildWindow * OpenGLContext::getChildWindow

(

)

Definition at line 577 of file OpenGLContext.cxx.

References m_pChildWindow.

const SystemChildWindow * OpenGLContext::getChildWindow

(

)

const

Definition at line 582 of file OpenGLContext.cxx.

References m_pChildWindow.

virtual GLWindow& OpenGLContext::getModifiableOpenGLWindow ( )

protectedpure virtual

Implemented in Qt5OpenGLContext.

Referenced by setWinPosAndSize().

OpenGLCapabilitySwitch& OpenGLContext::getOpenGLCapabilitySwitch ( )

inline

Definition at line 94 of file OpenGLContext.hxx.

virtual const GLWindow& OpenGLContext::getOpenGLWindow ( ) const

pure virtual

Implemented in Qt5OpenGLContext.

Referenced by adjustToNewSize().

OpenGLProgram * OpenGLContext::GetProgram	(	const OUString &	rVertexShader,
		const OUString &	rFragmentShader,
		const OString &	preamble = ""
	)

Definition at line 754 of file OpenGLContext.cxx.

References OpenGLHelper::GetDigest(), maPrograms, and OUStringToOString().

Referenced by UseProgram().

rtl::Reference< OpenGLContext > OpenGLContext::getVCLContext ( bool  bMakeIfNecessary = true )

static

fetch any VCL context, creating one if bMakeIfNecessary is set.

Definition at line 470 of file OpenGLContext.cxx.

References assert(), OutputDevice::GetGraphics(), SalGraphics::GetOpenGLContext(), ImplGetDefaultWindow(), ImplGetSVData(), isInitialized(), isVCLOnly(), ImplSVData::maGDIData, ImplSVGDIData::mpLastContext, and mpPrevContext.

Referenced by makeVCLCurrent().

bool OpenGLContext::hasCurrent ( )

static

Is there a current GL context ?

Definition at line 422 of file OpenGLContext.cxx.

References ImplGetSVData(), ImplSVData::maGDIData, and ImplSVGDIData::mpLastContext.

Referenced by OpenGLHelper::debugMsgPrint(), and prepareForYield().

bool OpenGLContext::ImplInit ( )

protectedvirtual

Reimplemented in Qt5OpenGLContext.

Definition at line 231 of file OpenGLContext.cxx.

References VCL_GL_INFO.

Referenced by init().

bool OpenGLContext::init

(

vcl::Window *

pParent

)

Definition at line 214 of file OpenGLContext.cxx.

References VclPtr< reference_type >::disposeAndClear(), VclPtr< reference_type >::get(), ImplInit(), initWindow(), m_pChildWindow, m_xWindow, mbInitialized, mpWindow, VclPtr< reference_type >::reset(), vcl::Window::setPosSizePixel(), WB_NOBORDER, and WB_NODIALOGCONTROL.

void OpenGLContext::InitChildWindow ( SystemChildWindow *  pChildWindow )

staticprotected

Definition at line 330 of file OpenGLContext.cxx.

References Clip, SystemChildWindow::EnableEraseBackground(), vcl::Window::SetControlBackground(), vcl::Window::SetControlForeground(), vcl::Window::SetMouseTransparent(), and vcl::Window::SetParentClipMode().

bool OpenGLContext::InitGL ( )

protected

Definition at line 250 of file OpenGLContext.cxx.

References getGLString(), OpenGLHelper::getGLVersion(), mbInitialized, SAL_WARN, and VCL_GL_INFO.

void OpenGLContext::InitGLDebugging ( )

staticprotected

Definition at line 273 of file OpenGLContext.cxx.

References VCL_GL_INFO.

void OpenGLContext::initWindow ( )

privatevirtual

Reimplemented in Qt5OpenGLContext.

Definition at line 339 of file OpenGLContext.cxx.

Referenced by init().

bool OpenGLContext::isAnyCurrent ( )

virtual

Is any GL context the current context ?

Reimplemented in Qt5OpenGLContext.

Definition at line 417 of file OpenGLContext.cxx.

bool OpenGLContext::isCurrent ( )

virtual

Is this GL context the current context ?

Reimplemented in Qt5OpenGLContext.

Definition at line 397 of file OpenGLContext.cxx.

References void().

Referenced by makeCurrent(), and reset().

bool OpenGLContext::isInitialized ( ) const

inline

Definition at line 132 of file OpenGLContext.hxx.

References mbInitialized.

Referenced by getVCLContext().

bool OpenGLContext::IsTextureAttachedAnywhere ( GLuint  nTexture )

static

Method for debugging; check texture is not already attached.

Definition at line 693 of file OpenGLContext.cxx.

References ImplGetSVData(), ImplSVData::maGDIData, ImplSVGDIData::mpLastContext, and mpPrevContext.

Referenced by UnbindTextureFromFramebuffers().

bool OpenGLContext::isVCLOnly ( ) const

inline

Definition at line 139 of file OpenGLContext.hxx.

Referenced by getVCLContext().

void OpenGLContext::makeCurrent ( )

virtual

make this GL context current - so it is implicit in subsequent GL calls

Reimplemented in Qt5OpenGLContext.

Definition at line 403 of file OpenGLContext.cxx.

References clearCurrent(), isCurrent(), and registerAsCurrent().

Referenced by reset().

void OpenGLContext::makeVCLCurrent ( )

static

make a VCL context (any context) current, create it if necessary.

Definition at line 505 of file OpenGLContext.cxx.

References getVCLContext().

Referenced by OpenGLVCLContextZone::OpenGLVCLContextZone().

void OpenGLContext::prepareForYield ( )

static

release contexts etc. before (potentially) allowing another thread run.

Definition at line 440 of file OpenGLContext.cxx.

References assert(), hasCurrent(), ImplGetSVData(), ImplSVData::maGDIData, ImplSVGDIData::mpLastContext, and SAL_INFO.

void OpenGLContext::registerAsCurrent

(

)

Put this GL context to the end of the context list.

Definition at line 510 of file OpenGLContext.cxx.

References ImplGetSVData(), ImplSVData::maGDIData, ImplSVGDIData::mpLastContext, mpNextContext, mpPrevContext, mpRenderState, and VCL_GL_INFO.

Referenced by makeCurrent().

void OpenGLContext::release ( )

inline

Definition at line 64 of file OpenGLContext.hxx.

void OpenGLContext::ReleaseFramebuffer ( OpenGLFramebuffer *  pFramebuffer )

static

Definition at line 709 of file OpenGLContext.cxx.

References OpenGLFramebuffer::DetachTexture().

void OpenGLContext::ReleaseFramebuffer

(

const OpenGLTexture &

rTexture

)

Definition at line 715 of file OpenGLContext.cxx.

References BindFramebuffer(), OpenGLFramebuffer::DetachTexture(), OpenGLFramebuffer::IsAttached(), mpCurrentFramebuffer, mpLastFramebuffer, and OpenGLFramebuffer::mpPrevFramebuffer.

void OpenGLContext::ReleaseFramebuffers

(

)

Definition at line 737 of file OpenGLContext.cxx.

References BindFramebuffer(), OpenGLFramebuffer::DetachTexture(), OpenGLFramebuffer::IsFree(), mpLastFramebuffer, and OpenGLFramebuffer::mpPrevFramebuffer.

void OpenGLContext::requestLegacyContext

(

)

Definition at line 112 of file OpenGLContext.cxx.

References mbRequestLegacyContext.

void OpenGLContext::reset

(

)

Definition at line 348 of file OpenGLContext.cxx.

References destroyCurrentContext(), isCurrent(), maClipRegion, makeCurrent(), maPrograms, mbInitialized, mnFramebufferCount, mpFirstFramebuffer, mpLastFramebuffer, OpenGLFramebuffer::mpPrevFramebuffer, mpRenderState, resetCurrent(), and vcl::Region::SetEmpty().

Referenced by dispose(), and ~OpenGLContext().

void OpenGLContext::resetCurrent ( )

virtual

reset the GL context so this context is not implicit in subsequent GL calls.

Reimplemented in Qt5OpenGLContext.

Definition at line 533 of file OpenGLContext.cxx.

References clearCurrent().

Referenced by reset().

void OpenGLContext::restoreDefaultFramebuffer ( )

virtual

unbind the GL_FRAMEBUFFER to its default state, needed for gtk3

Definition at line 306 of file OpenGLContext.cxx.

void OpenGLContext::setVCLOnly ( )

inline

VCL promiscuously re-uses its own contexts:

Definition at line 138 of file OpenGLContext.hxx.

void OpenGLContext::setWinPosAndSize	(	const Point &	rPos,
		const Size &	rSize
	)

Definition at line 311 of file OpenGLContext.cxx.

References adjustToNewSize(), getModifiableOpenGLWindow(), Size::Height(), GLWindow::Height, m_pChildWindow, m_xWindow, vcl::Window::SetPosSizePixel(), Size::Width(), and GLWindow::Width.

void OpenGLContext::show

(

)

Definition at line 569 of file OpenGLContext.cxx.

References m_pChildWindow, m_xWindow, and vcl::Window::Show().

RenderState& OpenGLContext::state ( )

inline

Definition at line 89 of file OpenGLContext.hxx.

Referenced by AcquireFramebuffer().

void OpenGLContext::swapBuffers ( )

virtual

Reimplemented in Qt5OpenGLContext.

Definition at line 539 of file OpenGLContext.cxx.

References BuffersSwapped().

void OpenGLContext::sync ( )

virtual

Definition at line 563 of file OpenGLContext.cxx.

References void().

void OpenGLContext::UnbindTextureFromFramebuffers

(

GLuint

nTexture

)

Definition at line 671 of file OpenGLContext.cxx.

References assert(), BindFramebuffer(), OpenGLFramebuffer::DetachTexture(), OpenGLFramebuffer::IsAttached(), IsTextureAttachedAnywhere(), mpLastFramebuffer, and OpenGLFramebuffer::mpPrevFramebuffer.

OpenGLProgram * OpenGLContext::UseProgram	(	const OUString &	rVertexShader,
		const OUString &	rFragmentShader,
		const OString &	preamble = ""
	)

Definition at line 783 of file OpenGLContext.cxx.

References GetProgram(), OpenGLProgram::Id(), mpCurrentProgram, OpenGLProgram::Reuse(), SAL_WARN, OpenGLProgram::Use(), and VCL_GL_INFO.

Friends And Related Function Documentation

friend class OpenGLTests

friend

Definition at line 57 of file OpenGLContext.hxx.

Member Data Documentation

VclPtr<SystemChildWindow> OpenGLContext::m_pChildWindow

protected

Definition at line 158 of file OpenGLContext.hxx.

Referenced by dispose(), getChildWindow(), init(), setWinPosAndSize(), show(), and ~OpenGLContext().

VclPtr<vcl::Window> OpenGLContext::m_xWindow

protected

Definition at line 156 of file OpenGLContext.hxx.

Referenced by init(), setWinPosAndSize(), and show().

vcl::Region OpenGLContext::maClipRegion

Definition at line 179 of file OpenGLContext.hxx.

Referenced by reset().

OpenGLCapabilitySwitch OpenGLContext::maOpenGLCapabilitySwitch

protected

Definition at line 169 of file OpenGLContext.hxx.

ProgramCollection OpenGLContext::maPrograms

private

Definition at line 173 of file OpenGLContext.hxx.

Referenced by GetProgram(), and reset().

bool OpenGLContext::mbInitialized

protected

Definition at line 159 of file OpenGLContext.hxx.

Referenced by init(), InitGL(), and reset().

bool OpenGLContext::mbRequestLegacyContext

protected

Definition at line 161 of file OpenGLContext.hxx.

Referenced by requestLegacyContext().

bool OpenGLContext::mbVCLOnly

protected

Definition at line 162 of file OpenGLContext.hxx.

int OpenGLContext::mnFramebufferCount

protected

Definition at line 164 of file OpenGLContext.hxx.

Referenced by AcquireFramebuffer(), and reset().

int OpenGLContext::mnRefCount

protected

Definition at line 160 of file OpenGLContext.hxx.

Referenced by ~OpenGLContext().

OpenGLFramebuffer* OpenGLContext::mpCurrentFramebuffer

protected

Definition at line 165 of file OpenGLContext.hxx.

Referenced by BindFramebuffer(), and ReleaseFramebuffer().

OpenGLProgram* OpenGLContext::mpCurrentProgram

private

Definition at line 174 of file OpenGLContext.hxx.

Referenced by UseProgram().

OpenGLFramebuffer* OpenGLContext::mpFirstFramebuffer

protected

Definition at line 166 of file OpenGLContext.hxx.

Referenced by AcquireFramebuffer(), and reset().

OpenGLFramebuffer* OpenGLContext::mpLastFramebuffer

protected

Definition at line 167 of file OpenGLContext.hxx.

Referenced by AcquireFramebuffer(), ReleaseFramebuffer(), ReleaseFramebuffers(), reset(), and UnbindTextureFromFramebuffers().

OpenGLContext* OpenGLContext::mpNextContext

Definition at line 183 of file OpenGLContext.hxx.

Referenced by OpenGLContext(), registerAsCurrent(), and ~OpenGLContext().

OpenGLContext* OpenGLContext::mpPrevContext

Definition at line 182 of file OpenGLContext.hxx.

Referenced by getVCLContext(), IsTextureAttachedAnywhere(), OpenGLContext(), registerAsCurrent(), and ~OpenGLContext().

std::unique_ptr<RenderState> OpenGLContext::mpRenderState

private

Definition at line 176 of file OpenGLContext.hxx.

Referenced by registerAsCurrent(), and reset().

VclPtr<vcl::Window> OpenGLContext::mpWindow

protected

Definition at line 157 of file OpenGLContext.hxx.

Referenced by init().

---

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

• OpenGLContext.hxx
• OpenGLContext.cxx