kzu_window.h File Reference

Screen container window. More...

#include <system/debug/kzs_error.h>
#include <system/display/kzs_window.h>

Functions
KANZI_API kzsError	kzuWindowCreate (const struct KzcMemoryManager *memoryManager, struct KzsWindow *childWindow, struct KzsSurface *surface, struct KzuCanvas *canvas, struct KzuWindow **out_window)
	Create window object. More...
KANZI_API kzsError	kzuWindowDelete (struct KzuWindow *window)
	Delete window. More...
KANZI_API kzsError	kzuWindowUpdate (struct KzuWindow *window)
	Synchronizes screen properties to system-dependent window properties. More...
KANZI_API kzsError	kzuWindowPreRender (const struct KzuWindow *window)
	Makes window surface active. More...
KANZI_API kzsError	kzuWindowPostRender (const struct KzuWindow *window)
	Makes surface changes visible. More...
KANZI_API kzsError	kzuWindowSetTitle (const struct KzuWindow *window, kzString titleText)
	Sets the title bar string for the window, if any. More...
KANZI_API kzsError	kzuWindowShow (struct KzuWindow *window)
	Makes newly created window visible. More...
KANZI_API kzsError	kzuWindowResize (struct KzuWindow *window, kzUint width, kzUint height)
	Resizes the window. More...
KANZI_API void	kzuWindowSetOrientationAngle (struct KzuWindow *window, enum KzsDisplayOrientationAngle angle)
	Sets window orientation angle. More...
KANZI_API kzsError	kzuWindowSetWindow (struct KzuWindow *window, struct KzsWindow *nativeWindow)
	Sets system-dependent window object. More...
KANZI_API KzsWindow *	kzuWindowGetWindow (const struct KzuWindow *window)
	Returns system-dependent window object. More...
KANZI_API kzsError	kzuWindowSetCanvas (struct KzuWindow *window, struct KzuCanvas *canvas)
	Sets canvas of window. More...
KANZI_API KzuCanvas *	kzuWindowGetCanvas (const struct KzuWindow *window)
	Gets canvas of window. More...
KANZI_API void	kzuWindowSetSurface (struct KzuWindow *window, struct KzsSurface *surface)
	Sets surface from window. More...
KANZI_API KzsSurface *	kzuWindowGetSurface (const struct KzuWindow *window)
	Gets surface from window. More...
KANZI_API kzsError	kzuWindowReadPixels (const struct KzuWindow *window, void *out_pixels)
	Reads pixel data from window surface to out_pixels. More...
KANZI_API void	kzuWindowLogProperties (const struct KzuWindow *window)
	Outputs the properties of the window to the log. More...
KANZI_API void	kzuWindowLogExtensions (const struct KzuWindow *window)
	Outputs the extensions of the window graphics context to the log. More...

Detailed Description

Screen container window.

Copyright 2008-2020 by Rightware. All rights reserved.

Function Documentation

KANZI_API kzsError kzuWindowCreate	(	const struct KzcMemoryManager *	memoryManager,
		struct KzsWindow *	childWindow,
		struct KzsSurface *	surface,
		struct KzuCanvas *	canvas,
		struct KzuWindow **	out_window
	)

Create window object.

KANZI_API kzsError kzuWindowDelete

(

struct KzuWindow *

window

)

Delete window.

KANZI_API kzsError kzuWindowUpdate

(

struct KzuWindow *

window

)

Synchronizes screen properties to system-dependent window properties.

KANZI_API kzsError kzuWindowPreRender

(

const struct KzuWindow *

window

)

Makes window surface active.

KANZI_API kzsError kzuWindowPostRender

(

const struct KzuWindow *

window

)

Makes surface changes visible.

KANZI_API kzsError kzuWindowSetTitle	(	const struct KzuWindow *	window,
		kzString	titleText
	)

Sets the title bar string for the window, if any.

KANZI_API kzsError kzuWindowShow

(

struct KzuWindow *

window

)

Makes newly created window visible.

KANZI_API kzsError kzuWindowResize	(	struct KzuWindow *	window,
		kzUint	width,
		kzUint	height
	)

Resizes the window.

KANZI_API void kzuWindowSetOrientationAngle	(	struct KzuWindow *	window,
		enum KzsDisplayOrientationAngle	angle
	)

Sets window orientation angle.

KANZI_API kzsError kzuWindowSetWindow	(	struct KzuWindow *	window,
		struct KzsWindow *	nativeWindow
	)

Sets system-dependent window object.

KANZI_API KzsWindow* kzuWindowGetWindow

(

const struct KzuWindow *

window

)

Returns system-dependent window object.

KANZI_API kzsError kzuWindowSetCanvas	(	struct KzuWindow *	window,
		struct KzuCanvas *	canvas
	)

Sets canvas of window.

KANZI_API KzuCanvas* kzuWindowGetCanvas

(

const struct KzuWindow *

window

)

Gets canvas of window.

KANZI_API void kzuWindowSetSurface	(	struct KzuWindow *	window,
		struct KzsSurface *	surface
	)

Sets surface from window.

Useful if created empty window that doesn't contain surface in the beginning.

KANZI_API KzsSurface* kzuWindowGetSurface

(

const struct KzuWindow *

window

)

Gets surface from window.

KANZI_API kzsError kzuWindowReadPixels	(	const struct KzuWindow *	window,
		void *	out_pixels
	)

Reads pixel data from window surface to out_pixels.

out_pixels must be preallocated to correct size.

KANZI_API void kzuWindowLogProperties

(

const struct KzuWindow *

window

)

Outputs the properties of the window to the log.

KANZI_API void kzuWindowLogExtensions

(

const struct KzuWindow *

window

)

Outputs the extensions of the window graphics context to the log.