CSMAPI_drawing.h

Go to the documentation of this file.

/*
  Cavestory Multiplayer API
  Copyright (C) 2021 Johnny Ledger
 
  This software is provided 'as-is', without any express or implied
  warranty.  In no event will the authors be held liable for any damages
  arising from the use of this software.
 
  Permission is granted to anyone to use this software for any purpose,
  including commercial applications, and to alter it and redistribute it
  freely, subject to the following restrictions:
 
  1. The origin of this software must not be misrepresented; you must not
     claim that you wrote the original software. If you use this software
     in a product, an acknowledgment in the product documentation would be
     appreciated but is not required.
  2. Altered source versions must be plainly marked as such, and must not be
     misrepresented as being the original software.
  3. This notice may not be removed or altered from any source distribution.
*/
 
#pragma once
 
class VideoTexture;
struct NPCHAR;
#include <List.h>
#include <CSMAPI_begincode.h>
 
//------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------//
 
 
struct Mouse
{
    static CAVESTORY_MOD_API void SetMousePosition(GUI_POINT new_position);
    static CAVESTORY_MOD_API GUI_POINT GetMousePosition();
 
    static CAVESTORY_MOD_API void SetVisible(bool val);
    static CAVESTORY_MOD_API bool IsVisible();
};
 
 
 
typedef struct FontObject FontObject;
class CAVESTORY_MOD_API FontManager;
 
#define FONT_OBJECT_SIZE 1040
 
//------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
#define TEXT_SIZE(font_object, string, ptr_x, ptr_y) GetTextSize(font_object, string, strlen(string), &ptr_x, &ptr_y); ptr_x /= magnification; ptr_y /= magnification;
 
#define TEXT_SIZE_2(font_object, string, string_length, ptr_x, ptr_y) GetTextSize(font_object, string, string_length, &ptr_x, &ptr_y); ptr_x /= magnification; ptr_y /= magnification;
 
#define TEXT_WIDTH(font_object, string) (GetTextWidth(font_object, string) / magnification)
 
#define TEXT_HEIGHT(font_object, string) (GetTextHeight(font_object, string) / magnification)
 
#define TEXT_WIDTH_2(font_object, string, string_length) (GetTextWidth(font_object, string, string_length) / magnification)
 
#define TEXT_HEIGHT_2(font_object, string, string_length) (GetTextHeight(font_object, string, string_length) / magnification)
 
#define TEXT_WIDTH_2S(font_object, string) (GetTextWidth(font_object, string, strlen(string)) / magnification)
 
#define TEXT_HEIGHT_2S(font_object, string) (GetTextHeight(font_object, string, strlen(string)) / magnification)
 
#define FONT_ASCII_HEIGHT(font_object) (GetTextHeight(font_object, "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789") / magnification)
 
//------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
#define UI_TEXT_SIZE(font_object, string, ptr_x, ptr_y) GetTextSize(font_object, string, strlen(string), &ptr_x, &ptr_y); ptr_x /= CSM_GetUIMagnificationLevel(); ptr_y /= CSM_GetUIMagnificationLevel();
 
#define UI_TEXT_SIZE_2(font_object, string, string_length, ptr_x, ptr_y) GetTextSize(font_object, string, string_length, &ptr_x, &ptr_y); ptr_x /= CSM_GetUIMagnificationLevel(); ptr_y /= CSM_GetUIMagnificationLevel();
 
#define UI_TEXT_WIDTH(font_object, string) (GetTextWidth(font_object, string) / CSM_GetUIMagnificationLevel())
 
#define UI_TEXT_HEIGHT(font_object, string) (GetTextHeight(font_object, string) / CSM_GetUIMagnificationLevel())
 
#define UI_TEXT_WIDTH_2(font_object, string, string_length) (GetTextWidth(font_object, string, string_length) / CSM_GetUIMagnificationLevel())
 
#define UI_TEXT_HEIGHT_2(font_object, string, string_length) (GetTextHeight(font_object, string, string_length) / CSM_GetUIMagnificationLevel())
 
#define UI_TEXT_WIDTH_2S(font_object, string) (GetTextWidth(font_object, string, strlen(string)) / CSM_GetUIMagnificationLevel())
 
#define UI_TEXT_HEIGHT_2S(font_object, string) (GetTextHeight(font_object, string, strlen(string)) / CSM_GetUIMagnificationLevel())
 
#define UI_FONT_ASCII_HEIGHT(font_object) (GetTextHeight(font_object, "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789") / CSM_GetUIMagnificationLevel())
 
//------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
#define CUSTOMMAG_TEXT_SIZE(INPUT_MAG, font_object, string, ptr_x, ptr_y) GetTextSize(font_object, string, strlen(string), &ptr_x, &ptr_y); ptr_x /= INPUT_MAG; ptr_y /= INPUT_MAG;
 
#define CUSTOMMAG_TEXT_SIZE_2(INPUT_MAG, font_object, string, string_length, ptr_x, ptr_y) GetTextSize(font_object, string, string_length, &ptr_x, &ptr_y); ptr_x /= INPUT_MAG; ptr_y /= INPUT_MAG;
 
#define CUSTOMMAG_TEXT_WIDTH(INPUT_MAG, font_object, string) (GetTextWidth(font_object, string) / INPUT_MAG)
 
#define CUSTOMMAG_TEXT_HEIGHT(INPUT_MAG, font_object, string) (GetTextHeight(font_object, string) / INPUT_MAG)
 
#define CUSTOMMAG_TEXT_WIDTH_2(INPUT_MAG, font_object, string, string_length) (GetTextWidth(font_object, string, string_length) / INPUT_MAG)
 
#define CUSTOMMAG_TEXT_HEIGHT_2(INPUT_MAG, font_object, string, string_length) (GetTextHeight(font_object, string, string_length) / INPUT_MAG)
 
#define CUSTOMMAG_TEXT_WIDTH_2S(INPUT_MAG, font_object, string) (GetTextWidth(font_object, string, strlen(string)) / INPUT_MAG)
 
#define CUSTOMMAG_TEXT_HEIGHT_2S(INPUT_MAG, font_object, string) (GetTextHeight(font_object, string, strlen(string)) / INPUT_MAG)
 
#define CUSTOMMAG_FONT_ASCII_HEIGHT(INPUT_MAG, font_object) (GetTextHeight(font_object, "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789") / INPUT_MAG)
 
//------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
extern CAVESTORY_MOD_API int CSM_GetUIMagnificationLevel();
 
extern CAVESTORY_MOD_API int CSM_GetChatMagnificationLevel();
 
extern CAVESTORY_MOD_API void SetFontCharacterWhitelist(const unsigned char* pWhitelist);
 
extern CAVESTORY_MOD_API void SetFontWhitelistEnabled(bool bEnabled);
 
extern CAVESTORY_MOD_API const unsigned char* GetFontCharacterWhitelist();
 
extern CAVESTORY_MOD_API FontObject* LoadFontFromFile(const char* pFileName, unsigned int cell_width, unsigned int cell_height, VideoTexture* pTexture = NULL, FontManager* pManager = NULL);
 
extern CAVESTORY_MOD_API void SetFontTexture(FontObject* pFont, VideoTexture* pTexture);
 
extern CAVESTORY_MOD_API FontObject* LoadFontFromData(const unsigned char* data, size_t data_size, unsigned int cell_width, unsigned int cell_height, VideoTexture* pTexture = NULL, FontManager* pManager = NULL);
 
extern CAVESTORY_MOD_API FontObject* LoadFont(const char* font_filename, unsigned int cell_width, unsigned int cell_height, VideoTexture* pTexture = NULL, FontManager* pManager = NULL);
 
extern CAVESTORY_MOD_API void GetTextSize(FontObject* font_object, const char* string, size_t string_length, int* size_x, int* size_y);
 
extern CAVESTORY_MOD_API unsigned int GetTextWidth(FontObject* font_object, const char* string, size_t string_length = size_t(-1));
 
extern CAVESTORY_MOD_API unsigned int GetTextHeight(FontObject* font_object, const char* string, size_t string_length = size_t(-1));
 
extern CAVESTORY_MOD_API BOOL IsFontLinkedToTexture(FontObject* font_object, VideoTexture* pTexture);
 
extern CAVESTORY_MOD_API int GetFontMagnification(FontObject* font_object);
 
extern CAVESTORY_MOD_API int GetFontHeight(FontObject* font_object);
 
extern CAVESTORY_MOD_API void DrawNormalText(FontObject* font_object, unsigned char* bitmap_buffer, size_t bitmap_pitch, int bitmap_width, int bitmap_height, int x, int y, unsigned long colour, const char* string, size_t string_length);
 
extern CAVESTORY_MOD_API void DrawClippedText(FontObject* font_object, unsigned char* bitmap_buffer, size_t bitmap_pitch, int bitmap_width, int bitmap_height, int x, int y, unsigned long colour, const char* string, size_t string_length, int clipLEFT, int clipTOP, int clipRIGHT, int clipBOTTOM, float iOutAlpha = 1.f);
 
extern CAVESTORY_MOD_API void UnloadFont(FontObject* font_object);
 
extern CAVESTORY_MOD_API unsigned long UTF8ToUnicode(const unsigned char* string, unsigned int* bytes_read);
 
extern CAVESTORY_MOD_API void InitFont();
 
extern CAVESTORY_MOD_API void DeInitFont();
 
 
 
struct CAVESTORY_MOD_API SpecialTextNode
{
    GUI_POINT draw_offset;
    
    int tab_num;
    
    FontHandle FO;
 
    unsigned long color;
 
    char* start;
 
    int length;
 
    GUI_POINT bmp_offset;
 
    Surface_Ids surf_id;
 
    GUI_RECT src_rect;
 
    int caret_pos;
 
    int line_no;
    
    int tab_group;
};
 
struct CAVESTORY_MOD_API SpecialTextCache
{
    GUI_RECT rect;
 
    GUI_POINT mTotalSize;
 
    List<SpecialTextNode*> mTextList;
 
    char* mFullText;
    int   mFullTextSize;
    int   mFullTextLen;
 
    SpecialTextCache();
 
    ~SpecialTextCache();
 
    bool Parse(FontObject* pFont, const char* pString, int iLength = -1, unsigned long iColor = 0xFFFFFFFF, int iDestWidth = 0);
 
    void Free();
};
 
struct CAVESTORY_MOD_API CacheSurface
{
    enum BitmapBoxType
    {
        BMPBOX_TYPE_WIDTH = 0,
 
        BMPBOX_TYPE_HEIGHT,
 
        BMPBOX_TYPE_BOTH
    };
    
    static void InitMemory();
    
    static GUI_POINT GetTextSize(FontObject* pFont, const char* pText, int iTextLen = -1);
 
    static BOOL SetCurrentTexture(VideoTexture* pTexture);
    
    static BOOL SetSurfaceID(Surface_Ids sid);
    
    static BOOL SelectRendererSurface(int iCustomMagnification = 0);
    
    static BOOL SetSurfaceIDAndRememberPrevious(Surface_Ids sid);
    
    static BOOL SelectRendererSurfaceAndRememberPrevious(int iCustomMagnification = 0);
    
    static BOOL RememberSurfaceID();
    
    static BOOL RestoreSurfaceID();
 
    static Surface_Ids GetSurfaceID();
    
    static VideoTexture* GetCurrentVideoTexture();
 
    static int GetFreeSurfaceCount();
 
    static bool TryClipPoint(GUI_POINT& p);
    
    static bool IsInClipRect(GUI_POINT p);
 
    static bool IsInClipRect(GUI_RECT r);
    
    static bool IsInClipRectWithCustomMag(GUI_RECT r, int customMagnification);
 
    static void SetClipRect(GUI_RECT* r, bool bAbsoluteRect = false);
    
    static void GetClipRect(GUI_RECT* r);
 
    static void ClearClipRectList();
 
    static GUI_POINT GetSurfaceIDSize(Surface_Ids sid);
    
    static int GetSurfaceIDMagnification(Surface_Ids sid);
 
    static Surface_Ids GetNextFreeSurfaceID(int iSkipCount = 0, bool bAsyncUse = false, bool bLockMutex = true);
 
    static bool IsSurfaceAllocated(Surface_Ids sid);
    
    static void FreeSurfaceID(Surface_Ids sid);
    
    static void UnlockSurfaceID(Surface_Ids sid);
 
    static bool AllocateSurface(int w, int h, Surface_Ids iSurfId = SURFACE_ID_MAX, unsigned int iMagnification = 0);
 
    static bool LoadFileToSurface(const char* pFileName, Surface_Ids iSurfId = SURFACE_ID_MAX, bool bAsync = false, unsigned int iMagnification = 0);
 
    static bool SaveSurfaceToFile(const char* pFileName, Surface_Ids iSurfId = SURFACE_ID_MAX);
 
    static void DrawPixel(GUI_POINT pPoint, unsigned long color, bool bAbsolutePos = false);
    
    static void DrawPixels(GUI_POINT* pPointList, unsigned int iPointCount, unsigned long color, bool bAbsolutePos = false);
 
    static void DrawLine(GUI_POINT start, GUI_POINT end, unsigned long color, bool bUseMagnification = true);
    
    static void DrawStripedLine(GUI_POINT start, GUI_POINT end, unsigned long color);
    
    static void DrawStripedRect(GUI_RECT* pRect, unsigned long iColor);
    
    static void DrawGradientLine(GUI_POINT start, GUI_POINT end, unsigned long* colors, int colorcount);
 
    static void DrawClearRect(GUI_RECT* r);
 
    static void DrawFilledRect(GUI_RECT* r, unsigned long color, bool bAbsolutePos = false);
 
    static void DrawRect(GUI_RECT* r, unsigned long color, bool bAbsolutePos = false);
 
    static void DrawFilledRectTransparent(GUI_RECT* r, unsigned long color, bool bAbsolutePos = false);
 
    static void DrawRectTransparent(GUI_RECT* r, unsigned long color, bool bAbsolutePos = false);
 
    static void DrawFilledCircle(GUI_POINT p, int size, unsigned long color, bool invert = false);
 
    static void DrawFilledTriangle(GUI_POINT* points, unsigned long color);
 
    static void DrawCircle(GUI_POINT p, int size, unsigned long color);
 
    static void DrawTriangle(GUI_POINT* points, unsigned long color);
 
    static GUI_POINT DrawFilledBitmapRect(GUI_RECT* drawRect, GUI_RECT* srcRect, Surface_Ids sid, GUI_POINT drawPadding = GUI_POINT(0, 0));
 
    static GUI_POINT DrawBitmap(GUI_POINT p, GUI_RECT* srcRect, Surface_Ids sid, bool bAbsolutePos = false);
    
    static GUI_POINT DrawStretchedBitmap(GUI_RECT* r, GUI_RECT* srcRect, Surface_Ids sid, GUI_COLOR color, bool bAbsolutePos = false);
 
    static GUI_POINT DrawColoredBitmap(GUI_POINT p, GUI_RECT* srcRect, Surface_Ids sid, GUI_COLOR color, bool bAbsolutePos = false);
 
    static void DrawText(GUI_POINT p, FontObject* font, const char* text, unsigned long color);
 
    static void DrawClippedText(GUI_POINT p, FontObject* font, const char* text, unsigned long color, int iStringLength = -1, bool bWrap = false, GUI_POINT* pDrawSize = NULL, int iShadowSize = 0, unsigned long iShadowColor = 0);
    
    static void DrawClippedTextNoMagnification(GUI_POINT p, FontObject* font, const char* text, unsigned long color, int iStringLength = -1, bool bWrap = false, GUI_POINT* pDrawSize = NULL, int iShadowSize = 0, unsigned long iShadowColor = 0);
    
    static void DrawSpecialText(GUI_POINT p, SpecialTextCache* pCache);
 
    static void DrawBitmapBox(GUI_RECT* out_rect, GUI_RECT* bmp_rects, BitmapBoxType type, Surface_Ids bmp_id);
 
    static void DrawTransparentBitmapBox(GUI_RECT* out_rect, GUI_RECT* bmp_rects, BitmapBoxType type, Surface_Ids bmp_id, int iAlpha);
 
    static void SetNeedsUpdating();
 
    static GUI_POINT GetBitmapBoxSize(GUI_POINT* desired_extent, GUI_RECT* bmp_rects, BitmapBoxType type);
 
    static void Put(GUI_POINT out_pos, Surface_Ids sid = SURFACE_ID_MAX, bool bAbsolutePos = false);
 
    static void PutAlpha(GUI_POINT out_pos, Surface_Ids sid = SURFACE_ID_MAX, unsigned char Alpha = 255, bool bAbsolutePos = false);
 
#ifdef _DEBUG
    static void ShowSurfaceId(Surface_Ids sid, GUI_RECT* r, bool waitForInput = false);
    static void DebugShow();
#endif
 
    static GUI_COLOR GetPixelColor(GUI_POINT p, Surface_Ids sid, bool bAbsolutePos = false);
    static GUI_COLOR GetEntityPixel(NPCHAR* npc, GUI_POINT p);
};
 
extern CAVESTORY_MOD_API void CSM_QSA_Begin
(
    Surface_Ids sid,
    GUI_RECT* rect,
    CSM_QSA_Data* out
);
 
extern CAVESTORY_MOD_API void CSM_QSA_Free
(
    CSM_QSA_Data* qsaptr
);
 
extern CAVESTORY_MOD_API int ghWnd;
 
extern CAVESTORY_MOD_API void PutFramePerSecound();
 
extern CAVESTORY_MOD_API BOOL Flip_SystemTask(
    int hWnd
);
 
extern CAVESTORY_MOD_API void PutBitmap3(
    RECT* rcView,
    int x,
    int y,
    RECT* rect, 
    Surface_Ids surf_no
);
 
extern CAVESTORY_MOD_API void PutBitmap4(
    RECT *rcView,
    int x,
    int y,
    RECT *rect,
    Surface_Ids surf_no
);
 
extern CAVESTORY_MOD_API void PutBitmap5(
    RECT *rcView,
    int x,
    int y,
    RECT *rect,
    Surface_Ids surf_no,
    int scalar
);
 
extern CAVESTORY_MOD_API void PutBitmap6(
    RECT *rcView, 
    int x, 
    int y,
    RECT *rect,
    Surface_Ids surf_no,
    int scalar
);
 
extern CAVESTORY_MOD_API void PutBitmap7(
    RECT* rcView,
    int x,
    int y,
    RECT* rect,
    Surface_Ids surf_no
);
 
extern CAVESTORY_MOD_API void PutBitmap8(RECT* rcView, int x, int y, RECT* rect, Surface_Ids surf_no, int r, int g, int b);
 
extern CAVESTORY_MOD_API void PutBitmap9(RECT* rcView, int x, int y, RECT* rect, Surface_Ids surf_no, int alpha);
 
extern CAVESTORY_MOD_API void PutBitmap10(int x, int y, RECT* rect, Surface_Ids surf_no);
 
extern CAVESTORY_MOD_API void PutBitmap11(int x, int y, RECT* rect, Surface_Ids surf_no, int r, int g, int b);
 
extern CAVESTORY_MOD_API void PutBitmap12(RECT* rcView, Surface_Ids dst_surf_no, int x, int y, RECT* src_rect, Surface_Ids src_surf_no, bool async = false);
 
extern CAVESTORY_MOD_API void PutBitmap13(RECT* rcView, Surface_Ids dst_surf_no, int x, int y, RECT* src_rect, Surface_Ids src_surf_no, int r, int g, int b, bool async = false);
 
extern CAVESTORY_MOD_API void PutBitmap14(int x, int y, int w, int h, RECT* rect, Surface_Ids surf_no, int r, int g, int b);
 
extern CAVESTORY_MOD_API void PutBitmap15(
    RECT* pDstRect,
    RECT* pSrcRect,
    Surface_Ids iSurfaceNo
);
 
extern CAVESTORY_MOD_API void PutBitmap16(
    RECT* rcView,
    int x,
    int y,
    RECT* rect,
    Surface_Ids surf_no,
    float angle,
    int center_x,
    int center_y
);
 
extern CAVESTORY_MOD_API void PutBitmap17(
    RECT* pDstRect,
    RECT* pSrcRect,
    Surface_Ids iSurfaceNo
);
 
extern CAVESTORY_MOD_API void PutBitmap18(
    RECT* pDstRect,
    RECT* pSrcRect,
    Surface_Ids iSurfaceNo,
    Surface_Ids iDestSurfaceNo
);
 
extern CAVESTORY_MOD_API void ModBitmap(
    Surface_Ids iSurfNo,
    unsigned long iColor
);
 
extern CAVESTORY_MOD_API void ClearBitmapMod(
    Surface_Ids iSurfNo
);
 
extern CAVESTORY_MOD_API void PutNumber3(int x, int y, int value);
 
extern CAVESTORY_MOD_API void PutNumber4(int x, int y, int value, BOOL bZero);
 
extern CAVESTORY_MOD_API void PutSpecificNpChar(NPCHAR* npc, int fx, int fy, bool bIgnorePutFunc = false, int* iDrawX = NULL, int* iDrawY = NULL);
 
 
#include <CSMAPI_endcode.h>
 
//---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------