Bake Reflection Probes (LogiX node)

From Neos Wiki
Jump to navigation Jump to search
Other languages:
English • ‎日本語
Bake Reflection Probes
'Bake Reflection Probes' LogiX node
Inputs
  Impulse Bake
  Slot Root
  Bool BakeInactive
  String FilterWithTag
  Float DelayBeforeBake
Outputs
  Impulse OnBakeBatchStart
  Impulse OnBeforeProbeBake
  Impulse OnProbeBaked
  Impulse OnBakeBatchFinished
  Bool IsBaking
  ReflectionProbe CurrentProbe
  Int CurrentProbeIndex
  Int CurrentProbeCount

The Bake Reflection Probes node will (re-)bake the cubemaps for all ReflectionProbe components under the input Root slot's heirarchy when an impulse is received at Bake.

Usage

The Root input defines the slot hierarchy which will be searched for ReflectionProbe components to bake. Default is the world root slot.


The BakeInactive input determines whether disabled ReflectionProbe components, or ones present on inactive slots, will be baked. Default is false.


The FilterWithTag input determines can be used to only bake ReflectionProbes on slots with an exactly matching tag. This is empty by default which results in no tag-based filtering.


The DelayBeforeBake input determines the delay between baking successive ReflectionProbes in seconds. Default is 0.25 seconds.


The OnBakeBatchStart output fires an impulse when baking starts. No impulse will be fired if there is no valid (or empty) Root input, however it is not required that there be any valid ReflectionProbes to bake for an impulse to be fired.


The OnBakeBatchStart output fires an impulse immediately before the batch baking starts. No impulse will be fired if there is no valid (or empty) Root input, however it is not required that there be any valid ReflectionProbes to bake for an impulse to be fired.


The OnBeforeProbeBake output fires an impulse immediately before baking begins for each ReflectionProbe.


The OnProbeBaked output fires an impulse after each individual ReflectionProbe has been baked.


The OnBakeBatchFinished output fires an impulse after all valid ReflectionProbes have been baked.


The IsBaking output indicates whether a batch baking operation is in progress.


The CurrentProbe output provides the ReflectionProbe component which is currently being processed. This value is only available during the impulse chains started from OnBeforeProbeBake and OnProbeBaked.


The CurrentProbeIndex output provides the index of the ReflectionProble currently being processed. This value is 0 for the first probe baked in the batch, 1 for the next one and so on. The value from this output is 0 during the impulse chain started from OnBakeBatchStart and equal to the maximum index during the impulse chain started from OnBakeBatchFinished. The value will be correct for the specific ReflectionProbe processed during the impulse chains started from OnBeforeProbeBake and OnProbeBaked.


The CurrentProbeCount output provides the total number of ReflectionProbes which will be baked during the batch. This value is available during the impulse chains started from OnBeforeProbeBake, OnProbeBaked, and OnBakeBatchFinished.


Note that the node will not initate another baking batch if one is currently in progress.

Examples

Node Menu

Rendering
Back Bake Reflection Probe Bake Reflection Probes Render To Texture Asset Sample Color