SurfaceBitplane.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.
*/
 
#ifndef CAVESTORY_MOD_API_H_
#error "Please include CavestoryModAPI.h before including sub-classes."
#endif
 
#include <CSMAPI_begincode.h>
 
#pragma once
 
 
 
enum SurfaceBitplaneFlags
{
    SURF_BITPLANE_HAS_BOUNDS   = 0x0001,
 
    SURF_BITPLANE_HAS_BITPLANE = 0x0002,
 
    SURF_BITPLANE_HAS_ALL      = 0xFFFF
};
 
struct SURFACE_BITPLANE
{
    Surface_Ids SurfId;
 
    GUI_RECT SourceRect;
 
    unsigned int Flags;
 
    GUI_RECT Bounds;
 
    char* Plane;
};
 
extern CAVESTORY_MOD_API void CSM_SurfaceBitplane_Init(
    SURFACE_BITPLANE* pPlane
);
 
extern CAVESTORY_MOD_API void CSM_SurfaceBitplane_Free(
    SURFACE_BITPLANE* pPlane
);
 
extern CAVESTORY_MOD_API BOOL CSM_SurfaceBitplane_Scan(
    Surface_Ids iSurfId,
    GUI_RECT* pRect,
    SURFACE_BITPLANE* pPlane,
    unsigned int iFlags = SurfaceBitplaneFlags::SURF_BITPLANE_HAS_ALL,
    unsigned char iAlphaThreshold = 10
);
 
extern CAVESTORY_MOD_API BOOL CSM_SurfaceBitplane_IsPixelSolid(
    SURFACE_BITPLANE* pPlane,
    int iX,
    int iY
);
 
 
#include <CSMAPI_endcode.h>