EGL implementation of GlGraphicsContext for Emscripten. More...

#include <kanzi/platform/platform/gl/graphics_context/egl_emscripten/egl_emscripten_graphics_context.hpp>

Inheritance diagram for kanzi::platform::EglEmscriptenGraphicsContext:

Public Member Functions
	EglEmscriptenGraphicsContext (PlatformContext &platformContext, InitializationInfo &&info) noexcept
	Constructor.

Public Member Functions inherited from kanzi::platform::EglGraphicsContext
SurfaceHandle	createSurface (NativeSurfaceHandle windowHandle, const SurfaceProperties &properties) override
	GlGraphicsContext::createSurface() implementation.

ThreadContextHandle	createThreadContext () override
	GlGraphicsContext::createThreadContext() implementation.

bool	destroySurface (SurfaceHandle surface) override
	GlGraphicsContext::destroySurface() implementation.

void	destroyThreadContext (ThreadContextHandle context) override
	GlGraphicsContext::destroyThreadContext() implementation.

	EglGraphicsContext (PlatformContext &platformContext, InitializationInfo &&info)
	Constructor.

KZ_NO_DISCARD ApiBackendBasicInfo	getApiBackendBasicInfo () const noexcept
	Provides basic information about current API backend.

SurfaceContextHandle	getCurrentSurfaceContext () override
	GlGraphicsContext::getCurrentSurfaceContext() implementation.

void *	getGLProcAddress (const char *pName) override
	GlGraphicsContext::getGLProcAddress() implementation.

SurfaceContextHandle	getSurfaceGLContext (SurfaceHandle surface) override
	GlGraphicsContext::getSurfaceGLContext() implementation.

SurfaceProperties	getSurfaceProperties (SurfaceHandle surface) override
	GlGraphicsContext::getSurfaceProperties() implementation.

vector< SurfaceHandle >	getSurfaces (SurfaceContextHandle context) override
	GlGraphicsContext::getSurfaces() implementation.

bool	initialize () override
	GlGraphicsContext::initialize() implementation.

bool	isFeatureEnabled (PlatformFeatureId feature) const override
	GlGraphicsContext::isFeatureEnabled() implementation.

void	makeSurfaceCurrent (SurfaceHandle surface) override
	GlGraphicsContext::makeSurfaceCurrent() implementation.

void	makeThreadCurrent (ThreadContextHandle context) override
	GlGraphicsContext::makeThreadCurrent() implementation.

void	shutdown () override
	GlGraphicsContext::shutdown() implementation.

bool	swapBuffers (SurfaceHandle surface) override
	GlGraphicsContext::swapBuffers() implementation.

virtual	~EglGraphicsContext ()=default
	Destructor.

Public Member Functions inherited from kanzi::platform::GlGraphicsContext
template<typename Return , typename... Args>
bool	getGLProcAddressInto (function_ptr< Return, Args... > &proc, const char *pName)
	Dynamically loads a GL function pointer into specified location.

virtual	~GlGraphicsContext ()=default
	Destructor.

Protected Member Functions
KZ_NO_DISCARD unique_ptr< AbstractWindowSurface >	createDummySurface (EGLPBufferSurface &&pbuffer) noexcept override
	EglGraphicsContext::createDummySurface() implementation.

KZ_NO_DISCARD flat_set< string_view >	getUndiscoverableEglExtensions () noexcept override
	EglGraphicsContext::getUndiscoverableEglExtensions() implementation.

KZ_NO_DISCARD EGLConfig	selectEGLConfig (const SurfaceProperties &properties) noexcept override
	EglGraphicsContext::selectEGLConfig() implementation.

bool	setSwapIntervalForCurrentSurface (PresentMode mode) noexcept override
	EglGraphicsContext::setSwapIntervalForCurrentSurface() implementation.

Protected Member Functions inherited from kanzi::platform::EglGraphicsContext
KZ_NO_DISCARD PresentMode	clampToSupportedPresentMode (PresentMode mode) noexcept
	Clamps provided PresentMode to a supported subset.

virtual KZ_NO_DISCARD ContextNodePtr	createEGLContext (const EGLConfig &config, ::EGLContext parentContext) noexcept
	Creates a new suitable context for provided config.

virtual KZ_NO_DISCARD unique_ptr< AbstractWindowSurface >	createWindowSurface (NativeSurfaceHandle windowHandle, const EGLConfig &config, SurfaceColorSpace colorSpace) noexcept
	Factory function to create window surface.

virtual bool	destroySurfaceInternal (SurfaceNodePtr surfaceNode) noexcept
	Destroys EGL surface.

KZ_NO_DISCARD ContextNodePtr	ensureEGLContext (const EGLConfig &config, ::EGLContext parentContext) noexcept
	Finds suitable context for provided config or creates a new one.

virtual KZ_NO_DISCARD ::EGLNativeDisplayType	fetchNativeDisplay (PlatformContext &platformContext)
	Gets a native EGL display.

KZ_NO_DISCARD ContextNodePtr	findLastUsedContext (thread::id threadId) noexcept
	Finds last context that was used on a specified thread.

KZ_NO_DISCARD const EGLDisplay &	getDisplay () const noexcept
	Gets EGL display.

KZ_NO_DISCARD const GLFunctionPointers &	getGlFunctionPointers () const noexcept
	Gets GL function pointers struct.

virtual KZ_NO_DISCARD GLFunctionPointers	loadGlFunctions () noexcept
	Loads required GL function pointers.

virtual bool	makeCurrentInternal (ContextNodePtr contextNode, SurfaceNodePtr surfaceNode) noexcept
	Makes provided context and surface current on this thread.

KZ_NO_DISCARD flat_set< string_view >	queryEglExtensions () const noexcept
	Queries supported EGL extensions.

KZ_NO_DISCARD flat_set< string_view >	queryGlExtensions () const noexcept
	Queries supported GL extensions.

KZ_NO_DISCARD SurfaceColorSpace	selectSuitableColorSpace (const SurfaceProperties &properties) noexcept
	Selects suitable colorspace for specified surface properties.

void	setSwapInterval (SurfaceNodePtr surfaceNode, ContextNodePtr contextNode, ContextNodePtr lastUsedContextNode, PresentMode presentMode) noexcept
	Sets swap interval for a specified surface, while preserving current EGL context and surface.

KZ_NO_DISCARD vector< EGLint >	surfaceColorSpaceToAttributes (SurfaceColorSpace colorSpace) noexcept
	Constructs EGL attributes for a specified SurfaceColorSpace.

Additional Inherited Members
Protected Types inherited from kanzi::platform::EglGraphicsContext
using	ContextContainer

using	ContextNodePtr

using	SurfaceContainer

using	SurfaceNodePtr

using	ThreadContainer

using	ThreadNodePtr

Detailed Description

EGL implementation of GlGraphicsContext for Emscripten.

Emscripten-specific constraints:

Does not support EGLPBufferSurface.
Supports only a single EGLConfig.
Reports no support for any ES version, but requires an explicit ES version to be specified at context creation.

Since: Kanzi 4.0.0; Kanzi 4.1.0 renamed from EglEmscriptenContextApi.

Attention: This feature is experimental and is likely to change in future releases.

Constructor & Destructor Documentation

◆ EglEmscriptenGraphicsContext()

kanzi::platform::EglEmscriptenGraphicsContext::EglEmscriptenGraphicsContext	(	PlatformContext &	platformContext,
		InitializationInfo &&	info )

explicitnoexcept

Constructor.

Parameters

platform	Platform context to use.
info	Initialization info struct.

Member Function Documentation

◆ selectEGLConfig()

KZ_NO_DISCARD EGLConfig kanzi::platform::EglEmscriptenGraphicsContext::selectEGLConfig ( const SurfaceProperties & properties )

overrideprotectedvirtualnoexcept

EglGraphicsContext::selectEGLConfig() implementation.

Reimplemented from kanzi::platform::EglGraphicsContext.

◆ getUndiscoverableEglExtensions()

KZ_NO_DISCARD flat_set< string_view > kanzi::platform::EglEmscriptenGraphicsContext::getUndiscoverableEglExtensions ( )

overrideprotectedvirtualnoexcept

EglGraphicsContext::getUndiscoverableEglExtensions() implementation.

Reimplemented from kanzi::platform::EglGraphicsContext.

◆ createDummySurface()

KZ_NO_DISCARD unique_ptr< AbstractWindowSurface > kanzi::platform::EglEmscriptenGraphicsContext::createDummySurface ( EGLPBufferSurface && pbuffer )