Files
file	at.h
	The libraries public types and functions.
file	at_simulation.h
	AT_Simulation and related functions.

Data Structures
struct	AT_Material
	Holds the material absorption and scattering coefficients. More...
struct	AT_Settings
	The simulation's settings. More...
struct	AT_Simulation
	Groups the necessary simulation data. More...

Functions
AT_Result	AT_simulation_create (AT_Simulation *out_simulation, const AT_Scene scene, const AT_Settings *settings)
	AT_Simulation constructor using defined AT_Settings.
void	AT_simulation_destroy (AT_Simulation *simulation)
	Destroys an allocated AT_Simulation.
AT_Result	AT_simulation_run (AT_Simulation *simulation)
	Starts the simulation.
AT_Result	AT_simulation_create (AT_Simulation *out_simulation, const AT_Scene scene, const AT_Settings *settings)
	AT_Simulation constructor using defined AT_Settings.
void	AT_simulation_destroy (AT_Simulation *simulation)
	Destroys an allocated AT_Simulation.
AT_Result	AT_simulation_run (AT_Simulation *simulation)
	Starts the simulation.

Detailed Description

Function Documentation

◆ AT_simulation_create() [1/2]

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_create() [2/2]

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() [1/2]

void AT_simulation_destroy ( AT_Simulation * simulation )

Destroys an allocated AT_Simulation.

Parameters

simulation Pointer to the simulation data.

◆ AT_simulation_destroy() [2/2]

void AT_simulation_destroy ( AT_Simulation * simulation )

Destroys an allocated AT_Simulation.

Parameters

simulation Pointer to the simulation data.

◆ AT_simulation_run() [1/2]

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.

◆ AT_simulation_run() [2/2]

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.

Files

Data Structures

Functions

Detailed Description

Function Documentation

◆ AT_simulation_create() [1/2]

◆ AT_simulation_create() [2/2]

◆ AT_simulation_destroy() [1/2]

◆ AT_simulation_destroy() [2/2]

◆ AT_simulation_run() [1/2]

◆ AT_simulation_run() [2/2]