Render Views

Provides a utility to create offscreen render views and save them to disk. Used for programmatic screenshots from arbitrary camera positions.

Public API

options Table

Internals

• Creates a RenderViewManagerInstance view with luaOwned = true for GC cleanup
• Builds a camera matrix from quaternion rotation + position
• Sets up a Frustum with the given FOV, aspect ratio, near/far planes
• Temporarily disables FXAA (if active) to avoid artifacts, re-enables after save
• Hides UI and gameplay markers during capture via ui_visibility and gameplay_markerInteraction
• Uses core_jobsystem to run the save asynchronously

How It Works

1. takeScreenshot creates or reuses a render view by name
2. Sets camera matrix, resolution, viewport, frustum, and named texture target
3. If FXAA is enabled, temporarily disables it
4. Spawns a job that:
   • Hides UI and markers
   • Sleeps for screenshotDelay
   • Calls renderView:saveToDisk(filename)
   • Destroys the render view
   • Restores UI, markers, and AA settings
   • Fires optional callback

Usage Examples

-- Take a screenshot from a specific camera position
render_renderViews.takeScreenshot({
  pos = vec3(100, 200, 50),
  rot = quat(0, 0, 0, 1),
  resolution = vec3(1920, 1080, 0),
  fov = 60,
  filename = "screenshots/myshot.png",
  screenshotDelay = 0.2,
}, function()
  log('I', '', 'Screenshot saved!')
end)

Key Notes

• Render view is destroyed after each screenshot (not reused)
• Far clip is hardcoded to 2000 units
• Editor icons are disabled in the render view (renderEditorIcons = false)
• The named texture target must match the render view name for correct output

See Also

• Render HDR - Post-Effect Pipeline Initialization - Related reference
• Render OpenXR - VR/XR Runtime Management - Related reference
• Render View Demo - Render View Usage Example - Related reference
• Game Engine Overview - Guide