Singularity/Library/PackageCache/com.unity.shadergraph@12.1.11/Documentation~/Ambient-Node.md
2024-05-06 11:45:45 -07:00

1.9 KiB

Ambient Node

Description

Provides access to the Scene's Ambient color values. When Environment Lighting Source is set to Gradient Port Color/Sky returns the value Sky Color. When Environment Lighting Source is set to Color Port Color/Sky returns the value Ambient Color. Ports Equator and Ground always return the values Equator Color and Ground Color regardless of the current Environment Lighting Source.

Note: Values of this Node are only updated when entering Play mode or saving the current Scene/Project.

Note: The behavior of this Node is undefined globally. Shader Graph does not define the function of the node. Instead, each Render Pipeline defines what HLSL code to execute for this Node.

Different Render Pipelines may produce different results. If you're building a shader in one Render Pipeline that you want to use in both, try checking it in both pipelines before production. A Node might be defined in one Render Pipeline and undefined in the other. If this Node is undefined, it returns 0 (black).

Unity Render Pipelines Support

  • Universal Render Pipeline

The High Definition Render Pipeline does not support this Node.

Ports

Name Direction Type Binding Description
Color/Sky Output Vector 3 None Color (Color) or Sky (Gradient) color value
Equator Output Vector 3 None Equator (Gradient) color value
Ground Output Vector 3 None Ground (Gradient) color value

Generated Code Example

The following example code represents one possible outcome of this node.

float3 _Ambient_ColorSky = SHADERGRAPH_AMBIENT_SKY;
float3 _Ambient_Equator = SHADERGRAPH_AMBIENT_EQUATOR;
float3 _Ambient_Ground = SHADERGRAPH_AMBIENT_GROUND;