anki-3d-engine/AnKi/Resource/ImageAtlasResource.h

// Copyright (C) 2009-2021, Panagiotis Christopoulos Charitos and contributors.
// All rights reserved.
// Code licensed under the BSD License.
// http://www.anki3d.org/LICENSE

#pragma once

#include <AnKi/Resource/ResourceObject.h>
#include <AnKi/Resource/ImageResource.h>
#include <AnKi/Gr.h>

namespace anki {

/// @addtogroup resource
/// @{

/// Image atlas resource class.
///
/// XML format:
/// @code
/// <imageAtlas>
/// 	<image>path/to/tex.ankitex</image>
/// 	<subImageMargin>N</subImageMargin>
/// 	<subImages>
/// 		<subImage>
/// 			<name>name</name>
/// 			<uv>0.1 0.2 0.5 0.6</uv>
/// 		</subImage>
/// 		<subImage>...</subImage>
/// 		...
/// 	</subImages>
/// </imageAtlas>
/// @endcode
class ImageAtlasResource : public ResourceObject
{
public:
	ImageAtlasResource(ResourceManager* manager);

	~ImageAtlasResource();

	/// Load the atlas.
	ANKI_USE_RESULT Error load(const ResourceFilename& filename, Bool async);

	TexturePtr getTexture() const
	{
		return m_image->getTexture();
	}

	TextureViewPtr getTextureView() const
	{
		return m_image->getTextureView();
	}

	U32 getWidth() const
	{
		return m_size[0];
	}

	U32 getHeight() const
	{
		return m_size[1];
	}

	U32 getSubImageMargin() const
	{
		return m_margin;
	}

	/// Get the UV coordinates of a sub image.
	ANKI_USE_RESULT Error getSubImageInfo(CString name, F32 uv[4]) const;

private:
	class SubTex
	{
	public:
		CString m_name; ///< Points to ImageAtlas::m_subTexNames.
		Array<F32, 4> m_uv;
	};

	ImageResourcePtr m_image;
	DynamicArray<char> m_subTexNames;
	DynamicArray<SubTex> m_subTexes;
	Array<U32, 2> m_size;
	U32 m_margin = 0;
};
/// @}

} // end namespace anki