PlatformFunctions

Functions
virtual uintptr_t	kanzi::platform::Platform::acquireNativeDisplay ()=0
	Acquires the platform specific default display type.
virtual uintptr_t	kanzi::platform::Platform::findNativeDisplayConfig (const SurfaceProperties &properties, bool requirePBuffer)=0
	Finds a suitable platform specific display configuration such as GLXFBConfig that is closest match to given surface properties.
virtual bool	kanzi::platform::Platform::initialize (const SystemConfiguration &configuration)=0
	Initializes the platform object.
	kanzi::platform::Platform::Platform ()=default
virtual void	kanzi::platform::Platform::releaseNativeDisplay ()=0
	Releases platform specific default display type.
virtual bool	kanzi::platform::Platform::uninitialize ()=0
	Uninitializes the platform object.
virtual	kanzi::platform::Platform::~Platform ()=default

Detailed Description

Function Documentation

~Platform()

virtual kanzi::platform::Platform::~Platform ( )

virtualdefault

initialize()

virtual bool kanzi::platform::Platform::initialize ( const SystemConfiguration & configuration )

pure virtual

Initializes the platform object.

Parameters

configuration

System configuration.

Returns

Returns true if initialization succeeded.

Implemented in kanzi::platform::AndroidPlatform, kanzi::platform::EmscriptenPlatform, kanzi::platform::QnxPlatform, kanzi::platform::StubPlatform, kanzi::platform::WaylandPlatform, kanzi::platform::Win32Platform, and kanzi::platform::X11Platform.

uninitialize()

virtual bool kanzi::platform::Platform::uninitialize ( )

pure virtual

Uninitializes the platform object.

Returns

Returns true if uninitialization succeeded.

Implemented in kanzi::platform::AndroidPlatform, kanzi::platform::EmscriptenPlatform, kanzi::platform::QnxPlatform, kanzi::platform::StubPlatform, kanzi::platform::WaylandPlatform, kanzi::platform::Win32Platform, and kanzi::platform::X11Platform.

acquireNativeDisplay()

virtual uintptr_t kanzi::platform::Platform::acquireNativeDisplay ( )

pure virtual

Acquires the platform specific default display type.

Returns

Platform specific display type, needs to be cast to correct type. If the platform doesn't have concept of display, this function returns 0.

Implemented in kanzi::platform::AndroidPlatform, kanzi::platform::EmscriptenPlatform, kanzi::platform::QnxPlatform, kanzi::platform::StubPlatform, kanzi::platform::WaylandPlatform, kanzi::platform::Win32Platform, and kanzi::platform::X11Platform.

releaseNativeDisplay()

virtual void kanzi::platform::Platform::releaseNativeDisplay ( )

pure virtual

Releases platform specific default display type.

Implemented in kanzi::platform::AndroidPlatform, kanzi::platform::EmscriptenPlatform, kanzi::platform::QnxPlatform, kanzi::platform::StubPlatform, kanzi::platform::WaylandPlatform, kanzi::platform::Win32Platform, and kanzi::platform::X11Platform.

findNativeDisplayConfig()

virtual uintptr_t kanzi::platform::Platform::findNativeDisplayConfig ( const SurfaceProperties & properties, bool requirePBuffer )

pure virtual

Finds a suitable platform specific display configuration such as GLXFBConfig that is closest match to given surface properties.

Parameters

properties	Preferred surface properties.
requirePBuffer	Whether the same configuration should be possible to use for an OpenGL pbuffer.

Returns

Returns platform specific display configuration that is closest match to required properties. If the platform doesn't have concept of display configuration, this function returns 0.

Implemented in kanzi::platform::AndroidPlatform, kanzi::platform::EmscriptenPlatform, kanzi::platform::QnxPlatform, kanzi::platform::StubPlatform, kanzi::platform::WaylandPlatform, kanzi::platform::Win32Platform, and kanzi::platform::X11Platform.

Platform()

kanzi::platform::Platform::Platform ( )

protecteddefault