RenderPipeline.cpp

How to use CSMP's rendering pipeline.

See also

CacheSurface

 
//...
 
Surface_Ids g_MyImageId = SURFACE_ID_MAX;
FontObject* g_MyFont    = NULL;
 
//...
 
Surface_Ids LoadMyImage()
{
    static const char* pFileName = "data/Path/To/My/Image.png";
 
    // If the surface is already loaded, then use that.
    if (g_MyImageId != SURFACE_ID_MAX)
        return g_MyImageId;
 
    // Attempt to get the next free surface ID
    if ((g_MyImageId = CacheSurface::GetNextFreeSurfaceID()) == SURFACE_ID_MAX)
    {
        // If this error occurs, it means that CSMP has run out of dynamic surface IDs -- Basically, the game can't hold any more images because all the image slots are occupied!
        CSM_LogError("MyMod/LoadBmp", "Failed to aquire an unoccupied surface slot!");
        return SURFACE_ID_MAX;
    }
 
    // Load our image into the slot we got
    if (!CacheSurface::LoadFileToSurface(pFileName, g_MyImageId))
    {
        // Failed to load the image!
        CSM_LogError("MyMod/LoadBmp", "Failed to load image \"%s\".", pFileName);
 
        // Reset our image ID
        g_MyImageId = SURFACE_ID_MAX;
 
        // Fail!
        return SURFACE_ID_MAX;
    }
 
    // Done!
    return g_MyImageId;
}
 
//...
 
void MyMod_OnPostDraw()
{
    // This will set the surface that we want to draw on. Passing 'SURFACE_ID_RENDERER_TEXTURE' here tells the rendering pipeline that we want to draw directly to the screen.
    CacheSurface::SetSurfaceID(SURFACE_ID_RENDERER_TEXTURE);
    
    // Draw a red line that goes from the top-left corner of the screen to the bottom-right.
    CacheSurface::DrawLine(GUI_POINT(0, 0), GUI_POINT(WINDOW_WIDTH, WINDOW_HEIGHT), CSM_RGBA(255, 0, 0, 255));
    
    // Draw some green text!
    CacheSurface::DrawClippedText(GUI_POINT(16, 16), BaseModeInstance::GetDefaultFont(), "Hello World!", CSM_RGBA(0, 255, 0, 255));
    
    // Draw some screen-centered green text!
    CacheSurface::DrawClippedText
    (
        GUI_POINT
        (
            GET_CENTER_OFFSET_FIXED(WINDOW_WIDTH, TEXT_WIDTH_2S(BaseModeInstance::GetDefaultFont(), "Hello World!")),
            GET_CENTER_OFFSET_FIXED(WINDOW_HEIGHT, TEXT_HEIGHT_2S(BaseModeInstance::GetDefaultFont(), "Hello World!"))
        ),
        BaseModeInstance::GetDefaultFont(),
        "Hello World!",
        CSM_RGBA(0, 255, 0, 255)
    );
    
    // Draw some text with the font that we loaded!
    CacheSurface::DrawClippedText(GUI_POINT(0, 32), g_MyFont, "Hello World!", CSM_RGBA(255, 255, 255, 255));
    
    // Draw an image!
    CacheSurface::DrawBitmap(GUI_POINT(0, 0), NULL, LoadMyImage());
    
    // Draw a cropped portion of the same image to the screen
    CacheSurface::DrawBitmap(GUI_POINT(32, 32), &GUI_RECT(61, 23, 32, 32), LoadMyImage());
}
 
//...
 
int DataModInterface::OnInit()
{
    //...
    
    // Initialize our font
    if ((g_MyFont = FontManager::LoadFont("Courier New", 8, 16)) == NULL)
        CSM_LogError("MyMod/OnInit", "Failed to load our font!");
    
    // Hook our 'OnDraw' function
    CSM_SetHook_OnPostDraw(MyMod_OnPostDraw);
    
    //...
    
    return 0;
}
 
void DataModInterface::OnShutdown()
{
    // Clean up after ourselves
    if (g_MyFont)
    {
        FontManager::UnloadFont(g_MyFont);
        g_MyFont = NULL;
    }
    
    if (g_MyImageId != SURFACE_ID_MAX)
    {
        CacheSurface::FreeSurfaceID(g_MyImageId);
        g_MyImageId = SURFACE_ID_MAX;
    }
    
    delete this;
}