86 lines
3.1 KiB
C
86 lines
3.1 KiB
C
// SPDX-FileCopyrightText: 2026 Erin Catto
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
// Text label storage, world space and screen space.
|
|
//
|
|
// Pure C so the box3d adapter (also C) can submit labels via DrawString, and
|
|
// the unit test for the projection helper can pull this in without ImGui.
|
|
// The renderer doesn't rasterize text itself: labels accumulate in a fixed
|
|
// per-frame array, ResetTextArena clears the array at the start of each
|
|
// frame (called from ResetFrameArena), and the GUI shell drains the
|
|
// array after the scene renders. World entries project to screen pixels
|
|
// with the last rendered camera, screen entries pass through their pixel
|
|
// position as-is, both emit via ImGui's background draw list. That means
|
|
// labels only appear when the app runs through StartUIFrame,
|
|
// RenderFrameOffscreen alone is not a label-rendering path.
|
|
|
|
#pragma once
|
|
|
|
#include "gfx/projection.h"
|
|
#include "gfx/utility.h"
|
|
|
|
#include <stdbool.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C"
|
|
{
|
|
#endif
|
|
|
|
// Whether an entry carries a world position to project or a screen pixel to
|
|
// use directly.
|
|
typedef enum TextSpace
|
|
{
|
|
TEXT_SPACE_WORLD = 0,
|
|
TEXT_SPACE_SCREEN = 1,
|
|
} TextSpace;
|
|
|
|
typedef struct TextEntry
|
|
{
|
|
TextSpace space;
|
|
b3Vec3 worldPos; // valid when space == TEXT_SPACE_WORLD
|
|
int screenX; // framebuffer pixels, origin top-left, when space == TEXT_SPACE_SCREEN
|
|
int screenY;
|
|
Vec4 color; // linear RGBA, bytes pass through to ImGui as-is
|
|
const char* text; // points into the per-frame text arena, NUL-terminated
|
|
} TextEntry;
|
|
|
|
// Submit a UTF-8 string at a world-space position. Text is copied into the
|
|
// per-frame text arena and truncated to fit (current cap: 63 chars + NUL).
|
|
// Color is linear RGBA. Logs and drops on overflow.
|
|
void DrawString( b3Vec3 worldPos, Vec4 color, const char* text );
|
|
|
|
// Submit a UTF-8 string at a screen-pixel position (origin top-left, Y down,
|
|
// framebuffer pixels). Same copy/truncation/overflow rules as DrawString.
|
|
void DrawScreenString( int x, int y, Vec4 color, const char* text );
|
|
|
|
B3_PRINTF_FORMAT( 4, 5 )
|
|
void DrawScreenStringFormat( int x, int y, Vec4 color, const char* fmt, ... );
|
|
|
|
// Iteration surface for the GUI shell. Pointers/strings are valid until
|
|
// the next ResetTextArena (called by ResetFrameArena, which the GUI shell
|
|
// invokes each frame). Caller is expected to honor 0 <= i < count.
|
|
int GetTextCount( void );
|
|
const TextEntry* GetTextAt( int i );
|
|
|
|
// Wipe the per-frame text array. Called from ResetFrameArena.
|
|
void ResetTextArena( void );
|
|
|
|
// Resolve an entry to its screen-pixel position. Screen entries pass through;
|
|
// world entries project through view/proj for the given viewport. Returns
|
|
// false (leaving outputs untouched) when a world entry is off-frustum or
|
|
// behind the camera, matching ProjectWorldToScreen.
|
|
static inline bool ResolveTextScreenPos( const TextEntry* e, Mat4 view, Mat4 proj, int viewportW, int viewportH,
|
|
float* outScreenX, float* outScreenY )
|
|
{
|
|
if ( e->space == TEXT_SPACE_SCREEN )
|
|
{
|
|
*outScreenX = (float)e->screenX;
|
|
*outScreenY = (float)e->screenY;
|
|
return true;
|
|
}
|
|
return ProjectWorldToScreen( view, proj, viewportW, viewportH, e->worldPos, outScreenX, outScreenY );
|
|
}
|
|
|
|
#ifdef __cplusplus
|
|
} // extern "C"
|
|
#endif
|