debug_grid.h File Reference

#include "defines.h"
#include "math/math_types.h"
#include "resources/resource_types.h"

Go to the source code of this file.

Data Structures
struct	debug_grid_config
struct	debug_grid

Typedefs
typedef enum debug_grid_orientation	debug_grid_orientation
typedef struct debug_grid_config	debug_grid_config
typedef struct debug_grid	debug_grid

Enumerations
enum	debug_grid_orientation { DEBUG_GRID_ORIENTATION_XZ = 0 , DEBUG_GRID_ORIENTATION_XY = 1 , DEBUG_GRID_ORIENTATION_YZ = 2 }

Functions
KAPI b8	debug_grid_create (const debug_grid_config *config, debug_grid *out_grid)
KAPI void	debug_grid_destroy (debug_grid *grid)
KAPI b8	debug_grid_initialize (debug_grid *grid)
KAPI b8	debug_grid_load (debug_grid *grid)
KAPI b8	debug_grid_unload (debug_grid *grid)
KAPI b8	debug_grid_update (debug_grid *grid)

Typedef Documentation

debug_grid

typedef struct debug_grid debug_grid

debug_grid_config

typedef struct debug_grid_config debug_grid_config

debug_grid_orientation

typedef enum debug_grid_orientation debug_grid_orientation

Enumeration Type Documentation

debug_grid_orientation

enum debug_grid_orientation

Enumerator
DEBUG_GRID_ORIENTATION_XZ	A grid that lies "flat" in the world along the ground plane (y-plane). This is the default configuration.
DEBUG_GRID_ORIENTATION_XY	A grid that lies on the z-plane (facing the screen by default, orthogonal to the ground plane).
DEBUG_GRID_ORIENTATION_YZ	A grid that lies on the x-plane (orthogonal to the default screen plane and the ground plane).

Function Documentation

debug_grid_create()

KAPI b8 debug_grid_create	(	const debug_grid_config *	config,
		debug_grid *	out_grid
	)

debug_grid_destroy()

KAPI void debug_grid_destroy

(

debug_grid *

grid

)

debug_grid_initialize()

KAPI b8 debug_grid_initialize

(

debug_grid *

grid

)

debug_grid_load()

KAPI b8 debug_grid_load

(

debug_grid *

grid

)

debug_grid_unload()

KAPI b8 debug_grid_unload

(

debug_grid *

grid

)

debug_grid_update()

KAPI b8 debug_grid_update

(

debug_grid *

grid

)