Kanzi  3.9.5
Kanzi Engine API
kzs_window.h File Reference

Window handling. More...

Functions

kzsError kzsWindowCreate (const struct KzsDesktop *desktop, const struct KzsDisplay *display, const struct kanzi::NativeWindowProperties *windowPropertiesRequested, const struct KzsSurfaceConfiguration *configuration, struct KzsWindow **out_window)
 Creates a window and returns it. More...
 
kzsError kzsWindowCreateFromNative (struct KzsWindowNative *windowNative, struct KzsWindow **out_window)
 Creates a window with a previously created native window. More...
 
kzsError kzsWindowCreateWrapper (NativeWindowHandle windowHandle, const struct KzsDesktop *desktop, struct KzsWindow **out_window)
 Creates a window from a native handle. More...
 
kzsError kzsWindowDelete (struct KzsWindow *window)
 Deletes a window. More...
 
kzUint kzsWindowGetCurrentHeight (const struct KzsWindow *window)
 Gets the height of the window. More...
 
kzUint kzsWindowGetCurrentWidth (const struct KzsWindow *window)
 Gets the width of the window. More...
 
struct KzsWindowNative * kzsWindowGetNative (const struct KzsWindow *window)
 Gets the native window. More...
 
NativeInputHandle kzsWindowGetNativeInputHandle (const struct KzsWindow *window)
 Gets the associated native input handle. More...
 
NativeWindowHandle kzsWindowGetNativeWindowHandle (const struct KzsWindow *window)
 Gets the associated native window handle. More...
 
void kzsWindowLogProperties (const struct KzsWindow *window)
 Outputs the properties of the window to the log. More...
 
kzsError kzsWindowNativeCreate (const struct KzsDesktop *desktop, const struct KzsDisplay *display, const struct kanzi::NativeWindowProperties *windowPropertiesRequested, const struct KzsSurfaceConfiguration *surfaceConfiguration, struct kanzi::NativeWindowProperties *out_windowProperties, struct KzsWindowNative **out_windowNative)
 Creates a native window. More...
 
kzsError kzsWindowNativeCreateWrapper (NativeWindowHandle windowHandle, const struct KzsDesktop *desktop, struct kanzi::NativeWindowProperties *out_windowProperties, struct KzsWindowNative **out_windowNative)
 Creates a native window from a native handle. More...
 
kzsError kzsWindowNativeDelete (struct KzsWindowNative *windowNative)
 Deletes a native window. More...
 
kzUint kzsWindowNativeGetCurrentHeight (const struct KzsWindowNative *windowNative)
 Gets the height of the window. More...
 
kzUint kzsWindowNativeGetCurrentWidth (const struct KzsWindowNative *windowNative)
 Gets the width of the window. More...
 
NativeInputHandle kzsWindowNativeGetNativeInputHandle (const struct KzsWindowNative *windowNative)
 Gets the associated native input handle. More...
 
NativeWindowHandle kzsWindowNativeGetNativeWindowHandle (const struct KzsWindowNative *windowNative)
 Gets the associated native window handle. More...
 
kzsError kzsWindowNativeInitialize (struct KzsWindowNative *windowNative, struct KzsWindow *window)
 Initializes window. More...
 
kzsError kzsWindowNativeResize (struct KzsWindowNative *windowNative, kzUint width, kzUint height)
 Resizes the window, if applicable and supported by the platform. More...
 
kzsError kzsWindowNativeSetOrder (const struct KzsWindowNative *windowNative, kzInt order)
 Sets the window Z order, if supported by the platform. More...
 
kzsError kzsWindowNativeSetPositionAbsolute (const struct KzsWindowNative *windowNative, kzUint x, kzUint y)
 Sets the absolute position the window, if supported by the platform. More...
 
kzsError kzsWindowNativeSetTitle (const struct KzsWindowNative *windowNative, kzString titleText)
 Sets the title bar string for the window, if supported by the platform. More...
 
kzsError kzsWindowNativeShow (struct KzsWindowNative *windowNative)
 Makes newly created window visible. More...
 
kzsError kzsWindowResize (struct KzsWindow *window, kzUint width, kzUint height)
 Resizes the window, if applicable and supported by the platform. More...
 
kzsError kzsWindowSetPositionAbsolute (const struct KzsWindow *window, kzUint x, kzUint y)
 Sets the absolute position the window, if supported by the platform. More...
 
kzsError kzsWindowSetTitle (const struct KzsWindow *window, kzString titleText)
 Sets the title bar string for the window, if supported by the platform. More...
 
kzsError kzsWindowShow (struct KzsWindow *window)
 Makes newly created window visible. More...
 

Detailed Description

Window handling.

Copyright 2008-2017 by Rightware. All rights reserved.

Function Documentation

◆ kzsWindowCreateFromNative()

kzsError kzsWindowCreateFromNative ( struct KzsWindowNative *  windowNative,
struct KzsWindow **  out_window 
)

Creates a window with a previously created native window.

Takes ownership of the native window.

◆ kzsWindowCreate()

kzsError kzsWindowCreate ( const struct KzsDesktop desktop,
const struct KzsDisplay display,
const struct kanzi::NativeWindowProperties windowPropertiesRequested,
const struct KzsSurfaceConfiguration configuration,
struct KzsWindow **  out_window 
)

Creates a window and returns it.

◆ kzsWindowCreateWrapper()

kzsError kzsWindowCreateWrapper ( NativeWindowHandle  windowHandle,
const struct KzsDesktop desktop,
struct KzsWindow **  out_window 
)

Creates a window from a native handle.

◆ kzsWindowDelete()

kzsError kzsWindowDelete ( struct KzsWindow window)

Deletes a window.

◆ kzsWindowResize()

kzsError kzsWindowResize ( struct KzsWindow window,
kzUint  width,
kzUint  height 
)

Resizes the window, if applicable and supported by the platform.

◆ kzsWindowSetPositionAbsolute()

kzsError kzsWindowSetPositionAbsolute ( const struct KzsWindow window,
kzUint  x,
kzUint  y 
)

Sets the absolute position the window, if supported by the platform.

◆ kzsWindowShow()

kzsError kzsWindowShow ( struct KzsWindow window)

Makes newly created window visible.

◆ kzsWindowSetTitle()

kzsError kzsWindowSetTitle ( const struct KzsWindow window,
kzString  titleText 
)

Sets the title bar string for the window, if supported by the platform.

◆ kzsWindowGetCurrentWidth()

kzUint kzsWindowGetCurrentWidth ( const struct KzsWindow window)

Gets the width of the window.

◆ kzsWindowGetCurrentHeight()

kzUint kzsWindowGetCurrentHeight ( const struct KzsWindow window)

Gets the height of the window.

◆ kzsWindowGetNativeInputHandle()

NativeInputHandle kzsWindowGetNativeInputHandle ( const struct KzsWindow window)

Gets the associated native input handle.

◆ kzsWindowGetNativeWindowHandle()

NativeWindowHandle kzsWindowGetNativeWindowHandle ( const struct KzsWindow window)

Gets the associated native window handle.

◆ kzsWindowGetNative()

struct KzsWindowNative* kzsWindowGetNative ( const struct KzsWindow window)

Gets the native window.

◆ kzsWindowNativeCreate()

kzsError kzsWindowNativeCreate ( const struct KzsDesktop desktop,
const struct KzsDisplay display,
const struct kanzi::NativeWindowProperties windowPropertiesRequested,
const struct KzsSurfaceConfiguration surfaceConfiguration,
struct kanzi::NativeWindowProperties out_windowProperties,
struct KzsWindowNative **  out_windowNative 
)

Creates a native window.

◆ kzsWindowNativeCreateWrapper()

kzsError kzsWindowNativeCreateWrapper ( NativeWindowHandle  windowHandle,
const struct KzsDesktop desktop,
struct kanzi::NativeWindowProperties out_windowProperties,
struct KzsWindowNative **  out_windowNative 
)

Creates a native window from a native handle.

◆ kzsWindowNativeInitialize()

kzsError kzsWindowNativeInitialize ( struct KzsWindowNative *  windowNative,
struct KzsWindow window 
)

Initializes window.

Called after creating window and native window.

◆ kzsWindowNativeDelete()

kzsError kzsWindowNativeDelete ( struct KzsWindowNative *  windowNative)

Deletes a native window.

◆ kzsWindowNativeResize()

kzsError kzsWindowNativeResize ( struct KzsWindowNative *  windowNative,
kzUint  width,
kzUint  height 
)

Resizes the window, if applicable and supported by the platform.

Native implementation.

◆ kzsWindowNativeSetPositionAbsolute()

kzsError kzsWindowNativeSetPositionAbsolute ( const struct KzsWindowNative *  windowNative,
kzUint  x,
kzUint  y 
)

Sets the absolute position the window, if supported by the platform.

Native implementation.

◆ kzsWindowNativeShow()

kzsError kzsWindowNativeShow ( struct KzsWindowNative *  windowNative)

Makes newly created window visible.

◆ kzsWindowNativeSetTitle()

kzsError kzsWindowNativeSetTitle ( const struct KzsWindowNative *  windowNative,
kzString  titleText 
)

Sets the title bar string for the window, if supported by the platform.

Native implementation.

◆ kzsWindowNativeGetCurrentWidth()

kzUint kzsWindowNativeGetCurrentWidth ( const struct KzsWindowNative *  windowNative)

Gets the width of the window.

◆ kzsWindowNativeGetCurrentHeight()

kzUint kzsWindowNativeGetCurrentHeight ( const struct KzsWindowNative *  windowNative)

Gets the height of the window.

◆ kzsWindowNativeSetOrder()

kzsError kzsWindowNativeSetOrder ( const struct KzsWindowNative *  windowNative,
kzInt  order 
)

Sets the window Z order, if supported by the platform.

◆ kzsWindowLogProperties()

void kzsWindowLogProperties ( const struct KzsWindow window)

Outputs the properties of the window to the log.

◆ kzsWindowNativeGetNativeInputHandle()

NativeInputHandle kzsWindowNativeGetNativeInputHandle ( const struct KzsWindowNative *  windowNative)

Gets the associated native input handle.

◆ kzsWindowNativeGetNativeWindowHandle()

NativeWindowHandle kzsWindowNativeGetNativeWindowHandle ( const struct KzsWindowNative *  windowNative)

Gets the associated native window handle.