tim.hh

Go to the documentation of this file.

/*
 
MIT License
 
Copyright (c) 2026 PCSX-Redux authors
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 
*/
 
#pragma once
 
#include <stdint.h>
 
#include "psyqo/gpu.hh"
#include "psyqo/primitives/common.hh"
 
namespace psyqo {
 
struct TIM {
    enum class Type : uint8_t {
        Tex4Bits = 0,
        Tex8Bits = 1,
        Tex16Bits = 2,
        Tex24Bits = 3,
        Mixed = 4,
    };
 
    enum class Error : uint8_t {
        None = 0,
        TooSmall,       
        BadMagic,       
        Compressed,     
        BadType,        
        Truncated,      
        BadSectionSize  
    };
 
    struct Section {
        const uint16_t* data = nullptr;
        Rect rect;
        bool aligned = false;  
    };
 
    bool parse(const uint8_t* data, uint32_t size);
 
    void upload(GPU& gpu) const;
 
    void upload(GPU& gpu, Vertex texturePosition, Vertex clutPosition) const;
 
    PrimPieces::TPageAttr tpage(Vertex texturePosition) const;
 
    PrimPieces::ClutIndex clutIndex(Vertex clutPosition) const;
 
    bool hasCLUT() const { return m_hasCLUT; }
    Type type() const { return m_type; }
    Error error() const { return m_error; }
 
    const Section& pixels() const { return m_pixels; }
    const Section& clut() const { return m_clut; }
 
    unsigned width() const;
    unsigned height() const { return m_pixels.rect.size.h; }
 
  private:
    Section m_pixels;
    Section m_clut;
    Type m_type = Type::Tex4Bits;
    Error m_error = Error::None;
    bool m_hasCLUT = false;
};
 
}  // namespace psyqo