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

// Copyright (C) 2009-present, 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/Gr.h>

namespace anki {

/// @addtogroup resource
/// @{

ANKI_CVAR(NumericCVar<U32>, Rsrc, MaxImageSize, 1024u * 1024u, 4u, kMaxU32, "Max image size to load")

/// Image resource class. It loads or creates an image and then loads it in the GPU. It supports compressed and uncompressed TGAs, PNGs, JPEG and
/// AnKi's image format.
class ImageResource : public ResourceObject
{
public:
	ImageResource(CString fname, U32 uuid)
		: ResourceObject(fname, uuid)
	{
	}

	~ImageResource();

	/// Load an image.
	Error load(const ResourceFilename& filename, Bool async);

	/// Get the texture.
	Texture& getTexture() const
	{
		return *m_tex;
	}

	U32 getWidth() const
	{
		ANKI_ASSERT(m_size.x());
		return m_size.x();
	}

	U32 getHeight() const
	{
		ANKI_ASSERT(m_size.y());
		return m_size.y();
	}

	U32 getDepth() const
	{
		ANKI_ASSERT(m_size.z());
		return m_size.z();
	}

	U32 getLayerCount() const
	{
		ANKI_ASSERT(m_layerCount);
		return m_layerCount;
	}

	Vec4 getAverageColor() const
	{
		return m_avgColor;
	}

private:
	static constexpr U32 kMaxCopiesBeforeFlush = 4;

	class TexUploadTask;
	class LoadingContext;

	TexturePtr m_tex;
	UVec3 m_size = UVec3(0u);
	U32 m_layerCount = 0;

	Vec4 m_avgColor = Vec4(0.0f);

	[[nodiscard]] static Error load(LoadingContext& ctx);
};
/// @}

} // end namespace anki