Muto::SubTexture2D Class Reference

Represents a sub-region of a 2D texture, useful for sprite sheets. More...

#include <SubTexture2D.h>

Public Member Functions
glm::vec2 *	GetTexCoords ()
	Returns the texture coordinates of the sub-texture.
const Ref< Texture2D >	GetTexture ()
	Returns the underlying texture of the sub-texture.
	SubTexture2D (const Ref< Texture2D > &texture, const glm::vec2 &min, const glm::vec2 &max)
	Constructs a SubTexture2D from the given texture and texture coordinates.

Static Public Member Functions
static Ref< SubTexture2D >	CreateFromCoords (const Ref< Texture2D > &texture, const glm::vec2 &coords, const glm::vec2 &cellSize, const glm::vec2 &spriteSize={1, 1})
	Creates a SubTexture2D from a grid of cells within the given texture.

Private Attributes
glm::vec2	m_TexCoords [4]
	The texture coordinates of the sub-texture.
Ref< Texture2D >	m_Texture
	The underlying texture of the sub-texture.

Detailed Description

Represents a sub-region of a 2D texture, useful for sprite sheets.

Constructor & Destructor Documentation

SubTexture2D()

Muto::SubTexture2D::SubTexture2D	(	const Ref< Texture2D > &	texture,
		const glm::vec2 &	min,
		const glm::vec2 &	max
	)

Constructs a SubTexture2D from the given texture and texture coordinates.

Parameters

texture	The texture from which the sub-texture is derived.
min	The minimum texture coordinates (bottom-left).
max	The maximum texture coordinates (top-right).

        : m_Texture(texture)
    {
        m_TexCoords[0] = { min.x, min.y };
        m_TexCoords[1] = { max.x, min.y };
        m_TexCoords[2] = { max.x, max.y };
        m_TexCoords[3] = { min.x, max.y };
    }

References SubTexture2D().

Referenced by SubTexture2D().

Member Function Documentation

CreateFromCoords()

Ref< SubTexture2D > Muto::SubTexture2D::CreateFromCoords ( const Ref< Texture2D > &  texture, const glm::vec2 &  coords, const glm::vec2 &  cellSize, const glm::vec2 &  spriteSize = {1, 1}  )

static

Creates a SubTexture2D from a grid of cells within the given texture.

Parameters

texture	The texture from which the sub-texture is derived.
coords	The coordinates of the cell in the grid.
cellSize	The size of each cell in the grid.
spriteSize	The size of the sprite in cells (default is 1x1).

    {
        glm::vec2 min = { (coords.x * cellSize.x) / texture->GetWidth(), (coords.y * cellSize.y) / texture->GetHeight() };
        glm::vec2 max = { ((coords.x + spriteSize.x) * cellSize.x) / texture->GetWidth(), ((coords.y + spriteSize.y) * cellSize.y) / texture->GetHeight() };
 
        return CreateRef<SubTexture2D>(texture, min, max);
    }

GetTexCoords()

glm::vec2 * Muto::SubTexture2D::GetTexCoords ( )

inline

Returns the texture coordinates of the sub-texture.

{ return m_TexCoords; }

GetTexture()

const Ref< Texture2D > Muto::SubTexture2D::GetTexture ( )

inline

Returns the underlying texture of the sub-texture.

{ return m_Texture; }

Member Data Documentation

m_TexCoords

glm::vec2 Muto::SubTexture2D::m_TexCoords[4]

private

The texture coordinates of the sub-texture.

m_Texture

Ref<Texture2D> Muto::SubTexture2D::m_Texture

private

The underlying texture of the sub-texture.

---

The documentation for this class was generated from the following files:

• Muto/src/Renderer/SubTexture2D.h
• Muto/src/Renderer/SubTexture2D.cpp