기술 자료

Unity Engine

User Manual

Script Reference

Unity Engine

Properties block reference in ShaderLab

Reference for the Properties block in ShaderLab.
읽는 시간 6분최근 업데이트: 23일 전
중요
The Built-In Render Pipeline is deprecated and will be made obsolete in a future release.
It remains supported, including bug fixes and maintenance, through the full Unity 6.7 LTS lifecycle.
For more information on migration, refer to Migrating from the Built-In Render Pipeline to the Universal Render Pipeline and Render pipeline feature comparison.
This page contains information on using a 
Properties
block in your ShaderLab code to define material properties for a Shader object.

Render pipeline compatibility

Feature name

Universal Render Pipeline (URP)

High Definition Render Pipeline (HDRP)

Custom SRP

Built-in Render Pipeline

ShaderLab: Properties blockYes
In your HLSL code, you must put per-material variables in the same 
CBUFFER
for SRP Batcher compatibility.		Yes
In your HLSL code, you must put per-material variables in the same 
CBUFFER
for SRP Batcher compatibility.		Yes
In your HLSL code, you must put per-material variables in the same 
CBUFFER
for SRP Batcher compatibility.		Yes
For more information about using a 
CBUFFER
block, refer to Write an unlit shader with color input in URP.

Syntax

Signature

Function

Properties

{

    
<Material property declaration>

    
<Material property declaration>

}
Saves the given properties as part of the material asset, and uses the values stored in the material asset during rendering.
A 
Properties
block can contain any number of material property declarations.

Material property declarations

All material property declarations follow this basic format:
[optional: attribute] name("display text in Inspector", type name) = default value
The exact syntax varies by type.
This section contains information on:

Material property declaration syntax by type

The type name and the syntax for the default value depend on the type of the property.
In shader code, it is conventional to begin all property names with an underscore character. The examples on this page follow this convention.

Type

Example syntax

Comment

Integer
_ExampleName ("Integer display name", Integer) = 1
This type is backed by a real integer (unlike the legacy 
Int
type described below, which is backed by a float). Use this instead of Int when you want to use an integer.
Int (legacy)
_ExampleName ("Int display name", Int) = 1
Note: This legacy type is backed by a float, rather than an integer. It is supported for backwards compatibility reasons only. Use the 
Integer
type instead.
Float
_ExampleName ("Float display name", Float) = 0.5


_ExampleName ("Float with range", Range(0.0, 1.0)) = 0.5
The maximum and minimum values for the range slider are inclusive.
Texture2D
_ExampleName ("Texture2D display name", 2D) = "" {}


_ExampleName ("Texture2D display name", 2D) = "red" {}
Put the following values in the default value string to use one of Unity's built-in textures: “white” (RGBA: 1,1,1,1), “black” (RGBA: 0,0,0,1), “gray” (RGBA: 0.5,0.5,0.5,1), “bump” (RGBA: 0.5,0.5,1,1) or “red” (RGBA: 1,0,0,1).

If you leave the string empty or enter an invalid value, it defaults to "gray".

Note: these default textures are not visible in the Inspector.
Texture2DArray
_ExampleName ("Texture2DArray display name", 2DArray) = "" {}
For more information, see Texture arrays.
Texture3D
_ExampleName ("Texture3D", 3D) = "" {}
The default value is a "gray" (RGBA: 0.5,0.5,0.5,1) texture.
Cubemap
_ExampleName ("Cubemap", Cube) = "" {}
The default value is a "gray" (RGBA: 0.5,0.5,0.5,1) texture.
CubemapArray
_ExampleName ("CubemapArray", CubeArray) = "" {}
See Cubemap arrays.
Color
_ExampleName("Example color", Color) = (.25, .5, .5, 1)
This maps to a float4 in your shader code.

The Material Inspector displays a color picker. If you would rather edit the values as four individual floats, use the Vector type.
Vector
_ExampleName ("Example vector", Vector) = (.25, .5, .5, 1)
This maps to a float4 in your shader code.

The Material Inspector displays four individual float fields. To display a different number of fields, add 
2
, 
3
, or 
4
as an additional property after 
Vector
. For example 
_ExampleName ("Example vector", Vector, 2) = (.25, .5, .5, 1)
displays only the x and y components. You must still define all four components.

If you would rather edit the values using a color picker, use the Color type.>

Reserved material property names

Unity has some reserved names for material properties. When you create a material property with one of these names, Unity performs predefined operations. Do not use these names unless you intend to use this functionality.

Name

Example syntax

Function

_Color
_Color ("Main Color", Color) = (1,1,1,1)
Unity considers a color with this name as the main color for a material. Use the MainColor attribute to specify a different property as the main color.
_BaseMap
_BaseMap ("Base Map", 2D) = "white" {}
In the Universal Render Pipeline, Unity considers a texture with this name as the main texture for a material. Use the MainTexture attribute to specify a different property as the main texture.
_MainTex
_MainTex ("Main Texture", 2D) = "white" {}
In the Built-In Render Pipeline, Unity considers a texture with this name as the main texture for a material. Use the MainTexture attribute to specify a different property as the main texture.
_TransparencyLM
_TransparencyLM ("Transmissive Texture", 2D) = "white" {}
In the Built-In Render Pipeline, enables custom RGB transparency during lightmapping.

For more information, see Lightmapping and shaders.

Material property attributes

Material property declarations can have an optional attribute that tells Unity how to handle them.
In addition to the attributes listed here, you can use the same syntax to add a MaterialPropertyDrawer to a material property. These let you control how material properties appear in the Inspector window.

Attribute

Function

[Gamma]
Indicates that a float or vector property uses sRGB values, which means that it must be converted along with other sRGB values if the color space in your project requires this. For more information, see Properties in Shader Programs.
[HDR]
Indicates that a texture or color property uses high dynamic range (HDR) values.

For texture properties, the Unity Editor displays a warning if an LDR texture is assigned. For color properties, the Unity Editor uses the HDR color picker to edit this value.
[HideInInspector]
Tells the Unity Editor to hide this property in the Inspector.
[MainTexture]
Sets the main texture for a Material, which you can access using Material.mainTexture.

By default, Unity considers a texture with the property name 
_BaseMap
or 
_MainTex
as the main texture. Use this attribute if your texture has a different property name, but you want Unity to consider it the main texture.

If you use this attribute more than once, Unity uses the first property and ignores subsequent ones.

Note: When you set the main texture using this attribute, the texture isn't visible in the Game view when you use the texture mipmap streaming debugging view mode, or a custom debug tool.
[MainColor]
Sets the main color for a Material, which you can access using Material.color.

By default, Unity considers a color with the property name 
_Color
as the main color. Use this attribute if your color has a different property name, but you want Unity to consider it the main color. If you use this attribute more than once, Unity uses the first property and ignores subsequent ones.
[NoScaleOffset]
Tells the Unity Editor to hide tiling and offset fields for this texture property.
[Normal]
Indicates that a texture property expects a normal map.

The Unity Editor displays a warning if you assign an incompatible texture.
[PerRendererData]
Indicates that a texture property will be coming from per-renderer data in the form of a MaterialPropertyBlock.

The Material inspector shows these properties as read-only.

Additional resources