kzu_window.h File Reference

Screen container window. More...

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

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

Detailed Description

Screen container window.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

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

Create window object.

kzsError kzuWindowDelete

(

struct KzuWindow *

window)

Delete window.

kzsError kzuWindowUpdate

(

struct KzuWindow *

window)

Synchronizes screen properties to system-dependent window properties.

kzsError kzuWindowPreRender

(

const struct KzuWindow *

window)

Makes window surface active.

kzsError kzuWindowPostRender

(

const struct KzuWindow *

window)

Makes surface changes visible.

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

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

kzsError kzuWindowShow

(

struct KzuWindow *

window)

Makes newly created window visible.

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

Resizes the window.

kzsError kzuWindowSetOrientation	(	struct KzuWindow *	window,
		enum KzsWindowOrientation	orientation
	)

Sets window orientation.

void kzuWindowSetOrientationAngle	(	struct KzuWindow *	window,
		enum KzsWindowOrientationAngle	angle
	)

Sets window orientation angle.

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

Sets system-dependent window object.

struct KzsWindow* kzuWindowGetWindow

(

const struct KzuWindow *

window)

Returns system-dependent window object.

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

Sets canvas of window.

struct KzuCanvas* kzuWindowGetCanvas

(

const struct KzuWindow *

window)

Gets canvas of window.

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.

struct KzsSurface* kzuWindowGetSurface

(

const struct KzuWindow *

window)

Gets surface from window.

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.