Component image
The DepthMaterial component renders everything behind it in black and white depending on how far away it is from the camera.
Fields
Name | Type | Description |
---|---|---|
persistent
|
Bool | Determines whether or not this item will be saved to the server. |
UpdateOrder
|
Int | Controls the order in which this component is updated. |
Enabled
|
Bool | Controls whether or not this component is enabled. |
HighPriorityIntegration
|
Bool | If true, integrating this asset (e.g. processing procedural assets) gets higher priority than assets with this flag off. An example is user laser procedural meshes. |
Rect
|
Rect | See RectClip on Materials. |
RectClip
|
Bool | Toggles if the material should use Rect
|
ColorMask
|
ColorMask | What colors behind the material should make it through the filter. |
StencilComparison
|
StencilComparison | See Type:StencilComparison for an in depth explanation on what this does. |
StencilOperation
|
StencilOperation | See Type:StencilOperation for an in depth explanation on what this does. |
StencilID
|
Byte | The Stencil ID of this material. This is sometimes written to the frame buffer's Stencil mask, or used to determine whether this material should render for a particular pixel. |
StencilWriteMask
|
Byte | does a Bitwise AND with this number for every pixel in the frame buffer this is rendering on top of when this object is drawn, after reading from the buffer. |
StencilReadMask
|
Byte | is bitwise ANDed with the Stencil in the frame buffer before the test compares them. |
RenderQueue
|
Int | changes at which point a material renders on the render stack |
_shader
|
Shader | Internal. |
Multiply
|
Float | how much to multiply the resulting color. |
Offset
|
Float | how much to add or remove from the resulting color. |
Clip
|
Bool | whether to clip the depth range. |
ClipStart
|
Float | the depth start value, which is the minimum distance from the camera which will be black. |
ClipEnd
|
Float | the depth end value, which is the maximum distance from the camera, which will be white. |
BlendMode
|
BlendMode | How to blend this material's colors vs what it rendered on top of. |
Sidedness
|
Sidedness | Render on both sides of the mesh, front, or back. |
ZWrite
|
ZWrite | whether this material should respect the distance it is from the camera. |
ZTest
|
ZTest | Determines whether this object should render when it is in front of or behind other objects that respect depth from the camera |
Usage
Attach to a slot and apply to a Component:MeshRenderer or Component:SkinnedMeshRenderer to see the visual effect this component makes.
Examples
Can be used to make a blindess or sonar effect.