Kanzi desktop. More...

#include <kanzi/core.ui/platform/windowing/common/desktop_properties.hpp>
#include <kanzi/core/legacy/debug/kzs_error.hpp>
#include <kanzi/core.ui/coreui_api.hpp>

Functions
kzsError	kzsDesktopCreate (const kanzi::NativeDesktopProperties desktopPropertiesRequested, struct KzsDesktop *out_desktop)
	Creates a desktop.

kzsError	kzsDesktopDelete (struct KzsDesktop *desktop)
	Deletes a desktop and frees all memory allocated for it.

kzUint	kzsDesktopGetCurrentHeight (const struct KzsDesktop *desktop)
	Returns the current desktop height in pixels.

kzUint	kzsDesktopGetCurrentWidth (const struct KzsDesktop *desktop)
	Returns the current desktop width in pixels.

kzsError	kzsDesktopGetDisplayCount (const struct KzsDesktop desktop, kzUint out_displayCount)
	Gets number of available displays on the desktop.

struct KzsDesktopNative *	kzsDesktopGetNative (const struct KzsDesktop *desktop)
	Returns the native desktop struct.

void	kzsDesktopLogProperties (const struct KzsDesktop *desktop)
	Outputs the properties of the desktop to the log.

kzsError	kzsDesktopNativeCreate (const kanzi::NativeDesktopProperties desktopPropertiesRequested, struct KzsDesktopNative *out_desktopNative)
	Creates the platform dependent portion of the desktop.

kzsError	kzsDesktopNativeDelete (struct KzsDesktopNative *desktopNative)
	Deletes the platform dependent portion of the desktop.

kzUint	kzsDesktopNativeGetCurrentHeight (const struct KzsDesktopNative *desktopNative)
	Returns the current desktop height in pixels.

kzUint	kzsDesktopNativeGetCurrentWidth (const struct KzsDesktopNative *desktopNative)
	Returns the current desktop width in pixels.

kzsError	kzsDesktopNativeGetDisplayCount (const struct KzsDesktopNative desktopNative, kzUint out_displayCount)
	Gets number of available displays on the desktop.

Detailed Description

Kanzi desktop.

Function Documentation

◆ kzsDesktopCreate()

kzsError kzsDesktopCreate	(	const kanzi::NativeDesktopProperties *	desktopPropertiesRequested,
		struct KzsDesktop **	out_desktop )

Creates a desktop.

Since: Kanzi 3.9.7 added desktopPropertiesRequested.

◆ kzsDesktopDelete()

kzsError kzsDesktopDelete ( struct KzsDesktop * desktop )

Deletes a desktop and frees all memory allocated for it.

◆ kzsDesktopGetDisplayCount()

kzsError kzsDesktopGetDisplayCount	(	const struct KzsDesktop *	desktop,
		kzUint *	out_displayCount )

Gets number of available displays on the desktop.

◆ kzsDesktopGetCurrentWidth()

kzUint kzsDesktopGetCurrentWidth ( const struct KzsDesktop * desktop )

Returns the current desktop width in pixels.

◆ kzsDesktopGetCurrentHeight()

kzUint kzsDesktopGetCurrentHeight ( const struct KzsDesktop * desktop )

Returns the current desktop height in pixels.

◆ kzsDesktopGetNative()

struct KzsDesktopNative * kzsDesktopGetNative ( const struct KzsDesktop * desktop )

Returns the native desktop struct.

◆ kzsDesktopNativeCreate()

kzsError kzsDesktopNativeCreate	(	const kanzi::NativeDesktopProperties *	desktopPropertiesRequested,
		struct KzsDesktopNative **	out_desktopNative )

Creates the platform dependent portion of the desktop.

Since: Kanzi 3.9.7 added desktopPropertiesRequested.

◆ kzsDesktopNativeDelete()

kzsError kzsDesktopNativeDelete ( struct KzsDesktopNative * desktopNative )

Deletes the platform dependent portion of the desktop.

◆ kzsDesktopNativeGetDisplayCount()

kzsError kzsDesktopNativeGetDisplayCount	(	const struct KzsDesktopNative *	desktopNative,
		kzUint *	out_displayCount )

Gets number of available displays on the desktop.

◆ kzsDesktopNativeGetCurrentWidth()

kzUint kzsDesktopNativeGetCurrentWidth ( const struct KzsDesktopNative * desktopNative )