backends/opengl/image.cpp

// SPDX-License-Identifier: LGPL-2.1-or-later OR BSD-3-Clause
// SPDX-FileCopyrightText: 2004 - 2008 Olof Naessén and Per Larsson
// SPDX-FileCopyrightText: 2013 - 2026 Fifengine contributors
 
// Corresponding header include
#include "fifechan/backends/opengl/image.hpp"
 
// Standard library includes
#include <string>
 
// Project headers (subdirs before local)
#include "fifechan/exception.hpp"
 
namespace fcn::opengl
{
    Image::Image(std::span<unsigned int const> pixels, int width, int height, bool convertToDisplayFormat) :
        mTextureHandle(0), mAutoFree(true), mWidth(width), mHeight(height), mTextureWidth(1), mTextureHeight(1)
    {
        while (mTextureWidth < mWidth) {
            mTextureWidth *= 2;
        }
 
        while (mTextureHeight < mHeight) {
            mTextureHeight *= 2;
        }
 
        // Create a new pixel buffer and copy the pixels into it.
        mPixels.resize(static_cast<size_t>(mTextureWidth) * static_cast<size_t>(mTextureHeight));
 
#ifdef __BIG_ENDIAN__
        unsigned int const magicPink = 0xff00ffff;
#else
        unsigned int const magicPink = 0xffff00ff;
#endif
        for (int y = 0; y < mTextureHeight; ++y) {
            for (int x = 0; x < mTextureWidth; ++x) {
                if (x < mWidth && y < mHeight) {
                    unsigned int c = pixels[static_cast<size_t>(x + (y * mWidth))];
 
                    // Magic pink to transparent
                    if (c == magicPink) {
                        c = 0x00000000;
                    }
 
                    mPixels.at(static_cast<size_t>(x + (y * mTextureWidth))) = c;
                } else {
                    mPixels.at(static_cast<size_t>(x + (y * mTextureWidth))) = 0x00000000;
                }
            }
        }
 
        if (convertToDisplayFormat) {
            Image::convertToDisplayFormat();
        }
    }
 
    Image::Image(GLuint textureHandle, int width, int height, bool autoFree) :
        mTextureHandle(textureHandle),
        mAutoFree(autoFree),
        mWidth(width),
        mHeight(height),
        mTextureWidth(1),
        mTextureHeight(1)
    {
        mPixels.clear();
 
        while (mTextureWidth < mWidth) {
            mTextureWidth *= 2;
        }
 
        while (mTextureHeight < mHeight) {
            mTextureHeight *= 2;
        }
    }
 
    Image::~Image()
    {
        if (mAutoFree) {
            if (mPixels.empty()) {
                glDeleteTextures(1, &mTextureHandle);
            } else {
                mPixels.clear();
            }
        }
    }
 
    GLuint Image::getTextureHandle() const
    {
        return mTextureHandle;
    }
 
    int Image::getTextureWidth() const
    {
        return mTextureWidth;
    }
 
    int Image::getTextureHeight() const
    {
        return mTextureHeight;
    }
 
    void Image::free()
    {
        if (mPixels.empty()) {
            glDeleteTextures(1, &mTextureHandle);
        } else {
            mPixels.clear();
        }
    }
 
    int Image::getWidth() const
    {
        return mWidth;
    }
 
    int Image::getHeight() const
    {
        return mHeight;
    }
 
    Color Image::getPixel(int x, int y)
    {
        if (mPixels.empty()) {
            throwException("Image has been converted to display format");
        }
 
        if (x < 0 || x >= mWidth || y < 0 || y >= mHeight) {
            throwException("Coordinates outside of the image");
        }
 
        unsigned int const c = mPixels.at(static_cast<size_t>(x + (y * mTextureWidth)));
 
#ifdef __BIG_ENDIAN__
        auto const r = static_cast<unsigned char>((c >> 24) & 0xff);
        auto const g = static_cast<unsigned char>((c >> 16) & 0xff);
        auto const b = static_cast<unsigned char>((c >> 8) & 0xff);
        auto const a = static_cast<unsigned char>(c & 0xff);
#else
        auto const a = static_cast<unsigned char>((c >> 24) & 0xff);
        auto const b = static_cast<unsigned char>((c >> 16) & 0xff);
        auto const g = static_cast<unsigned char>((c >> 8) & 0xff);
        auto const r = static_cast<unsigned char>(c & 0xff);
#endif
 
        return {r, g, b, a};
    }
 
    void Image::putPixel(int x, int y, Color const & color)
    {
        if (mPixels.empty()) {
            throwException("Image has been converted to display format");
        }
 
        if (x < 0 || x >= mWidth || y < 0 || y >= mHeight) {
            throwException("Coordinates outside of the image");
        }
 
#ifdef __BIG_ENDIAN__
        unsigned int const c = color.a | color.b << 8 | color.g << 16 | color.r << 24;
#else
        unsigned int const c = color.r | color.g << 8 | color.b << 16 | color.a << 24;
#endif
 
        mPixels.at(static_cast<size_t>(x + (y * mTextureWidth))) = c;
    }
 
    void Image::convertToDisplayFormat()
    {
        if (mPixels.empty()) {
            throwException("Image has already been converted to display format");
        }
 
        glGenTextures(1, &mTextureHandle);
        glBindTexture(GL_TEXTURE_2D, mTextureHandle);
 
        glTexImage2D(GL_TEXTURE_2D, 0, 4, mTextureWidth, mTextureHeight, 0, GL_RGBA, GL_UNSIGNED_BYTE, mPixels.data());
 
        glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST);
        glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST);
 
        mPixels.clear();
 
        GLenum const error = glGetError();
        if (error != GL_NO_ERROR) {
            std::string errmsg;
            switch (error) {
            case GL_INVALID_ENUM:
                errmsg = "GL_INVALID_ENUM";
                break;
 
            case GL_INVALID_VALUE:
                errmsg = "GL_INVALID_VALUE";
                break;
 
            case GL_INVALID_OPERATION:
                errmsg = "GL_INVALID_OPERATION";
                break;
 
            case GL_STACK_OVERFLOW:
                errmsg = "GL_STACK_OVERFLOW";
                break;
 
            case GL_STACK_UNDERFLOW:
                errmsg = "GL_STACK_UNDERFLOW";
                break;
 
            case GL_OUT_OF_MEMORY:
                errmsg = "GL_OUT_OF_MEMORY";
                break;
            default:
                errmsg = "UNKNOWN_ERROR";
                break;
            }
            throwException(std::string("Unable to convert to OpenGL display format, glGetError said: ") + errmsg);
        }
    }
} // namespace fcn::opengl