shScene.h File Reference

Handling scenes in the shengine framework. More...

#include <stdint.h>

Go to the source code of this file.

Typedefs
typedef struct ShEngine	ShEngine
typedef struct ShIdentity	ShIdentity
typedef struct ShCamera	ShCamera
typedef struct ShTransform	ShTransform
typedef struct ShHostMemoryLinker	ShHostMemoryLinker
typedef struct ShSceneProperties	ShSceneProperties

Functions
uint8_t	shSceneInit (ShEngine *p_engine)
	Initializes the scene in the shengine framework.
uint8_t	shUpdateTransform (ShTransform *p_transform)
	Updates the transform in the shengine framework.
uint8_t	shUpdateCamera (ShEngine *p_engine, ShTransform *p_transform, ShCamera *p_camera)
	Updates the camera in the shengine framework.
uint8_t	shSceneUpdate (ShEngine *p_engine)
	Updates the scene in the shengine framework.
uint8_t	shEndScene (ShEngine *p_engine)
	Ends the scene in the shengine framework.

Detailed Description

Handling scenes in the shengine framework.

The shScene.h file contains structures and functions related to handling scenes in the shengine framework.

Typedef Documentation

ShCamera

typedef struct ShCamera ShCamera

ShEngine

typedef struct ShEngine ShEngine

ShHostMemoryLinker

typedef struct ShHostMemoryLinker ShHostMemoryLinker

ShIdentity

typedef struct ShIdentity ShIdentity

ShSceneProperties

typedef struct ShSceneProperties ShSceneProperties

ShTransform

typedef struct ShTransform ShTransform

Function Documentation

shEndScene()

uint8_t shEndScene ( ShEngine *  p_engine )

extern

Ends the scene in the shengine framework.

Parameters

p_engine

Pointer to a valid ShEngine structure.

Returns

1 on success, 0 on failure.

shSceneInit()

uint8_t shSceneInit ( ShEngine *  p_engine )

extern

Initializes the scene in the shengine framework.

Parameters

p_engine

Pointer to a valid ShEngine structure.

Returns

1 on success, 0 on failure.

shSceneUpdate()

uint8_t shSceneUpdate ( ShEngine *  p_engine )

extern

Updates the scene in the shengine framework.

Parameters

p_engine

Pointer to a valid ShEngine structure.

Returns

1 on success, 0 on failure.

shUpdateCamera()

uint8_t shUpdateCamera ( ShEngine *  p_engine, ShTransform *  p_transform, ShCamera *  p_camera  )

extern

Updates the camera in the shengine framework.

Parameters

p_engine	Pointer to a valid ShEngine structure.
p_transform	Pointer to a valid ShTransform structure.
p_camera	Pointer to a valid ShCamera structure.

Returns

1 on success, 0 on failure.

shUpdateTransform()

uint8_t shUpdateTransform ( ShTransform *  p_transform )

extern

Updates the transform in the shengine framework.

Parameters

p_transform

Pointer to a valid ShTransform structure.

Returns

1 on success, 0 on failure.