skybox.h File Reference

#include "kresources/kresource_types.h"
#include "math/geometry.h"

Go to the source code of this file.

Data Structures
struct	skybox_config
struct	skybox

Typedefs
typedef struct skybox_config	skybox_config
typedef enum skybox_state	skybox_state
typedef struct skybox	skybox

Enumerations
enum	skybox_state {   SKYBOX_STATE_UNDEFINED , SKYBOX_STATE_CREATED , SKYBOX_STATE_INITIALIZED , SKYBOX_STATE_LOADING ,   SKYBOX_STATE_LOADED }

Functions
KAPI b8	skybox_create (skybox_config config, skybox *out_skybox)
	Attempts to create a skybox using the specified parameters. More...
KAPI b8	skybox_initialize (skybox *sb)
KAPI b8	skybox_load (skybox *sb)
KAPI b8	skybox_unload (skybox *sb)
KAPI void	skybox_destroy (skybox *sb)
	Destroys the provided skybox. More...

Typedef Documentation

skybox

typedef struct skybox skybox

skybox_config

typedef struct skybox_config skybox_config

skybox_state

typedef enum skybox_state skybox_state

Enumeration Type Documentation

skybox_state

enum skybox_state

Enumerator
SKYBOX_STATE_UNDEFINED
SKYBOX_STATE_CREATED
SKYBOX_STATE_INITIALIZED
SKYBOX_STATE_LOADING
SKYBOX_STATE_LOADED

Function Documentation

skybox_create()

KAPI b8 skybox_create	(	skybox_config	config,
		skybox *	out_skybox
	)

Attempts to create a skybox using the specified parameters.

Parameters

config	The configuration to be used when creating the skybox.
out_skybox	A pointer to hold the newly-created skybox.

Returns

True on success; otherwise false.

skybox_destroy()

KAPI void skybox_destroy

(

skybox *

sb

)

Destroys the provided skybox.

Parameters

sb	A pointer to the skybox to be destroyed.

skybox_initialize()

KAPI b8 skybox_initialize

(

skybox *

sb

)

skybox_load()

KAPI b8 skybox_load

(

skybox *

sb

)

skybox_unload()

KAPI b8 skybox_unload

(

skybox *

sb

)