kzs_system.h File Reference

System header. More...

#include <system/debug/kzs_error.h>
#include <system/kzs_header.h>

Enumerations
enum	KzsSystemMemoryLeakReporting { KZS_SYSTEM_MEMORY_LEAK_REPORTING_NONE, KZS_SYSTEM_MEMORY_LEAK_REPORTING_WARNING, KZS_SYSTEM_MEMORY_LEAK_REPORTING_EXCEPTION }
	Reporting mode for memory leaks. More...

Functions
KZ_HEADER_BEGIN KANZI_API kzsError	kzsSystemInitialize (void)
	Initializes the system. More...
KANZI_API kzsException	kzsSystemUninitialize (void)
	Uninitializes the system. More...
void KANZI_API	kzsSystemSetMemoryLeakReporting (enum KzsSystemMemoryLeakReporting reportingMode)
	Enables the reporting of leaked memory when uninitializing the application. More...
enum KzsSystemMemoryLeakReporting	kzsSystemGetMemoryLeakReporting (void)
	Checks if the reporting of leaked memory when uninitializing the application is enabled. More...
void	kzsFloatToBytesLittleEndian (kzFloat floatValue, kzByte *out_floatBytes)
	Converts a 32-bit floating point number to 4 bytes in little-endian format. More...
void	kzsFloatToBytesBigEndian (kzFloat floatValue, kzByte *out_floatBytes)
	Converts a 32-bit floating point number to 4 bytes in big-endian format. More...
kzFloat	kzsBytesToFloatLittleEndian (const kzByte *floatBytes)
	Converts 4 bytes of floating point value from little-endian format to a 32-bit floating point number. More...
kzFloat	kzsBytesToFloatBigEndian (const kzByte *floatBytes)
	Converts 4 bytes of floating point value from big-endian format to a 32-bit floating point number. More...
kzString	kzsGetVersionString (void)
	Returns the Kanzi version string constant. More...

Detailed Description

System header.

Copyright 2008-2020 by Rightware. All rights reserved.

Enumeration Type Documentation

enum KzsSystemMemoryLeakReporting

Reporting mode for memory leaks.

Enumerator
KZS_SYSTEM_MEMORY_LEAK_REPORTING_NONE	Memory leaks are not reported.
KZS_SYSTEM_MEMORY_LEAK_REPORTING_WARNING	Warning is logged for memory leaks. This is the default.
KZS_SYSTEM_MEMORY_LEAK_REPORTING_EXCEPTION	Exception is thrown for memory leaks.

Function Documentation

KZ_HEADER_BEGIN KANZI_API kzsError kzsSystemInitialize

(

void

)

Initializes the system.

KANZI_API kzsException kzsSystemUninitialize

(

void

)

Uninitializes the system.

void KANZI_API kzsSystemSetMemoryLeakReporting

(

enum KzsSystemMemoryLeakReporting

reportingMode

)

Enables the reporting of leaked memory when uninitializing the application.

enum KzsSystemMemoryLeakReporting kzsSystemGetMemoryLeakReporting

(

void

)

Checks if the reporting of leaked memory when uninitializing the application is enabled.

void kzsFloatToBytesLittleEndian	(	kzFloat	floatValue,
		kzByte *	out_floatBytes
	)

Converts a 32-bit floating point number to 4 bytes in little-endian format.

void kzsFloatToBytesBigEndian	(	kzFloat	floatValue,
		kzByte *	out_floatBytes
	)

Converts a 32-bit floating point number to 4 bytes in big-endian format.

kzFloat kzsBytesToFloatLittleEndian

(

const kzByte *

floatBytes

)

Converts 4 bytes of floating point value from little-endian format to a 32-bit floating point number.

kzFloat kzsBytesToFloatBigEndian

(

const kzByte *

floatBytes

)

Converts 4 bytes of floating point value from big-endian format to a 32-bit floating point number.

kzString kzsGetVersionString

(

void

)

Returns the Kanzi version string constant.