Kanzi  3.9.9
Kanzi Engine C++ API
kzs_desktop.h File Reference

Kanzi desktop. More...

Functions

kzsError kzsDesktopCreate (const kanzi::NativeDesktopProperties *desktopPropertiesRequested, struct KzsDesktop **out_desktop)
 Creates a desktop. More...
 
kzsError kzsDesktopDelete (struct KzsDesktop *desktop)
 Deletes a desktop and frees all memory allocated for it. More...
 
kzUint kzsDesktopGetCurrentHeight (const struct KzsDesktop *desktop)
 Returns the current desktop height in pixels. More...
 
kzUint kzsDesktopGetCurrentWidth (const struct KzsDesktop *desktop)
 Returns the current desktop width in pixels. More...
 
kzsError kzsDesktopGetDisplayCount (const struct KzsDesktop *desktop, kzUint *out_displayCount)
 Gets number of available displays on the desktop. More...
 
struct KzsDesktopNative * kzsDesktopGetNative (const struct KzsDesktop *desktop)
 Returns the native desktop struct. More...
 
void kzsDesktopLogProperties (const struct KzsDesktop *desktop)
 Outputs the properties of the desktop to the log. More...
 
kzsError kzsDesktopNativeCreate (const kanzi::NativeDesktopProperties *desktopPropertiesRequested, struct KzsDesktopNative **out_desktopNative)
 Creates the platform dependent portion of the desktop. More...
 
kzsError kzsDesktopNativeDelete (struct KzsDesktopNative *desktopNative)
 Deletes the platform dependent portion of the desktop. More...
 
kzUint kzsDesktopNativeGetCurrentHeight (const struct KzsDesktopNative *desktopNative)
 Returns the current desktop height in pixels. More...
 
kzUint kzsDesktopNativeGetCurrentWidth (const struct KzsDesktopNative *desktopNative)
 Returns the current desktop width in pixels. More...
 
kzsError kzsDesktopNativeGetDisplayCount (const struct KzsDesktopNative *desktopNative, kzUint *out_displayCount)
 Gets number of available displays on the desktop. More...
 

Detailed Description

Kanzi desktop.

Copyright 2008-2017 by Rightware. All rights reserved.

Function Documentation

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

Creates a desktop.

Since
Kanzi 3.9.7 added desktopPropertiesRequested.
kzsError kzsDesktopDelete ( struct KzsDesktop desktop)

Deletes a desktop and frees all memory allocated for it.

kzsError kzsDesktopGetDisplayCount ( const struct KzsDesktop desktop,
kzUint out_displayCount 
)

Gets number of available displays on the desktop.

kzUint kzsDesktopGetCurrentWidth ( const struct KzsDesktop desktop)

Returns the current desktop width in pixels.

kzUint kzsDesktopGetCurrentHeight ( const struct KzsDesktop desktop)

Returns the current desktop height in pixels.

struct KzsDesktopNative* kzsDesktopGetNative ( const struct KzsDesktop desktop)

Returns the native desktop struct.

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.
kzsError kzsDesktopNativeDelete ( struct KzsDesktopNative *  desktopNative)

Deletes the platform dependent portion of the desktop.

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

Gets number of available displays on the desktop.

kzUint kzsDesktopNativeGetCurrentWidth ( const struct KzsDesktopNative *  desktopNative)

Returns the current desktop width in pixels.

kzUint kzsDesktopNativeGetCurrentHeight ( const struct KzsDesktopNative *  desktopNative)

Returns the current desktop height in pixels.

void kzsDesktopLogProperties ( const struct KzsDesktop desktop)

Outputs the properties of the desktop to the log.