mirror of
https://github.com/luanti-org/luanti.git
synced 2025-08-01 17:38:41 +00:00
108 lines
2.9 KiB
C++
108 lines
2.9 KiB
C++
// Luanti
|
|
// SPDX-License-Identifier: LGPL-2.1-or-later
|
|
// Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
|
|
|
|
#pragma once
|
|
|
|
#include "irrlichttypes.h"
|
|
#include <SColor.h>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
namespace irr::video
|
|
{
|
|
class IImage;
|
|
class ITexture;
|
|
}
|
|
|
|
typedef std::vector<video::SColor> Palette;
|
|
|
|
/*
|
|
TextureSource creates and caches textures.
|
|
*/
|
|
|
|
class ISimpleTextureSource
|
|
{
|
|
public:
|
|
ISimpleTextureSource() = default;
|
|
virtual ~ISimpleTextureSource() = default;
|
|
|
|
/// @brief Generates and gets a texture
|
|
virtual video::ITexture *getTexture(
|
|
const std::string &name, u32 *id = nullptr) = 0;
|
|
};
|
|
|
|
class ITextureSource : public ISimpleTextureSource
|
|
{
|
|
public:
|
|
ITextureSource() = default;
|
|
virtual ~ITextureSource() = default;
|
|
|
|
using ISimpleTextureSource::getTexture;
|
|
|
|
/// @brief Generates and gets ID of a texture
|
|
virtual u32 getTextureId(const std::string &name)=0;
|
|
|
|
/// @brief Returns name of existing texture by ID
|
|
virtual std::string getTextureName(u32 id)=0;
|
|
|
|
/// @brief Returns existing texture by ID
|
|
virtual video::ITexture *getTexture(u32 id)=0;
|
|
|
|
/**
|
|
* @brief Generates and gets a texture
|
|
* Filters will be applied to make the texture suitable for mipmapping and
|
|
* linear filtering during rendering.
|
|
*/
|
|
virtual video::ITexture *getTextureForMesh(
|
|
const std::string &name, u32 *id = nullptr) = 0;
|
|
/**
|
|
* Returns a palette from the given texture name.
|
|
* The pointer is valid until the texture source is
|
|
* destructed.
|
|
* Must be called from the main thread.
|
|
*/
|
|
virtual Palette *getPalette(const std::string &name) = 0;
|
|
|
|
/// @brief Check if given image name exists
|
|
virtual bool isKnownSourceImage(const std::string &name)=0;
|
|
|
|
/// @brief Return average color of a texture string
|
|
virtual video::SColor getTextureAverageColor(const std::string &name)=0;
|
|
|
|
// Note: this method is here because caching is the decision of the
|
|
// API user, even if his access is read-only.
|
|
|
|
/**
|
|
* Enables or disables the caching of finished texture images.
|
|
* This can be useful if you want to call getTextureAverageColor without
|
|
* duplicating work.
|
|
* @note Disabling caching will flush the cache.
|
|
*/
|
|
virtual void setImageCaching(bool enabled) {};
|
|
};
|
|
|
|
class IWritableTextureSource : public ITextureSource
|
|
{
|
|
public:
|
|
IWritableTextureSource() = default;
|
|
virtual ~IWritableTextureSource() = default;
|
|
|
|
/// @brief Fulfil texture requests from other threads
|
|
virtual void processQueue()=0;
|
|
|
|
/**
|
|
* @brief Inserts a source image. Must be called from the main thread.
|
|
* Takes ownership of @p img
|
|
*/
|
|
virtual void insertSourceImage(const std::string &name, video::IImage *img)=0;
|
|
|
|
/**
|
|
* Rebuilds all textures (in case-source images have changed)
|
|
* @note This won't invalidate old ITexture's, but may or may not reuse them.
|
|
* So you have to re-get all textures anyway.
|
|
*/
|
|
virtual void rebuildImagesAndTextures()=0;
|
|
};
|
|
|
|
IWritableTextureSource *createTextureSource();
|