KanikamaGI logo
  • English

Outline

BakeTarget and LightSource

In Kanikama, there are BakeTarget and LightSource components for light sources.

  • BakeTarget: for baking lightmaps in Unity Editor.
  • LightSource: for getting colors of light sources at runtime.

For each light sources, you will add a BakeTarget and a LightSource components to its GameObject:

UnityBakeryBakeTargetLightSourceLightSource (U#)
Light-KanikamaBakeTargetLightKanikamaRuntimeLightKanikamaUdonLight
Renderer-KanikamaBakeTargetLightMeshKanikamaRuntimeLightMeshKanikamaUdonLightMesh
LightBakeryPointLightKanikamaBakeryPointLightKanikamaRuntimeLightKanikamaUdonLight
LightBakeryDirectLightKanikamaBakeryDirectLightKanikamaRuntimeLightKanikamaUdonLight
LightBakeryLightMeshKanikamaBakeryAreaLightKanikamaRuntimeLightKanikamaUdonLight
RendererBakeryLightMeshKanikamaBakeryLightMeshKanikamaRuntimeLightMeshKanikamaUdonLightMesh
LightBakerySkyLightKanikamaBakerySkyLightKanikamaRuntimeLightKanikamaUdonLight

BakeTargetGroup and LightSourceGroup are components for light sources that require baking lightmaps multiple times, for example, texture lights (monitors).

BakeTargetLightSourceLightSource (U#)
KanikamaBakeTargetMonitorGroupKanikamaRuntimeMonitorCameraKanikamaUdonMonitorCamera

Note that you can also create your own components inheriting BakeTarget or LightSource.

BakeTarget Descriptor

To describe BakeTargets in your Scene, you need to create a KanikamaBakeTargetDescriptor object in your Scene and specify BakeTargets and BakeTargetGroups in the Inspector window.

GI Updater

To update GI at runtime, you also need a GI Updater component. There are two built-in GI updater components:

namelangnoteprefab path
KanikamaRuntimeGIUpdaterC#Works with Built-in RP and URPPackages/Kanikama/Runtime/Application/Prefabs/KanikamaRuntimeGIUpdater.prefab
KanikamaUdonGIUpdaterU#Works in VRChatPackages/Kanikama Udon/Runtime/Prefabs/KanikamaUdonGIUpdater.prefab