Difference between revisions of "Sample Color (LogiX node)"
(Fix NodeMenu template link) |
(Marked this version for translation) |
||
Line 22: | Line 22: | ||
The color is sampled after applying all effects of lighting, shadows, emissives, alpha blending of materials etc. along the sampling direction. | The color is sampled after applying all effects of lighting, shadows, emissives, alpha blending of materials etc. along the sampling direction. | ||
+ | <!--T:6--> | ||
The <code>Reference</code> input is the slot in whose local coordinate space the Origin and Direction vectors are interpreted. This is the root slot by default, meaning the [[Coordinate spaces | global coordinate space]] is used. | The <code>Reference</code> input is the slot in whose local coordinate space the Origin and Direction vectors are interpreted. This is the root slot by default, meaning the [[Coordinate spaces | global coordinate space]] is used. | ||
+ | <!--T:7--> | ||
The <code>NearClip</code> input sets a lower bound on the distance at which objects will be included in the sampling. Anything closer to the input <code>Origin</code> than the <code>NearClip</code> value will be ignored. | The <code>NearClip</code> input sets a lower bound on the distance at which objects will be included in the sampling. Anything closer to the input <code>Origin</code> than the <code>NearClip</code> value will be ignored. | ||
+ | <!--T:8--> | ||
The <code>FarClip</code> input sets an upper bound on the distance at which objects will be included in the sampling. Anything further from the input <code>Origin</code> than the <code>FarClip</code> value will be ignored. | The <code>FarClip</code> input sets an upper bound on the distance at which objects will be included in the sampling. Anything further from the input <code>Origin</code> than the <code>FarClip</code> value will be ignored. | ||
+ | <!--T:9--> | ||
The <code>OnSampleStart</code> output fires an impulse when the sampling operation begins. This is the impulse passthrough output for the <code>Sample</code> input. Note that the <code>Color</code> output ''will not'' yet have the sampled color value! | The <code>OnSampleStart</code> output fires an impulse when the sampling operation begins. This is the impulse passthrough output for the <code>Sample</code> input. Note that the <code>Color</code> output ''will not'' yet have the sampled color value! | ||
+ | <!--T:10--> | ||
The <code>OnSampled</code> output fires an impulse when the sampling operation completes. The sampled color will be available from the <code>Color</code> output for the duration of the impulse chain stared by <code>OnSampled</code>. Note that other transient values available during the impulse chain which arrives at <code>Sample</code> and continues from <code>OnSampleStart</code> ''may not'' be available during the impulse chain initiated from <code>OnSampled</code>. | The <code>OnSampled</code> output fires an impulse when the sampling operation completes. The sampled color will be available from the <code>Color</code> output for the duration of the impulse chain stared by <code>OnSampled</code>. Note that other transient values available during the impulse chain which arrives at <code>Sample</code> and continues from <code>OnSampleStart</code> ''may not'' be available during the impulse chain initiated from <code>OnSampled</code>. | ||
Revision as of 04:44, 16 February 2022
Sample Color | ||
---|---|---|
Inputs | ||
Impulse | Sample | |
Float3 | Point | |
Float3 | Directtion | |
Slot | Reference | |
Float | NearClip | |
Float | FarClip | |
Outputs | ||
Impulse | OnSampleStart | |
Impulse | OnSampled | |
Color | Color |
The Sample Color outputs the visible color sampled in a line along the input Direction
vector from the input Origin
when an impulse is received at Sample
.
Usage
The color is sampled after applying all effects of lighting, shadows, emissives, alpha blending of materials etc. along the sampling direction.
The Reference
input is the slot in whose local coordinate space the Origin and Direction vectors are interpreted. This is the root slot by default, meaning the global coordinate space is used.
The NearClip
input sets a lower bound on the distance at which objects will be included in the sampling. Anything closer to the input Origin
than the NearClip
value will be ignored.
The FarClip
input sets an upper bound on the distance at which objects will be included in the sampling. Anything further from the input Origin
than the FarClip
value will be ignored.
The OnSampleStart
output fires an impulse when the sampling operation begins. This is the impulse passthrough output for the Sample
input. Note that the Color
output will not yet have the sampled color value!
The OnSampled
output fires an impulse when the sampling operation completes. The sampled color will be available from the Color
output for the duration of the impulse chain stared by OnSampled
. Note that other transient values available during the impulse chain which arrives at Sample
and continues from OnSampleStart
may not be available during the impulse chain initiated from OnSampled
.
Examples
Node Menu
Rendering | ||||||
---|---|---|---|---|---|---|
Back | Bake Reflection Probe | Bake Reflection Probes | Render To Texture Asset | Sample Color |