shWindow.c File Reference

#include "shengine/shWindow.h"
#include "shengine/shEngine.h"
#include <stdio.h>
#include <stdlib.h>

Functions
uint8_t	shWindowSetup (const char *title, ShWindow *p_window)
	Sets up a window in the shengine framework.
uint8_t	shClearWindow (ShWindow *p_window)
	Clears the contents of a window in the shengine framework.
uint8_t	shWindowCreateSurface (ShEngine *p_engine)
	Creates a surface for the shengine module using the window.
uint8_t	shUpdateInput (ShWindow *p_window)
	Updates input for the specified window.
uint8_t	shGetWindowSize (ShWindow *p_window)
	Retrieves the size of the specified window.
uint8_t	shUpdateWindow (ShEngine *p_engine)
	Updates the specified window within the shengine module.

Function Documentation

shClearWindow()

uint8_t shClearWindow

(

ShWindow *

p_window

)

Clears the contents of a window in the shengine framework.

Parameters

p_window

Valid pointer to a ShWindow structure.

Returns

1 on success, 0 on failure.

shGetWindowSize()

uint8_t shGetWindowSize

(

ShWindow *

p_window

)

Retrieves the size of the specified window.

The shGetWindowSize function retrieves the size of the specified ShWindow.

Parameters

p_window

Pointer to the ShWindow structure to get the size.

Returns

An integer indicating the success (1) or failure (0) of retrieving the window size.

shUpdateInput()

uint8_t shUpdateInput

(

ShWindow *

p_window

)

Updates input for the specified window.

The shUpdateInput function updates input for the specified ShWindow.

Parameters

p_window

Pointer to the ShWindow structure to update input.

Returns

An integer indicating the success (1) or failure (0) of updating input.

shUpdateWindow()

uint8_t shUpdateWindow

(

ShEngine *

p_engine

)

Updates the specified window within the shengine module.

The shUpdateWindow function updates the specified ShWindow within shengine module.

Parameters

p_engine

Pointer to a valid ShEngine structure.

Returns

An integer indicating the success (1) or failure (0) of updating the window.

shWindowCreateSurface()

uint8_t shWindowCreateSurface

(

ShEngine *

p_engine

)

Creates a surface for the shengine module using the window.

The shWindowCreateSurface function creates a surface for the shengine module using the window.

Parameters

p_engine

Pointer to a valid ShEngine structure.

Returns

An integer indicating the success (1) or failure (0) of creating the window surface.

shWindowSetup()

uint8_t shWindowSetup	(	const char *	title,
		ShWindow *	p_window
	)

Sets up a window in the shengine framework.

Parameters

title	Title of the window.
p_window	Valid pointer to a ShWindow structure.

Returns

1 on success, 0 on failure.