Kanzi  3.9.7
Kanzi Engine API
kzu_engine.h File Reference

Classes

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

Namespaces

 kanzi
 Easing functions that require external dependencies for calculation.
 

Typedefs

using kanzi::FramebufferSharedPtr = shared_ptr< Framebuffer >
 Framebuffer shared pointer type. More...
 

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. More...
 
KZ_DEPRECATED kzsError kzuEngineDelete (KzuEngine *engine)
 Deletes an engine. More...
 
KZ_DEPRECATED kzFloat kzuEngineGetFramesPerSecond (const struct KzuEngine *engine)
 Gets frames per second from engine (FPS), measuring the overall frames per second. More...
 
KZ_DEPRECATED kanzi::Vector2 kzuEngineGetRenderingAreaOffset (struct KzuEngine *engine)
 
KZ_DEPRECATED kanzi::TextureSharedPtr kzuEngineGetRootCompositionTarget (struct KzuEngine *engine)
 Access root framebuffer from engine. More...
 
KZ_DEPRECATED kanzi::ScreenSharedPtr kzuEngineGetScreen (const struct KzuEngine *engine)
 Gets screen of engine. More...
 
KZ_DEPRECATED kzsError kzuEngineInvalidateGPUResources (const struct KzuEngine *engine)
 Invalidates all GPU resources. More...
 
KZ_DEPRECATED void kzuEngineInvalidateScreenLayout (struct KzuEngine *engine)
 Invalidates the layout of the attached screen. More...
 
KZ_DEPRECATED kzsError kzuEngineLoadBinary (struct KzuEngine *engine, kzBool toolPresent)
 Loads the KZB files if they have not yet been loaded. More...
 
KZ_DEPRECATED void kzuEngineMeasurePerformance (struct KzuEngine *engine, kanzi::chrono::nanoseconds deltaTime)
 Updates engine FPS calculations. More...
 
KZ_DEPRECATED kzsError kzuEngineRestoreNodeResources (const struct KzuEngine *engine)
 Restores node resources after application sleep. More...
 
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. More...
 
KZ_DEPRECATED kzsError kzuEngineSetScreen (struct KzuEngine *engine, kanzi::ScreenSharedPtr screen)
 Sets screen of engine. More...
 
KZ_DEPRECATED kzsError kzuEngineSetScreenOrientation (struct KzuEngine *engine, kanzi::WindowOrientation orientation)
 Sets the orientation of the screen. More...
 

Function Documentation

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 Application, Screen, and ResourceManager classes.
KZ_DEPRECATED kzsError kzuEngineDelete ( KzuEngine engine)

Deletes an engine.

Deprecated:
In Kanzi 3.9.6. Use the functionality provided by the Application, Screen, and ResourceManager classes.
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 Application::measurePerformance() instead.
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 Application::getFramesPerSecond() instead.
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 Application::loadKzbFile() instead.
KZ_DEPRECATED kzsError kzuEngineSetScreen ( struct KzuEngine engine,
kanzi::ScreenSharedPtr  screen 
)

Sets screen of engine.

Deprecated:
In Kanzi 3.9.6. Use Application::setScreen() instead.
KZ_DEPRECATED kanzi::ScreenSharedPtr kzuEngineGetScreen ( const struct KzuEngine engine)

Gets screen of engine.

Deprecated:
In Kanzi 3.9.6. Use Application::getScreen() instead.
KZ_DEPRECATED kzsError kzuEngineSetScreenOrientation ( struct KzuEngine engine,
kanzi::WindowOrientation  orientation 
)

Sets the orientation of the screen.

Deprecated:
In Kanzi 3.9.6. Use Screen::setWindowOrientation() instead.
KZ_DEPRECATED void kzuEngineInvalidateScreenLayout ( struct KzuEngine engine)

Invalidates the layout of the attached screen.

Deprecated:
In Kanzi 3.9.6. Use Screen::invalidateMeasure() instead.
KZ_DEPRECATED kzsError kzuEngineInvalidateGPUResources ( const struct KzuEngine engine)

Invalidates all GPU resources.

Deprecated:
In Kanzi 3.9.6. Use ResourceManager::invalidateAllGPUResources() instead.
KZ_DEPRECATED kzsError kzuEngineRestoreNodeResources ( const struct KzuEngine engine)

Restores node resources after application sleep.

Deprecated:
In Kanzi 3.9.6. Use Application::restoreNodeResources() instead.
KZ_DEPRECATED void kzuEngineSetRootCompositionTarget ( struct KzuEngine engine,
kanzi::TextureSharedPtr  framebuffer 
)

Set root framebuffer for engine to use.

Parameters
engineEngine.
framebufferRoot framebuffer used from now on.
Deprecated:
In Kanzi 3.9.6. Use Application::setRootCompositionTarget() instead.
KZ_DEPRECATED kanzi::TextureSharedPtr kzuEngineGetRootCompositionTarget ( struct KzuEngine engine)

Access root framebuffer from engine.

Parameters
engineEngine.
Returns
Root framebuffer in use, may be an empty pointer.
Deprecated:
In Kanzi 3.9.6. Use Application::getRootCompositionTarget() instead.
KZ_DEPRECATED kanzi::Vector2 kzuEngineGetRenderingAreaOffset ( struct KzuEngine engine)
Deprecated:
In Kanzi 3.9.6. Use Application::getRenderingAreaOffset() instead.
KZ_DEPRECATED void kzuEngineSetRenderingAreaOffset ( struct KzuEngine engine,
const kanzi::Vector2 offset 
)
Deprecated:
In Kanzi 3.9.6. Use Application::setRenderingAreaOffset() instead.