CoriEngine
Loading...
Searching...
No Matches
Cori::Graphics::SpriteAtlas::Descriptor Class Reference

SpriteAtlas Descriptor meant to be used with AssetManager only. More...

#include <SpriteAtlas.hpp>

Classes

struct  Hasher

Public Types

using AssetType = SpriteAtlas

Public Member Functions

constexpr Descriptor (std::string name, std::filesystem::path imagePath, const glm::uvec2 spriteResolution) noexcept
 Constructs a descriptor.
uint32_t GetRuntimeID () const
constexpr bool operator== (const Descriptor &other) const noexcept

Public Attributes

const std::filesystem::path m_TexturePath
const glm::uvec2 m_SpriteResolution
const std::string m_Name

Detailed Description

SpriteAtlas Descriptor meant to be used with AssetManager only.

Definition at line 17 of file SpriteAtlas.hpp.

Member Typedef Documentation

◆ AssetType

using Cori::Graphics::SpriteAtlas::Descriptor::AssetType = SpriteAtlas

Definition at line 33 of file SpriteAtlas.hpp.

Constructor & Destructor Documentation

◆ Descriptor()

Cori::Graphics::SpriteAtlas::Descriptor::Descriptor ( std::string name,
std::filesystem::path imagePath,
const glm::uvec2 spriteResolution )
inlineconstexprnoexcept

Constructs a descriptor.

Parameters
nameName to be used assigned to SpriteAtlas.
imagePathPath to the image that will be used to create the SpriteAtlas.
spriteResolutionResolution of one sprite in an atlas.
Note
Total image size should be divisible by spriteResolution without a remainder.

Definition at line 26 of file SpriteAtlas.hpp.

Member Function Documentation

◆ GetRuntimeID()

uint32_t Cori::Graphics::SpriteAtlas::Descriptor::GetRuntimeID ( ) const
inlinenodiscard

Definition at line 35 of file SpriteAtlas.hpp.

◆ operator==()

bool Cori::Graphics::SpriteAtlas::Descriptor::operator== ( const Descriptor & other) const
inlineconstexprnoexcept

Definition at line 37 of file SpriteAtlas.hpp.

Here is the call graph for this function:

Member Data Documentation

◆ m_Name

const std::string Cori::Graphics::SpriteAtlas::Descriptor::m_Name

Definition at line 49 of file SpriteAtlas.hpp.

◆ m_SpriteResolution

const glm::uvec2 Cori::Graphics::SpriteAtlas::Descriptor::m_SpriteResolution

Definition at line 48 of file SpriteAtlas.hpp.

◆ m_TexturePath

const std::filesystem::path Cori::Graphics::SpriteAtlas::Descriptor::m_TexturePath

Definition at line 47 of file SpriteAtlas.hpp.

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