API Reference GE Extensions Client Client Canvas Manages the main game canvas (render window) creation and cursor visibility.
Manages the main game canvas (render window) creation and cursor visibility.
Property Value Source lua/ge/client/canvas.luaReturns Module table M Dependencies core_settings_graphic, scenetree
Field Type Description M.canvasCreatedboolean Guards against duplicate canvas creation
Function Args Returns Description M.createCanvaswindowPlacementGuiCanvas or nil Creates or finds the Canvas object, runs auto-detect graphics if enabled M.initializeCanvas- GuiCanvas or nil One-time canvas initialization; calls createCanvas, sets canvasCreated flag M.showCursor- - Unlocks mouse and shows cursor on the Canvas M.hideCursor- - Locks mouse and hides cursor on the Canvas
Object Name Type Purpose CanvasGuiCanvas Main render window / GUI canvas
-- Initialize the canvas during startup local canvas_module = require ( "client/canvas" ) canvas_module. initializeCanvas () -- Show/hide cursor for menu vs gameplay canvas_module. showCursor () -- Menu mode canvas_module. hideCursor () -- Gameplay mode Variable Usage $forceFullscreenWhen set, clears display output device preference $pref::Video::autoDetectTriggers automatic graphics quality detection
initializeCanvas can only be called once; subsequent calls log an error and return nil.Called by core.initializeCore() during engine startup.
If canvas creation fails, the engine calls quit().