/**
 * @file
 *
 * @author OmniBlade
 * @author CCHyper
 *
 * @brief Low level sprite drawing functions for Dune2 sprite format (used for mouse in early C&C games).
 *
 * @copyright Chronoshift is free software: you can redistribute it and/or
 *            modify it under the terms of the GNU General Public License
 *            as published by the Free Software Foundation, either version
 *            2 of the License, or (at your option) any later version.
 *            A full copy of the GNU General Public License can be found in
 *            LICENSE
 */
#pragma once

#ifndef MOUSESHAPE_H
#define MOUSESHAPE_H

#pragma pack(push, 1)
 // Header for each frame in the old SHP format... only used for mouse now.
struct MouseShapeFrameHeader
{
    //"MAKESHAPE_NORMAL"   0
    //"MAKESHAPE_COMPACT"  1
    //"MAKESHAPE_NOCOMP"   2
    //"MAKESHAPE_VARIABLE" 4
    uint16_t flags; // flag 1 specifies that a 16 byte color table follows the header.
                    // flag 2 specifies that this frame doesn't have LCW compression,
                    // this frame would only have RLE compression.
                    // flag 4 specifies a custom length color table follows the header.
    uint8_t height; //height after RLE compression?
    uint16_t width;
    uint8_t original_height; // original frame height without any compression.
    uint16_t shape_size; // full frame size including this header.
    uint16_t data_length; // uncompressed size, frame size minus header if flag 2 is specified.
    //
    // Following this is optional data, in Dune 2 this was used to specify remap indexes.
    // If flag 1 is set then a uint8_t color_table[16] follows.
    // if flag 4 is set then a uint8_t color_table_size and uint8_t color_table[color_table_size] follows.
};

// Header for the old SHP format... only used for mouse now. Offset values need +2 to get actual frame pos.
struct MouseShapeHeader
{
    uint16_t frame_count;
    uint32_t offset;
};
#pragma pack(pop)

class WWMouseClass;
class GraphicViewPortClass;

int Get_Shape_Uncomp_Size(void* shape);
int Extract_Shape_Count(void* shape);
void* Extract_Shape(void* shape, int frame = 0);
int Get_Shape_Width(void* shape);
int Get_Shape_Height(void* shape);
int Restore_Shape_Height(void* shape);
int Get_Shape_Original_Height(void* shape);

void __cdecl Mouse_Shadow_Buffer(WWMouseClass& mouse, GraphicViewPortClass& viewport, void* buffer, int x_pos, int y_pos, int hspot_x, int hspot_y, BOOL save);
void __cdecl Mouse_Draw(WWMouseClass& mouse, GraphicViewPortClass& viewport, int x_pos, int y_pos);
void* __cdecl Mouse_Set_Cursor(WWMouseClass& mouse, int hspot_x, int hspot_y, void* shape);

#endif
