Method save_dds

python/dds_writer.py:82–332

Port of: bool save_dds(const char* pFilename, uint32_t width, uint32_t height, const void* pBlocks, uint32_t pixel_format_bpp, DXGI_FORMAT dxgi_format,

(
        self,
        filename: str,
        width: int,
        height: int,
        blocks: Union[bytes, bytearray, memoryview],
        pixel_format_bpp: int,
        dxgi_format: int,
        srgb: bool = False,
        force_dx10_header: bool = False,
    )

    DDS_MAGIC = b"DDS "       # same as fwrite("DDS ", 4, 1, pFile);

    def save_dds(
        self,
        filename: str,
        width: int,
        height: int,
        blocks: Union[bytes, bytearray, memoryview],
        pixel_format_bpp: int,
        dxgi_format: int,
        srgb: bool = False,
        force_dx10_header: bool = False,
    ) -> bool:
        """
        Port of:
            bool save_dds(const char* pFilename,
                          uint32_t width, uint32_t height,
                          const void* pBlocks,
                          uint32_t pixel_format_bpp,
                          DXGI_FORMAT dxgi_format,
                          bool srgb,
                          bool force_dx10_header);

        The 'blocks' buffer is written as-is (up to computed linear size).
        """

        # srgb is intentionally unused in the original C code (commented logic).
        _ = srgb

        # Open file like the C code
        try:
            f = open(filename, "wb")
        except OSError:
            print(f"Failed creating file {filename}!", file=sys.stderr)
            return False

        try:
            # Write the "DDS " magic
            f.write(self.DDS_MAGIC)

            # -----------------------------------------------------------------
            # Build DDSURFACEDESC2 equivalent
            # -----------------------------------------------------------------
            # We'll pack DDSURFACEDESC2 as 31 uint32's (124 bytes) in little-endian:
            # struct DDSURFACEDESC2 {
            #   uint32 dwSize;
            #   uint32 dwFlags;
            #   uint32 dwHeight;
            #   uint32 dwWidth;
            #   uint32 lPitch_or_dwLinearSize;
            #   uint32 dwBackBufferCount;
            #   uint32 dwMipMapCount;
            #   uint32 dwAlphaBitDepth;
            #   uint32 dwUnused0;
            #   uint32 lpSurface;
            #   DDCOLORKEY unused0;  (2 * uint32)
            #   DDCOLORKEY unused1;  (2 * uint32)
            #   DDCOLORKEY unused2;  (2 * uint32)
            #   DDCOLORKEY unused3;  (2 * uint32)
            #   DDPIXELFORMAT ddpfPixelFormat; (8 * uint32)