aboutsummaryrefslogtreecommitdiff
path: root/src/crepe/api/Texture.h
blob: b89bc17e1846fa962c0d238cd214dc026ac2b6da (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
#pragma once

// FIXME: this header can't be included because this is an API header, and SDL2
// development headers won't be bundled with crepe. Why is this facade in the
// API namespace?

#include <SDL2/SDL_render.h>
#include <functional>
#include <memory>

#include "Asset.h"

namespace crepe {

class SDLContext;
class Animator;

/**
 * \class Texture
 * \brief Manages texture loading and properties.
 *
 * The Texture class is responsible for loading an image from a source
 * and providing access to its dimensions. Textures can be used for rendering.
 */
class Texture {

public:
	/**
	 * \brief Constructs a Texture from a file path.
	 * \param src Path to the image file to be loaded as a texture.
	 */
	Texture(const char * src);

	/**
	 * \brief Constructs a Texture from an Asset resource.
	 * \param res Unique pointer to an Asset resource containing texture data.
	 */
	Texture(std::unique_ptr<Asset> res);

	/**
	 * \brief Destroys the Texture instance, freeing associated resources.
	 */
	~Texture();
	// FIXME: this constructor shouldn't be necessary because this class doesn't
	// manage memory

	/**
	 * \brief Gets the width of the texture.
	 * \return Width of the texture in pixels.
	 */
	int get_width() const;

	/**
	 * \brief Gets the height of the texture.
	 * \return Height of the texture in pixels.
	 */
	int get_height() const;

private:
	/**
	 * \brief Loads the texture from an Asset resource.
	 * \param res Unique pointer to an Asset resource to load the texture from.
	 */
	void load(std::unique_ptr<Asset> res);

private:
	//! The texture of the class from the library
	std::unique_ptr<SDL_Texture, std::function<void(SDL_Texture *)>> texture;

	//! Grants SDLContext access to private members.
	friend class SDLContext;

	//! Grants Animator access to private members.
	friend class Animator;
};

} // namespace crepe