at.h File Reference

The libraries public types and functions. More...

#include "acoustic/at_math.h"
#include <stdint.h>
#include <stddef.h>

Go to the source code of this file.

Data Structures
struct	AT_Material
	Holds the material absorption and scattering coefficients. More...
struct	AT_Source
	Groups the information required for the sound source. More...
struct	AT_SceneConfig
	Groups the scene config settings together. More...
struct	AT_Settings
	The simulation's settings. More...

Enumerations
enum	AT_Result { AT_OK = 0 , AT_ERR_INVALID_ARGUMENT , AT_ERR_ALLOC_ERROR , AT_ERR_NETWORK_FAILURE }
	Defines possible result types. More...
enum	AT_MaterialType
	Defines possible material types.

Functions
AT_Result	AT_model_create (AT_Model **out_model, const char *filepath)
	AT_Model constructor for a given glb filepath.
void	AT_model_destroy (AT_Model *model)
	Destroys an allocated AT_Model.
void	AT_model_to_AABB (AT_AABB *out_aabb, const AT_Model *model)
	Calculates the min and max of a model for AABB collision.
void	AT_scene_destroy (AT_Scene *scene)
	Destroys an allocated AT_Scene.
AT_Result	AT_simulation_create (AT_Simulation **out_simulation, const AT_Scene *scene, const AT_Settings *settings)
	AT_Simulation constructor using defined AT_Settings.
AT_Result	AT_simulation_run (AT_Simulation *simulation)
	Starts the simulation.
void	AT_simulation_destroy (AT_Simulation *simulation)
	Destroys an allocated AT_Simulation.

Detailed Description

The libraries public types and functions.

Function Documentation

AT_model_create()

AT_Result AT_model_create	(	AT_Model **	out_model,
		const char *	filepath )

AT_Model constructor for a given glb filepath.

Parameters

out_model	Pointer to an empty initialised AT_Model.
filepath	String showing the location of the file.

Return values

AT_Result

Saves the created model at the location of the pointer, returning a result enum value.

AT_model_destroy()

void AT_model_destroy

(

AT_Model *

model

)

Destroys an allocated AT_Model.

Parameters

Model

Pointer to an initialised AT_Model.

AT_model_to_AABB()

void AT_model_to_AABB	(	AT_AABB *	out_aabb,
		const AT_Model *	model )

Calculates the min and max of a model for AABB collision.

Parameters

out_aabb	Pointer to an empty initialised AT_AABB.
Model	Pointer to the model.

AT_scene_destroy()

void AT_scene_destroy

(

AT_Scene *

scene

)

Destroys an allocated AT_Scene.

Parameters

Scene

Pointer to an initialised AT_Scene.

AT_simulation_create()

AT_Result AT_simulation_create	(	AT_Simulation **	out_simulation,
		const AT_Scene *	scene,
		const AT_Settings *	settings )

AT_Simulation constructor using defined AT_Settings.

Parameters

out_simulation	Pointer to an empty initialised AT_Simulation.
Scene	Pointer to the simulation's scene data.
settings	Pointer to the simulation settings.

Return values

AT_Result

Saves the simulation at the pointer, returning a result enum value.

AT_simulation_destroy()

void AT_simulation_destroy

(

AT_Simulation *

simulation

)

Destroys an allocated AT_Simulation.

Parameters

simulation

Pointer to the simulation data.

AT_simulation_run()

AT_Result AT_simulation_run

(

AT_Simulation *

simulation

)

Starts the simulation.

Parameters

simulation

Pointer to the simulation.

Return values

AT_Result

A result enum value which must be checked for errors.