Returns the ID of the currently active canvas render target.
Takes no parameters.
Returns g_activeCanvasID value directly.
BGI GUI
Parameters & Returns
Parameters
This function takes no parameters.
Returns
Int
Quick Summary
Returns the ID of the currently active canvas render target.
Takes no parameters.
Returns g_activeCanvasID value directly.
Technical Exegesis...
Returns the ID of the currently active canvas render target. Returns g_activeCanvasID value directly. Returns -1 for main window, canvas ID (>0) for specific canvas, or 0 if no render target active.
This function queries which render target is receiving 3D rendering commands. g_activeCanvasID is set by bgiSetActiveCanvas. -1 indicates main window (default). Canvas IDs are positive integers from bgiCreateCanvas3D. Returns current state immediately (no validation or map lookup).
Returns the ID of the currently active canvas render target. Returns g_activeCanvasID value directly. Returns -1 for main window, canvas ID (>0) for specific canvas, or 0 if no render target active.
This function queries which render target is receiving 3D rendering commands. g_activeCanvasID is set by bgiSetActiveCanvas. -1 indicates main window (default). Canvas IDs are positive integers from bgiCreateCanvas3D. Returns current state immediately (no validation or map lookup). Use to determine rendering context before issuing draw commands. Common pattern: check active canvas, render differently based on viewport. Pair with bgiSetActiveCanvas to save/restore active canvas state. Does not indicate focus - use bgiGetFocusedCanvas for input focus.