asw::assets Namespace Reference

Functions
std::string	get_path (const std::string &filename)
	Get the full path to an asset given its filename. This assumes that all assets are located in an "assets" directory relative to the base path of the application. This will abort if the base path cannot be determined.
asw::Texture	load_texture (const std::string &filename)
	Loads a texture from a file. Formats supported are PNG, ICO, CUR, BMP, GIF, JPG, LBM, PCX, PNM, TIF, XCF, XPM, XV, and WEBP. This will abort if the file is not found.
asw::Texture	load_texture (const std::string &filename, const std::string &key)
	Load a texture from a file and cache it.
asw::Texture	get_texture (const std::string &key)
	Get a cached texture.
void	unload_texture (const std::string &key)
	Remove a cached texture.
asw::Texture	create_texture (int w, int h)
	Create a Texture given the specified dimensions.
asw::Font	load_font (const std::string &filename, float size)
	Loads a TTF font from a file. This will abort if the file is not found.
asw::Font	load_font (const std::string &filename, float size, const std::string &key)
	Load a font from a file and cache it.
asw::Font	get_font (const std::string &key)
	Get a cached font.
void	unload_font (const std::string &key)
	Remove a cached font.
asw::Sample	load_sample (const std::string &filename)
	Loads a sample from a file. Formats supported are WAV, AIFF, RIFF, OGG and VOC. This will abort if the file is not found.
asw::Sample	load_sample (const std::string &filename, const std::string &key)
	Load a sample from a file and cache it.
asw::Sample	get_sample (const std::string &key)
	Get a cached sample.
void	unload_sample (const std::string &key)
	Remove a cached sample.
asw::Music	load_music (const std::string &filename)
	Loads a music file from a file. Formats supported are WAV, AIFF, RIFF, OGG and VOC. This will abort if the file is not found.
asw::Music	load_music (const std::string &filename, const std::string &key)
	Load a music file from a file and cache it.
asw::Music	get_music (const std::string &key)
	Get a cached music.
void	unload_music (const std::string &key)
	Remove a cached music.
void	clear_all ()
	Clear all cached assets. This will remove all cached textures, fonts, samples, and music.

Function Documentation

clear_all()

void asw::assets::clear_all

(

)

Clear all cached assets. This will remove all cached textures, fonts, samples, and music.

Definition at line 237 of file assets.cpp.

create_texture()

asw::Texture asw::assets::create_texture	(	int	w,
		int	h )

Create a Texture given the specified dimensions.

Parameters

w	The width of the texture.
h	The height of the texture.

Returns

The created Texture object.

Definition at line 84 of file assets.cpp.

get_font()

asw::Font asw::assets::get_font

(

const std::string &

key

)

Get a cached font.

Parameters

key	The key of the cached font.

Returns

The cached Font object.

Definition at line 135 of file assets.cpp.

get_music()

asw::Music asw::assets::get_music

(

const std::string &

key

)

Get a cached music.

Parameters

key	The key of the cached music.

Returns

The cached Music object.

Definition at line 221 of file assets.cpp.

get_path()

std::string asw::assets::get_path

(

const std::string &

filename

)

Get the full path to an asset given its filename. This assumes that all assets are located in an "assets" directory relative to the base path of the application. This will abort if the base path cannot be determined.

Parameters

filename

Returns

The full path to the asset.

Definition at line 24 of file assets.cpp.

get_sample()

asw::Sample asw::assets::get_sample

(

const std::string &

key

)

Get a cached sample.

Parameters

key	The key of the cached sample.

Returns

The cached Sample object.

Definition at line 178 of file assets.cpp.

get_texture()

asw::Texture asw::assets::get_texture

(

const std::string &

key

)

Get a cached texture.

Parameters

key	The key of the cached texture.

Returns

The cached Texture object.

Definition at line 70 of file assets.cpp.

load_font() [1/2]

asw::Font asw::assets::load_font	(	const std::string &	filename,
		float	size )

Loads a TTF font from a file. This will abort if the file is not found.

Parameters

filename	The path to the font file.
size	The size of the font.

Returns

The loaded Font object.

Definition at line 106 of file assets.cpp.

load_font() [2/2]

asw::Font asw::assets::load_font	(	const std::string &	filename,
		float	size,
		const std::string &	key )

Load a font from a file and cache it.

Parameters

filename	The path to the font file.
size	The size of the font.
key	The key to associate with the loaded font for caching.

Returns

The loaded Font object.

Definition at line 124 of file assets.cpp.

load_music() [1/2]

asw::Music asw::assets::load_music

(

const std::string &

filename

)

Loads a music file from a file. Formats supported are WAV, AIFF, RIFF, OGG and VOC. This will abort if the file is not found.

Parameters

filename

The path to the music file.

Returns

The loaded Music object.

Definition at line 194 of file assets.cpp.

load_music() [2/2]

asw::Music asw::assets::load_music	(	const std::string &	filename,
		const std::string &	key )

Load a music file from a file and cache it.

Parameters

filename	The path to the music file.
key	The key to associate with the loaded music for caching.

Returns

The loaded Music object.

Definition at line 210 of file assets.cpp.

load_sample() [1/2]

asw::Sample asw::assets::load_sample

(

const std::string &

filename

)

Loads a sample from a file. Formats supported are WAV, AIFF, RIFF, OGG and VOC. This will abort if the file is not found.

Parameters

filename

The path to the sample file.

Returns

The loaded Sample object.

Definition at line 151 of file assets.cpp.

load_sample() [2/2]

asw::Sample asw::assets::load_sample	(	const std::string &	filename,
		const std::string &	key )

Load a sample from a file and cache it.

Parameters

filename	The path to the sample file.
key	The key to associate with the loaded sample for caching.

Returns

The loaded Sample object.

Definition at line 167 of file assets.cpp.

load_texture() [1/2]

asw::Texture asw::assets::load_texture

(

const std::string &

filename

)

Loads a texture from a file. Formats supported are PNG, ICO, CUR, BMP, GIF, JPG, LBM, PCX, PNM, TIF, XCF, XPM, XV, and WEBP. This will abort if the file is not found.

Parameters

filename

The path to the texture file.

Returns

A Texture object that will automatically free the underlying SDL_Texture when it goes out of scope.

Definition at line 37 of file assets.cpp.

load_texture() [2/2]

asw::Texture asw::assets::load_texture	(	const std::string &	filename,
		const std::string &	key )

Load a texture from a file and cache it.

Parameters

filename	The path to the texture file.
key	The key to associate with the loaded texture for caching.

Returns

A Texture object that will automatically free the underlying SDL_Texture when it goes out of scope.

Definition at line 59 of file assets.cpp.

unload_font()

void asw::assets::unload_font

(

const std::string &

key

)

Remove a cached font.

Parameters

key	The key of the cached font to remove.

Definition at line 144 of file assets.cpp.

unload_music()

void asw::assets::unload_music

(

const std::string &

key

)

Remove a cached music.

Parameters

key	The key of the cached music to remove.

Definition at line 230 of file assets.cpp.

unload_sample()

void asw::assets::unload_sample

(

const std::string &

key

)

Remove a cached sample.

Parameters

key	The key of the cached sample to remove.

Definition at line 187 of file assets.cpp.

unload_texture()

void asw::assets::unload_texture

(

const std::string &

key

)

Remove a cached texture.

Parameters

key	The key of the cached texture to remove.

Definition at line 79 of file assets.cpp.