common.hh

Go to the documentation of this file.

/*
 
MIT License
 
Copyright (c) 2022 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>
 
namespace psyqo {
 
union Vertex {
    struct {
        union {
            int16_t x, u, s, w;
        };
        union {
            int16_t y, v, t, h;
        };
    };
    uint32_t packed;
};
static_assert(sizeof(Vertex) == sizeof(uint32_t), "Vertex is not 32 bits");
 
struct Rect {
    union {
        Vertex a, pos;
    };
    union {
        Vertex b, size;
    };
    bool isEmpty() { return (size.w == 0) && (size.h == 0); }
};
static_assert(sizeof(Rect) == sizeof(uint64_t), "Rect is not 64 bits");
 
union Color {
    struct {
        uint8_t r, g, b, user;
    };
    uint32_t packed;
};
static_assert(sizeof(Color) == sizeof(uint32_t), "Color is not 32 bits");
 
namespace Prim::TPageAttr {
enum SemiTrans { HalfBackAndHalfFront, FullBackAndFullFront, FullBackSubFullFront, FullBackAndQuarterFront };
enum ColorMode { Tex4Bits, Tex8Bits, Tex16Bits };
}  // namespace Prim::TPageAttr
 
namespace Prim {
enum class Transparency { Auto, Opaque, SemiTransparent };
}
 
namespace PrimPieces {
 
struct ClutIndex {
    ClutIndex() {}
    ClutIndex(Vertex v) : ClutIndex(v.x >> 4, v.y) {}
    ClutIndex(uint16_t x, uint16_t y) : index((y << 6) | x) {}
 
  private:
    uint16_t index = 0;
};
static_assert(sizeof(ClutIndex) == sizeof(uint16_t), "ClutIndex is not 16 bits");
 
struct alignas(uint32_t) TexInfo {
    uint8_t u;
    uint8_t v;
    ClutIndex clut;
};
static_assert(sizeof(TexInfo) == sizeof(uint32_t), "TexInfo is not 32 bits");
static_assert(alignof(TexInfo) == alignof(uint32_t), "TexInfo is not 32-bit aligned");
 
struct TPageAttr;
struct TPageLoc {
    TPageLoc& setPageX(uint8_t x) {
        info &= ~0x000f;
        x &= 0x000f;
        info |= x;
        return *this;
    }
    TPageLoc& setPageY(uint8_t y) {
        info &= ~0x0010;
        y &= 0x0001;
        info |= y << 4;
        return *this;
    }
 
  private:
    TPageLoc(uint8_t i) : info(i) {}
    uint8_t info = 0;
    friend struct TPageAttr;
};
static_assert(sizeof(TPageLoc) == sizeof(uint8_t), "TPageLoc is not 8 bits");
 
struct TPageAttr {
    TPageAttr() {}
    TPageAttr(TPageAttr&& other) : info(other.info) {}
    TPageAttr(const TPageAttr& other) : info(other.info) {}
    TPageAttr& operator=(TPageAttr&& other) {
        info = other.info;
        return *this;
    }
    TPageAttr& operator=(const TPageAttr& other) {
        info = other.info;
        return *this;
    }
    TPageAttr& copy(const TPageAttr& other) {
        info = other.info;
        return *this;
    }
    TPageAttr& setPageX(uint8_t x) {
        info &= ~0x000f;
        x &= 0x000f;
        info |= x;
        return *this;
    }
    TPageAttr& setPageY(uint8_t y) {
        info &= ~0x0010;
        y &= 0x0001;
        info |= y << 4;
        return *this;
    }
    TPageAttr& setPageLoc(TPageLoc loc) {
        info &= ~0x001f;
        info |= loc.info;
        return *this;
    }
    TPageAttr& set(Prim::TPageAttr::SemiTrans trans) {
        info &= ~0x0060;
        uint32_t t = static_cast<uint32_t>(trans);
        info |= t << 5;
        return *this;
    }
    TPageAttr& set(Prim::TPageAttr::ColorMode mode) {
        info &= ~0x0180;
        uint32_t m = static_cast<uint32_t>(mode);
        info |= m << 7;
        return *this;
    }
    TPageAttr& setDithering(bool dithering) {
        if (dithering) {
            info |= 0x0200;
        } else {
            info &= ~0x0200;
        }
        return *this;
    }
    TPageAttr& disableDisplayArea() {
        info &= ~0x0400;
        return *this;
    }
    TPageAttr& enableDisplayArea() {
        info |= 0x0400;
        return *this;
    }
    uint8_t getPageX() const { return info & 0x000f; }
    uint8_t getPageY() const { return (info >> 4) & 0x0001; }
    TPageLoc getPageLoc() const { return TPageLoc(info & 0x001f); }
    Prim::TPageAttr::SemiTrans getSemiTrans() const {
        return static_cast<Prim::TPageAttr::SemiTrans>((info >> 5) & 0x0003);
    }
    Prim::TPageAttr::ColorMode getColorMode() const {
        return static_cast<Prim::TPageAttr::ColorMode>((info >> 7) & 0x0003);
    }
    bool hasDithering() const { return (info & 0x0200) != 0; }
    bool isDisplayAreaEnabled() const { return (info & 0x0400) != 0; }
 
  private:
    uint16_t info = 0;
};
static_assert(sizeof(TPageAttr) == sizeof(uint16_t), "TPageAttr is not 16 bits");
 
struct alignas(uint32_t) PageInfo {
    uint8_t u;
    uint8_t v;
    TPageAttr attr;
};
static_assert(sizeof(PageInfo) == sizeof(uint32_t), "PageInfo is not 32 bits");
static_assert(alignof(PageInfo) == alignof(uint32_t), "PageInfo is not 32-bit aligned");
 
struct UVCoords {
    uint8_t u;
    uint8_t v;
};
static_assert(sizeof(UVCoords) == sizeof(uint16_t), "UVCoords is not 16 bits");
 
struct UVCoordsPadded {
    uint8_t u;
    uint8_t v;
    uint16_t user;
};
static_assert(sizeof(UVCoordsPadded) == sizeof(uint32_t), "UVCoordsPadded is not 32 bits");
 
}  // namespace PrimPieces
 
}  // namespace psyqo