aboutsummaryrefslogtreecommitdiff
path: root/src/crepe/api/Texture.h
blob: c33d9e5b3693a64057fc1a25119fd2405b85ce1b (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
#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 <memory>

#include "Asset.h"
#include "Resource.h"
#include "types.h"

namespace crepe {

class Mediator;

/**
 * \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 Resource {

public:
	/**
	 * \brief Constructs a Texture from an Asset resource.
	 * \param src Asset with texture data to load.
	 * \param mediator use the SDLContext reference to load the image
	 */
	Texture(const Asset & src, Mediator & mediator);

	/**
	 * \brief Destroys the Texture instance
	 */
	~Texture();

	/**
	 * \brief get width and height of image in pixels
	 * \return pixel size width and height
	 *
	 */
	const ivec2 & get_size() const noexcept;

	/**
	 * \brief aspect_ratio of image
	 * \return ratio
	 *
	 */
	const float & get_ratio() const noexcept;

	/**
	 * \brief get the image texture
	 * \return SDL_Texture
	 *
	 */
	SDL_Texture * get_img() const noexcept;

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

	// texture size in pixel
	ivec2 size;

	//! ratio of image
	float aspect_ratio;
};

} // namespace crepe