shEngine.c File Reference

#include <shengine/shEngine.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <memory.h>
#include <inttypes.h>

Functions
uint8_t	shEngineSetupVulkan (ShEngine *p_engine)
	Sets up Vulkan for the shengine module.
uint8_t	shEngineSafeState (ShEngine *p_engine)
	Safely sets the state of the shengine module.
uint8_t	shSetEngineState (ShEngine *p_engine)
	Sets the state of the shengine module.
uint8_t	shResetEngineState (ShEngine *p_engine)
	Resets the state of the shengine module.
uint8_t	shEngineFrameResize (ShEngine *p_engine)
	Resizes the frame in the shengine module.
uint8_t	shEngineProfilingUpdate (ShEngine *p_engine)
	Updates the profiling in the shengine module.
uint8_t	shEngineVulkanUpdate (ShEngine *p_engine)
	Updates Vulkan in the shengine module.
uint8_t	shEngineUpdateState (ShEngine *p_engine)
	Updates the state of the shengine module.
uint8_t	shEngineManageState (ShEngine *p_engine, uint8_t ready)
	Manages the state of the shengine module.
uint8_t	shEngineVulkanRelease (ShEngine *p_engine)
	Releases Vulkan resources in the shengine module.
uint8_t	shEngineRelease (ShEngine *p_engine)
	Releases resources in the shengine module.
void	shEngineShutdown (ShEngine *p_engine)
	Shuts down the shengine module.

Function Documentation

shEngineFrameResize()

uint8_t shEngineFrameResize

(

ShEngine *

p_engine

)

Resizes the frame in the shengine module.

Parameters

p_engine

Valid pointer to a ShEngine structure.

Returns

Integer status code indicating the success or failure of the operation.

shEngineManageState()

uint8_t shEngineManageState	(	ShEngine *	p_engine,
		uint8_t	ready
	)

Manages the state of the shengine module.

Parameters

p_engine	Valid pointer to a ShEngine structure.
ready	State of the engine.

Returns

Integer status code indicating the success or failure of the operation.

shEngineProfilingUpdate()

uint8_t shEngineProfilingUpdate

(

ShEngine *

p_engine

)

Updates the profiling in the shengine module.

Parameters

p_engine

Valid pointer to a ShEngine structure.

Returns

Integer status code indicating the success or failure of the operation.

shEngineRelease()

uint8_t shEngineRelease

(

ShEngine *

p_engine

)

Releases resources in the shengine module.

Parameters

p_engine

Valid pointer to a ShEngine structure.

shEngineSafeState()

uint8_t shEngineSafeState

(

ShEngine *

p_engine

)

Safely sets the state of the shengine module.

Parameters

p_engine

Valid pointer to a ShEngine structure.

Returns

Integer status code indicating the success or failure of the operation.

shEngineSetupVulkan()

uint8_t shEngineSetupVulkan

(

ShEngine *

p_engine

)

Sets up Vulkan for the shengine module.

Parameters

p_engine

Valid pointer to a ShEngine structure.

Returns

Integer status code indicating the success or failure of the operation.

shEngineShutdown()

void shEngineShutdown

(

ShEngine *

p_engine

)

Shuts down the shengine module.

Parameters

p_engine

Valid pointer to a ShEngine structure.

shEngineUpdateState()

uint8_t shEngineUpdateState

(

ShEngine *

p_engine

)

Updates the state of the shengine module.

Parameters

p_engine

Valid pointer to a ShEngine structure.

Returns

Integer status code indicating the success or failure of the operation.

shEngineVulkanRelease()

uint8_t shEngineVulkanRelease

(

ShEngine *

p_engine

)

Releases Vulkan resources in the shengine module.

Parameters

p_engine

Valid pointer to a ShEngine structure.

Returns

Integer status code indicating the success or failure of the operation.

shEngineVulkanUpdate()

uint8_t shEngineVulkanUpdate

(

ShEngine *

p_engine

)

Updates Vulkan in the shengine module.

Parameters

p_engine

Valid pointer to a ShEngine structure.

Returns

Integer status code indicating the success or failure of the operation.

shResetEngineState()

uint8_t shResetEngineState

(

ShEngine *

p_engine

)

Resets the state of the shengine module.

Parameters

p_engine

Valid pointer to a ShEngine structure.

Returns

Integer status code indicating the success or failure of the operation.

shSetEngineState()

uint8_t shSetEngineState

(

ShEngine *

p_engine

)

Sets the state of the shengine module.

Parameters

p_engine

Valid pointer to a ShEngine structure.

Returns

Integer status code indicating the success or failure of the operation.