class EE::Graphics::TextureFactory¶

Overview¶

The Texture Manager Class. Here we do all the textures stuff. (Singleton Class) More…

#include <texturefactory.hpp>

class TextureFactory: protected EE::System::Mutex {
public:
    // structs

    struct LiveTextureRecord;
    struct TextureDeleter;

    // construction

    ~TextureFactory();

    // methods

    Texture* createEmptyTexture(
        const unsigned int& Width,
        const unsigned int& Height,
        const unsigned int& Channels = 4,
        const Color& DefaultColor = Color(0, 0, 0, 255),
        const bool& Mipmap = false,
        const Texture::ClampMode& ClampMode = Texture::ClampMode::ClampToEdge,
        const bool& CompressTexture = false,
        const bool& KeepLocalCopy = false,
        const std::string& Filename = std::string("")
    );

    Texture* loadFromPixels(
        const unsigned char* Pixels,
        const unsigned int& Width,
        const unsigned int& Height,
        const unsigned int& Channels,
        const bool& Mipmap = false,
        const Texture::ClampMode& ClampMode = Texture::ClampMode::ClampToEdge,
        const bool& CompressTexture = false,
        const bool& KeepLocalCopy = false,
        const std::string& FileName = std::string("")
    );

    Texture* loadFromPack(
        Pack* Pack,
        const std::string& FilePackPath,
        const bool& Mipmap = false,
        const Texture::ClampMode& ClampMode = Texture::ClampMode::ClampToEdge,
        const bool& CompressTexture = false,
        const bool& KeepLocalCopy = false,
        const Image::FormatConfiguration& imageformatConfiguration = Image::FormatConfiguration()
    );

    Texture* loadFromMemory(
        const unsigned char* ImagePtr,
        const unsigned int& Size,
        const bool& Mipmap = false,
        const Texture::ClampMode& ClampMode = Texture::ClampMode::ClampToEdge,
        const bool& CompressTexture = false,
        const bool& KeepLocalCopy = false,
        const Image::FormatConfiguration& imageformatConfiguration = Image::FormatConfiguration()
    );

    Texture* loadFromStream(IOStream& Stream, const bool& Mipmap = false, const Texture::ClampMode& ClampMode = Texture::ClampMode::ClampToEdge, const bool& CompressTexture = false, const bool& KeepLocalCopy = false, const Image::FormatConfiguration& imageformatConfiguration = Image::FormatConfiguration());
    Texture* loadFromFile(const std::string& Filepath, const bool& Mipmap = false, const Texture::ClampMode& ClampMode = Texture::ClampMode::ClampToEdge, const bool& CompressTexture = false, const bool& KeepLocalCopy = false, const Image::FormatConfiguration& imageformatConfiguration = Image::FormatConfiguration());
    bool remove(ResourceId textureId);
    bool remove(Texture* texture);
    void bind(ResourceId textureId, Texture::CoordinateType coordinateType = Texture::CoordinateType::Normalized, const Uint32& textureUnit = 0, const bool& forceRebind = false);
    void bind(const Texture* Tex, Texture::CoordinateType coordinateType = Texture::CoordinateType::Normalized, const Uint32& TextureUnit = 0, const bool& forceRebind = false);
    int getCurrentTexture(const Uint32& TextureUnit = 0) const;
    void setCurrentTexture(const int& textureHandle, const Uint32& TextureUnit);
    Uint32 getTextureCount();
    std::vector<Texture*> getTextures();
    TextureRegistrySnapshot snapshotTextures();
    void purgeExpiredTextures();
    Uint64 getLiveTextureGeneration() const;
    void collectReleasedTextures();
    std::size_t getPendingReleaseCount();
    void setActiveTextureUnit(const Uint32& Unit);
    unsigned int getValidTextureSize(const unsigned int& Size);
    bool existsId(ResourceId textureId);
    bool exists(const Texture* tex);
    Texture* getTexture(ResourceId textureId);
    unsigned int getTextureMemorySize();

    Texture* pushTexture(
        const std::string& Filepath,
        const Uint32& textureHandle,
        const unsigned int& Width,
        const unsigned int& Height,
        const unsigned int& ImgWidth,
        const unsigned int& ImgHeight,
        const bool& Mipmap,
        const unsigned int& Channels,
        const Texture::ClampMode& ClampMode,
        const bool& CompressTexture,
        const bool& LocalCopy = false,
        const Uint32& MemSize = 0
    );

    Texture* getByName(const std::string& Name);
    Texture* getByHash(const String::HashType& hash);
    const Texture::CoordinateType& getLastCoordinateType() const;
};

Inherited Members¶

public:
    // methods

    void lock();
    void unlock();
    bool tryLock();

Detailed Documentation¶

The Texture Manager Class. Here we do all the textures stuff. (Singleton Class)

Methods¶

Texture* createEmptyTexture(
    const unsigned int& Width,
    const unsigned int& Height,
    const unsigned int& Channels = 4,
    const Color& DefaultColor = Color(0, 0, 0, 255),
    const bool& Mipmap = false,
    const Texture::ClampMode& ClampMode = Texture::ClampMode::ClampToEdge,
    const bool& CompressTexture = false,
    const bool& KeepLocalCopy = false,
    const std::string& Filename = std::string("")
)

Creates an empty texture

Parameters:

Width	Texture Width
Height	Texture Height
Channels	Texture Number of Channels (in bytes)
DefaultColor	The background color for the texture
Mipmap	Create Mipmap?
ClampMode	Defines the CLAMP MODE
CompressTexture	If use the DXT compression on the texture loading ( if the card can display them, will convert RGB to DXT1, RGBA to DXT5 )
KeepLocalCopy	Keep the array data copy. ( useful if want to reload the texture )
Filename	A filename to recognize the texture.

Returns:

The created texture

Texture* loadFromPixels(
    const unsigned char* Pixels,
    const unsigned int& Width,
    const unsigned int& Height,
    const unsigned int& Channels,
    const bool& Mipmap = false,
    const Texture::ClampMode& ClampMode = Texture::ClampMode::ClampToEdge,
    const bool& CompressTexture = false,
    const bool& KeepLocalCopy = false,
    const std::string& FileName = std::string("")
)

Loads a RAW Texture from Memory

Parameters:

Pixels	The Texture array
Width	Texture Width
Height	Texture Height
Channels	Texture Number of Channels (in bytes)
Mipmap	Create Mipmap?
ClampMode	Defines the CLAMP MODE
CompressTexture	If use the DXT compression on the texture loading ( if the card can display them, will convert RGB to DXT1, RGBA to DXT5 )
KeepLocalCopy	Keep the array data copy. ( useful if want to reload the texture )
FileName	A filename to recognize the texture ( the path in case that was loaded from outside the texture factory ).

Returns: