kzu_engine.h File Reference

#include <kanzi/core.ui/assets/runtime_assets.hpp>
#include <kanzi/core.ui/domain/domain.hpp>
#include <kanzi/core.ui/node/screen.hpp>
#include <kanzi/core.ui/node/viewport2d.hpp>
#include <kanzi/core.ui/util/frame_time_queue.hpp>
#include <kanzi/core/cpp/chrono.hpp>
#include <kanzi/core/profiling/startup_profiler_registry.hpp>
#include <kanzi/core/legacy/debug/kzs_error.hpp>
#include <kanzi/core/legacy/kzs_types.hpp>

Classes
struct	KzuEngine
	Structure for graphics engine core functionality. More...

Namespaces
namespace	kanzi

Typedefs
using	kanzi::FramebufferSharedPtr
	Framebuffer shared pointer type.

Functions
KZ_DEPRECATED kzsError	kzuEngineCreate (kanzi::Domain *domain, kzString binaryName, kanzi::StartupProfilerRegistry *m_startupProfilerRegistry, struct KzuEngine **out_engine)
	Create a new engine and necessary components for it, such as renderer and its default materials.
KZ_DEPRECATED kzsError	kzuEngineDelete (KzuEngine *engine)
	Deletes an engine.
KZ_DEPRECATED kzFloat	kzuEngineGetFramesPerSecond (const struct KzuEngine *engine)
	Gets frames per second from engine (FPS), measuring the overall frames per second.
KZ_DEPRECATED kanzi::Vector2	kzuEngineGetRenderingAreaOffset (struct KzuEngine *engine)
KZ_DEPRECATED kanzi::TextureSharedPtr	kzuEngineGetRootCompositionTarget (struct KzuEngine *engine)
	Access root framebuffer from engine.
KZ_DEPRECATED kanzi::ScreenSharedPtr	kzuEngineGetScreen (const struct KzuEngine *engine)
	Gets screen of engine.
KZ_DEPRECATED kzsError	kzuEngineInvalidateGPUResources (const struct KzuEngine *engine)
	Invalidates all GPU resources.
KZ_DEPRECATED void	kzuEngineInvalidateScreenLayout (struct KzuEngine *engine)
	Invalidates the layout of the attached screen.
KZ_DEPRECATED kzsError	kzuEngineLoadBinary (struct KzuEngine *engine, kzBool toolPresent)
	Loads the KZB files if they have not yet been loaded.
KZ_DEPRECATED void	kzuEngineMeasurePerformance (struct KzuEngine *engine, kanzi::chrono::nanoseconds deltaTime)
	Updates engine FPS calculations.
KZ_DEPRECATED kzsError	kzuEngineRestoreNodeResources (const struct KzuEngine *engine)
	Restores node resources after application sleep.
KZ_DEPRECATED void	kzuEngineSetRenderingAreaOffset (struct KzuEngine *engine, const kanzi::Vector2 &offset)
KZ_DEPRECATED void	kzuEngineSetRootCompositionTarget (struct KzuEngine *engine, kanzi::TextureSharedPtr framebuffer)
	Set root framebuffer for engine to use.
KZ_DEPRECATED kzsError	kzuEngineSetScreen (struct KzuEngine *engine, kanzi::ScreenSharedPtr screen)
	Sets screen of engine.
KZ_DEPRECATED kzsError	kzuEngineSetScreenOrientation (struct KzuEngine *engine, kanzi::WindowOrientation orientation)
	Sets the orientation of the screen.

Function Documentation

kzuEngineCreate()

KZ_DEPRECATED kzsError kzuEngineCreate	(	kanzi::Domain *	domain,
		kzString	binaryName,
		kanzi::StartupProfilerRegistry *	m_startupProfilerRegistry,
		struct KzuEngine **	out_engine )

Create a new engine and necessary components for it, such as renderer and its default materials.

Deprecated

In Kanzi 3.9.6. Use the functionality provided by the kanzi::Application, kanzi::Screen, and kanzi::ResourceManager classes instead.

kzuEngineDelete()

KZ_DEPRECATED kzsError kzuEngineDelete

(

KzuEngine *

engine

)

Deletes an engine.

Deprecated

In Kanzi 3.9.6. Use the functionality provided by the kanzi::Application, kanzi::Screen, and kanzi::ResourceManager classes instead.

kzuEngineMeasurePerformance()

KZ_DEPRECATED void kzuEngineMeasurePerformance	(	struct KzuEngine *	engine,
		kanzi::chrono::nanoseconds	deltaTime )

Updates engine FPS calculations.

Should be called once per frame.

Deprecated

In Kanzi 3.9.6. Use kanzi::Application::measurePerformance() instead.

kzuEngineGetFramesPerSecond()

KZ_DEPRECATED kzFloat kzuEngineGetFramesPerSecond

(

const struct KzuEngine *

engine

)

Gets frames per second from engine (FPS), measuring the overall frames per second.

Deprecated

In Kanzi 3.9.6. Use kanzi::Application::getFramesPerSecond() instead.

kzuEngineLoadBinary()

KZ_DEPRECATED kzsError kzuEngineLoadBinary	(	struct KzuEngine *	engine,
		kzBool	toolPresent )

Loads the KZB files if they have not yet been loaded.

Deprecated

In Kanzi 3.9.6. Use kanzi::Application::loadKzbFile() instead.

kzuEngineSetScreen()

KZ_DEPRECATED kzsError kzuEngineSetScreen	(	struct KzuEngine *	engine,
		kanzi::ScreenSharedPtr	screen )

Sets screen of engine.

Deprecated

In Kanzi 3.9.6. Use kanzi::Application::setScreen() instead.

kzuEngineGetScreen()

KZ_DEPRECATED kanzi::ScreenSharedPtr kzuEngineGetScreen

(

const struct KzuEngine *

engine

)

Gets screen of engine.

Deprecated

In Kanzi 3.9.6. Use kanzi::Application::getScreen() instead.

kzuEngineSetScreenOrientation()

KZ_DEPRECATED kzsError kzuEngineSetScreenOrientation	(	struct KzuEngine *	engine,
		kanzi::WindowOrientation	orientation )

Sets the orientation of the screen.

Deprecated

In Kanzi 3.9.6. Use kanzi::Screen::setWindowOrientation() instead.

kzuEngineInvalidateScreenLayout()

KZ_DEPRECATED void kzuEngineInvalidateScreenLayout

(

struct KzuEngine *

engine

)

Invalidates the layout of the attached screen.

Deprecated

In Kanzi 3.9.6. Use kanzi::Screen::invalidateMeasure() instead.

kzuEngineInvalidateGPUResources()

KZ_DEPRECATED kzsError kzuEngineInvalidateGPUResources

(

const struct KzuEngine *

engine

)

Invalidates all GPU resources.

Deprecated

In Kanzi 3.9.6. Use kanzi::ResourceManager::invalidateAllGPUResources() instead.

kzuEngineRestoreNodeResources()

KZ_DEPRECATED kzsError kzuEngineRestoreNodeResources

(

const struct KzuEngine *

engine

)

Restores node resources after application sleep.

Deprecated

In Kanzi 3.9.6. Use kanzi::Application::restoreNodeResources() instead.

kzuEngineSetRootCompositionTarget()

KZ_DEPRECATED void kzuEngineSetRootCompositionTarget	(	struct KzuEngine *	engine,
		kanzi::TextureSharedPtr	framebuffer )

Set root framebuffer for engine to use.

Parameters

engine	Engine.
framebuffer	Root framebuffer used from now on.

Deprecated

In Kanzi 3.9.6. Use kanzi::Application::setRootCompositionTarget() instead.

kzuEngineGetRootCompositionTarget()

KZ_DEPRECATED kanzi::TextureSharedPtr kzuEngineGetRootCompositionTarget

(

struct KzuEngine *

engine

)

Access root framebuffer from engine.

Parameters

engine

Engine.

Returns

Root framebuffer in use, may be an empty pointer.

Deprecated

In Kanzi 3.9.6. Use kanzi::Application::getRootCompositionTarget() instead.

kzuEngineGetRenderingAreaOffset()

KZ_DEPRECATED kanzi::Vector2 kzuEngineGetRenderingAreaOffset

(

struct KzuEngine *

engine

)

Deprecated

In Kanzi 3.9.6. Use kanzi::Application::getRenderingAreaOffset() instead.

kzuEngineSetRenderingAreaOffset()

KZ_DEPRECATED void kzuEngineSetRenderingAreaOffset	(	struct KzuEngine *	engine,
		const kanzi::Vector2 &	offset )

Deprecated

In Kanzi 3.9.6. Use kanzi::Application::setRenderingAreaOffset() instead.