dolphin.lightlab · function ·

DolphinLocalLightVisibility

Dolphin local light visibility.

cpudolphindolphin.lightlabfunctionlightlabsource-example

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

external DolphinLocalLightVisibility(dolphinLightWorld world,dolphinLocalLight light,float x,float y,float z,float nx,float ny,float nz,int sample,int pixel,int depth,int lightIndex) returns float

Status: source-declared

Parameters

dolphinLightWorld world
Supply world as dolphinLightWorld.
dolphinLocalLight light
Supply light as dolphinLocalLight.
float x
Supply x as float.
float y
Supply y as float.
float z
Supply z as float.
float nx
Supply nx as float.
float ny
Supply ny as float.
float nz
Supply nz as float.
int sample
Supply sample as int.
int pixel
Supply pixel as int.
int depth
Supply depth as int.
int lightIndex
Supply light index as int.

Use DolphinLocalLightVisibility

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.
dolphinLightWorld world = dolphinLightWorld()
dolphinLocalLight light = dolphinLocalLight(1, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0)
float x = 1.0
float y = 1.0
float z = 1.0
float nx = 1.0
float ny = 1.0
float nz = 1.0
int sample = 1
int pixel = 1
int depth = 1
int lightIndex = 1
float result = DolphinLocalLightVisibility(world, light, x, y, z, nx, ny, nz, sample, pixel, depth, lightIndex)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.dolphin_lightlab__dolphinlocallightvisibility"
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/local_lights.yh:84