profile.h

Go to the documentation of this file.

 
#ifndef OPENSNES_PROFILE_H
#define OPENSNES_PROFILE_H
 
#include <snes/types.h>
 
/* Removed on 2026-10-05 (1.0 plan, lot C): profileGetFrameCount.
 * The replacements are in docs/UPGRADING.md; `make check-upgrade` names them. */
 
/*============================================================================
 * Color Constants for Visual Profiling
 *
 * Each constant is an index into the internal color table.
 *============================================================================*/
 
#define PROFILE_RED       0
#define PROFILE_GREEN     1
#define PROFILE_BLUE      2
#define PROFILE_YELLOW    3
#define PROFILE_CYAN      4
#define PROFILE_MAGENTA   5
#define PROFILE_WHITE     6
 
/*============================================================================
 * Initialization
 *============================================================================*/

void profileInit(void);
 
/*============================================================================
 * Visual Color-Bar Profiling
 *
 * Sets the fixed color (COLDATA $2132) to show colored bands on screen.
 * The band width shows how much CPU time the section uses.
 * Multiple sections can use different colors to identify bottlenecks.
 *============================================================================*/

void profileColorStart(u16 color);

void profileColorEnd(void);
 
/*============================================================================
 * Scanline-Based Timing
 *============================================================================*/

u16 profileGetScanline(void);

void profileScanlineStart(void);

u16 profileScanlineEnd(void);
 
/*============================================================================
 * Frame Counters
 *============================================================================*/

u16 profileGetLagFrames(void);
 
#endif /* OPENSNES_PROFILE_H */