dolphin.lightlab · class · Updated 2026-09-09

dolphinGpuView

A dolphin gpu view record carrying pixels, geometry, previousGeometry, historyA, historyB, and related state.

classcpudolphindolphin.lightlablightlabmethodsource-example

Build bounded lighting experiments with geometry, visibility, transport, film, and GPU/CPU contracts.

external class dolphinGpuView

Status: source-declared

Fields and methods (51)

buffer of int pixels: Stores pixels as buffer of int.
buffer of float geometry: Stores geometry as buffer of float.
buffer of float previousGeometry: Stores previous geometry as buffer of float.
buffer of float historyA: Stores history a as buffer of float.
buffer of float historyB: Stores history b as buffer of float.
buffer of float scene: Stores scene as buffer of float.
buffer of float materials: Stores materials as buffer of float.
buffer of float camera: Stores camera as buffer of float.
buffer of float particles: Stores particles as buffer of float.
bool glowEnabled: Stores glow enabled as bool.
bool batchEnabled: Stores batch enabled as bool.
buffer of float localLights: Stores local lights as buffer of float.
buffer of float coverageHistory: Stores coverage history as buffer of float.
bool coverageAntialiasing: Stores coverage antialiasing as bool.
int pipelineMask: Stores pipeline mask as int.
bool separateLighting: Stores separate lighting as bool.
float previousTime: Stores previous time as float.
buffer of int reuseFlags: Stores reuse flags as buffer of int.
buffer of float rawIndirect: Stores raw indirect as buffer of float.
text environmentKey: Stores environment key as text.
buffer of float noSurfaceRays: Stores no surface rays as buffer of float.
dolphinGpuReuse reuse: Stores reuse as dolphinGpuReuse.
dolphinGpuSpatialResolver spatialResolver: Stores spatial resolver as dolphinGpuSpatialResolver.
bool reuseReady: Stores reuse ready as bool.
int width: Stores width as int.
int imageWidth: Stores image width as int.
float previousX: Stores previous x as float.
float previousYaw: Stores previous yaw as float.
bool previousCamera: Stores previous camera as bool.
int steadyFrames: Stores steady frames as int.
int cacheUses: Stores cache uses as int.
dolphinGpuView(): Dolphin gpu view.
ProfilePass(int id,int began,int gpu,int bytes): Profile pass. Complete example
Begin(int width,int height) returns bool: Begin. Complete example
BeginRegion(int width,int height,int imageWidth,int imageHeight,int originX,int originY) returns bool: Begin region. Complete example
Reset(): Reset. Complete example
InvalidateHistory(): Invalidate history. Complete example
PrepareSamples() returns bool: Prepare samples. Complete example
PackMaterials(int revision): Pack materials. Complete example
ConfigureEnvironment(dolphinLightWorld world) returns bool: Configure environment. Complete example
PrepareEnvironment(dolphinLightWorld world) returns bool: Prepare environment. Complete example
PackScene(dolphinLightWorld world,int revision) returns bool: Pack scene. Complete example
CoverageMode(float x,float y,float z,float yaw,float pitch,float fov,int revision,bool animated) returns int: Coverage mode. Complete example
PackCamera(float x,float y,float z,float yaw,float pitch,float fov): Pack camera. Complete example
Glow() returns bool: Glow. Complete example
PostEffects() returns bool: Post effects. Complete example
ImageSettings() returns text: Image settings. Complete example
SameImage(dolphinLightWorld world,float x,float y,float z,float yaw,float pitch,float fov,int revision) returns bool: Same image. Complete example
RenderIfNeeded(dolphinLightWorld world,float x,float y,float z,float yaw,float pitch,float fov,int revision,text presentation,bool reuse) returns bool: Render if needed. Complete example
Render(dolphinLightWorld world,float x,float y,float z,float yaw,float pitch,float fov,int sceneRevision) returns bool: Render. Complete example
RenderCommands(dolphinLightWorld world,float x,float y,float z,float yaw,float pitch,float fov,int sceneRevision) returns bool: Render commands. Complete example

Use dolphinGpuView

A complete small caller. Values are illustrative; check the returned result and package requirements before connecting live resources.

cpu · source-example · type checked

using dolphin.lightlab

// Build bounded lighting experiments with geometry, visibility, transport, film, and GPU/CPU contracts.
dolphinGpuView sample = dolphinGpuView()
Console.Log(Text.From(sample.glowEnabled))

project.mech

manifestVersion = "2"
package = "api.example.dolphin_lightlab__dolphingpuview"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.lightlab"
version = "0.1.0"
path = "../../../dolphin/packages/lightlab"

[[dependencies]]
package = "dolphin.materials"
version = "0.1.0"
path = "../../../dolphin/packages/materials"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"