dolphin.lightlab · class ·

dolphinGpuProfiler

A dolphin gpu profiler record carrying recording, frames.

classcpudolphindolphin.lightlablightlabmethodsource-example

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

external class dolphinGpuProfiler

Status: source-declared

Fields and methods (20)
bool recording
Stores recording as bool.
list of dolphinGpuFrameSample frames
Stores frames as list of dolphinGpuFrameSample.
dolphinGpuProfiler()
Dolphin gpu profiler.
BeginFrame(int width,int height,int maxBounces,int sceneRevision) returns bool
Begin frame. Complete example
SetContext(int flags,int shapes,int lights)
Set context. Complete example
SetPipeline(int mask)
Set pipeline. Complete example
SetBatches(bool scene,bool game)
Set batches. Complete example
SetEffects(text scene,text game)
Set effects. Complete example
SetPipelines(int sceneMask,int gameMask)
Set pipelines. Complete example
RecordPass(int viewId,int passId,int wallMicros,int gpuMicros,int logicalBytes) returns bool
Record pass. Complete example
AppendPass(int viewId,int passId,int wallMicros,int gpuMicros,int logicalBytes) returns bool
Append pass. Complete example
RecordCustomPass(int viewId,text label,text source,text symbol,int wallMicros,int gpuMicros,int logicalBytes) returns bool
Record custom pass. Complete example
RecordCpuPass(int viewId,text label,text source,text symbol,int wallMicros,int logicalBytes) returns bool
Record cpu pass. Complete example
BeginBatchCounters()
Begin batch counters. Complete example
CompleteBatch(int first,int viewId)
Complete batch. Complete example
EndFrame(int frameWallMicros) returns bool
End frame. Complete example
At(int chronologicalIndex) returns dolphinGpuFrameSample
At. Complete example
Latest() returns dolphinGpuFrameSample
Latest. Complete example
Percentile(int percentile) returns int
Percentile. Complete example
Slowest() returns int
Slowest. Complete example

Use dolphinGpuProfiler

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.
dolphinGpuProfiler sample = dolphinGpuProfiler()
Console.Log(Text.From(sample.recording))
project.mech
manifestVersion = "2"
package = "api.example.dolphin_lightlab__dolphingpuprofiler"
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"

dolphinGpuProfiler.BeginFrame

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.lightlab

// Begin frame.
dolphinGpuProfiler instance = dolphinGpuProfiler()
int argument_width = 1
int argument_height = 1
int argument_maxBounces = 1
int argument_sceneRevision = 1
bool result = instance.BeginFrame(argument_width, argument_height, argument_maxBounces, argument_sceneRevision)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.dolphin_lightlab__dolphingpuprofiler"
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"

dolphinGpuProfiler.SetContext

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.lightlab

// Set context.
dolphinGpuProfiler instance = dolphinGpuProfiler()
int argument_flags = 1
int argument_shapes = 1
int argument_lights = 1
instance.SetContext(argument_flags, argument_shapes, argument_lights)
Console.Log("SetContext completed")
project.mech
manifestVersion = "2"
package = "api.example.dolphin_lightlab__dolphingpuprofiler"
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"

dolphinGpuProfiler.SetPipeline

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.lightlab

// Set pipeline.
dolphinGpuProfiler instance = dolphinGpuProfiler()
int argument_mask = 1
instance.SetPipeline(argument_mask)
Console.Log("SetPipeline completed")
project.mech
manifestVersion = "2"
package = "api.example.dolphin_lightlab__dolphingpuprofiler"
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"

dolphinGpuProfiler.SetBatches

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.lightlab

// Set batches.
dolphinGpuProfiler instance = dolphinGpuProfiler()
bool argument_scene = true
bool argument_game = true
instance.SetBatches(argument_scene, argument_game)
Console.Log("SetBatches completed")
project.mech
manifestVersion = "2"
package = "api.example.dolphin_lightlab__dolphingpuprofiler"
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"

dolphinGpuProfiler.SetEffects

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.lightlab

// Set effects.
dolphinGpuProfiler instance = dolphinGpuProfiler()
text argument_scene = "argument scene"
text argument_game = "argument game"
instance.SetEffects(argument_scene, argument_game)
Console.Log("SetEffects completed")
project.mech
manifestVersion = "2"
package = "api.example.dolphin_lightlab__dolphingpuprofiler"
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"

dolphinGpuProfiler.SetPipelines

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.lightlab

// Set pipelines.
dolphinGpuProfiler instance = dolphinGpuProfiler()
int argument_sceneMask = 1
int argument_gameMask = 1
instance.SetPipelines(argument_sceneMask, argument_gameMask)
Console.Log("SetPipelines completed")
project.mech
manifestVersion = "2"
package = "api.example.dolphin_lightlab__dolphingpuprofiler"
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"

dolphinGpuProfiler.RecordPass

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.lightlab

// Record pass.
dolphinGpuProfiler instance = dolphinGpuProfiler()
int argument_viewId = 1
int argument_passId = 1
int argument_wallMicros = 1
int argument_gpuMicros = 1
int argument_logicalBytes = 4
bool result = instance.RecordPass(argument_viewId, argument_passId, argument_wallMicros, argument_gpuMicros, argument_logicalBytes)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.dolphin_lightlab__dolphingpuprofiler"
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"

dolphinGpuProfiler.AppendPass

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.lightlab

// Append pass.
dolphinGpuProfiler instance = dolphinGpuProfiler()
int argument_viewId = 1
int argument_passId = 1
int argument_wallMicros = 1
int argument_gpuMicros = 1
int argument_logicalBytes = 4
bool result = instance.AppendPass(argument_viewId, argument_passId, argument_wallMicros, argument_gpuMicros, argument_logicalBytes)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.dolphin_lightlab__dolphingpuprofiler"
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"

dolphinGpuProfiler.RecordCustomPass

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.lightlab

// Record custom pass.
dolphinGpuProfiler instance = dolphinGpuProfiler()
int argument_viewId = 1
text argument_label = "argument label"
text argument_source = "argument source"
text argument_symbol = "argument symbol"
int argument_wallMicros = 1
int argument_gpuMicros = 1
int argument_logicalBytes = 4
bool result = instance.RecordCustomPass(argument_viewId, argument_label, argument_source, argument_symbol, argument_wallMicros, argument_gpuMicros, argument_logicalBytes)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.dolphin_lightlab__dolphingpuprofiler"
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"

dolphinGpuProfiler.RecordCpuPass

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.lightlab

// Record cpu pass.
dolphinGpuProfiler instance = dolphinGpuProfiler()
int argument_viewId = 1
text argument_label = "argument label"
text argument_source = "argument source"
text argument_symbol = "argument symbol"
int argument_wallMicros = 1
int argument_logicalBytes = 4
bool result = instance.RecordCpuPass(argument_viewId, argument_label, argument_source, argument_symbol, argument_wallMicros, argument_logicalBytes)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.dolphin_lightlab__dolphingpuprofiler"
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"

dolphinGpuProfiler.BeginBatchCounters

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.lightlab

// Begin batch counters.
dolphinGpuProfiler instance = dolphinGpuProfiler()
instance.BeginBatchCounters()
Console.Log("BeginBatchCounters completed")
project.mech
manifestVersion = "2"
package = "api.example.dolphin_lightlab__dolphingpuprofiler"
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"

dolphinGpuProfiler.CompleteBatch

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.lightlab

// Complete batch.
dolphinGpuProfiler instance = dolphinGpuProfiler()
int argument_first = 1
int argument_viewId = 1
instance.CompleteBatch(argument_first, argument_viewId)
Console.Log("CompleteBatch completed")
project.mech
manifestVersion = "2"
package = "api.example.dolphin_lightlab__dolphingpuprofiler"
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"

dolphinGpuProfiler.EndFrame

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.lightlab

// End frame.
dolphinGpuProfiler instance = dolphinGpuProfiler()
int argument_frameWallMicros = 1
bool result = instance.EndFrame(argument_frameWallMicros)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.dolphin_lightlab__dolphingpuprofiler"
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"

dolphinGpuProfiler.At

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.lightlab

// At.
dolphinGpuProfiler instance = dolphinGpuProfiler()
int argument_chronologicalIndex = 1
dolphinGpuFrameSample result = instance.At(argument_chronologicalIndex)
Console.Log("Inspect result in your debugger")
project.mech
manifestVersion = "2"
package = "api.example.dolphin_lightlab__dolphingpuprofiler"
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"

dolphinGpuProfiler.Latest

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.lightlab

// Latest.
dolphinGpuProfiler instance = dolphinGpuProfiler()
dolphinGpuFrameSample result = instance.Latest()
Console.Log("Inspect result in your debugger")
project.mech
manifestVersion = "2"
package = "api.example.dolphin_lightlab__dolphingpuprofiler"
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"

dolphinGpuProfiler.Percentile

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.lightlab

// Percentile.
dolphinGpuProfiler instance = dolphinGpuProfiler()
int argument_percentile = 1
int result = instance.Percentile(argument_percentile)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.dolphin_lightlab__dolphingpuprofiler"
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"

dolphinGpuProfiler.Slowest

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.lightlab

// Slowest.
dolphinGpuProfiler instance = dolphinGpuProfiler()
int result = instance.Slowest()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.dolphin_lightlab__dolphingpuprofiler"
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"
Notes and source

Package presence and a declaration do not establish support on every host. Host services need their platform and lifecycle setup.

dolphin/packages/lightlab/src/gpu_profile.yh:88