User Material File Format

A version of the *.mat file.

The unique name of the material. For manual materials, the name is used as identifier for the material: by using it, the material's GUID is generated in run-time.

The GUID of the user material. For manual materials, the name is used instead of the GUID.

a GUID of a parent material.

A name of a parent material. The attribute is used when the parent material is the manual user material.

The name of a base material. The base material will be used as the parent one if the parent material isn't loaded.

If the parent has another base material, it will be changed to the specified one.

A flag, indicating if settings of the material can be changed in the Parameters window or via API.

Available values:

• 0 - unchangeable
• 1 - changeable (by default)

A flag, indicating if a material is displayed in the Materials Hierarchy.

Available values:

• 0 - displayed (by default)
• 1  -  hidden

A flag, indicating if a material is manual: created or edited manually, not via UnigineEditor.

Available values:

• 0 - manual (by default)
• 1  -  not manual

For example, the displayed unchangeable material named user_material_0 and inherited from the mesh_base_0 user material will be as follows:

<material version="2.7.3.0" name="user_material_0" parent="3e7f5c9535777e15966cb5f915d25b62620b2bef" base_material="mesh_base" editable="0">
...
</material>

A polygon color (source image) and a screen buffer color (destination image) multipliers.

Available values for both attributes:

• none - blending is not used.
• zero - RGBA components of the source/destination image color are multiplied by zero.
• one - RGBA components of the source/destination image color are multiplied by one.
• src_color - RGBA components of the source/destination image color are multiplied by the mR, mG, mB, mA components (per component).
• one_minus_src_color - RGBA components of the source/destination image color are multiplied by the 1 -  mR , 1 -  mG , 1 -  mB , 1 -  mA components (per component).
• src_alpha - RGBA components of the source/destination image color are multiplied by the mA component.
• one_minus_src_alpha - RGBA components of the source/destination image color are multiplied by the 1 -  mA component.
• dest_color - RGBA components of the source/destination image color are multiplied by the bR, bG, bB, bA components (per component).
• one_minus_dest_color - RGBA components of the source/destination image color are multiplied by the 1 -  bR , 1 -  bG , 1 -  bB , 1 -  bA components (per component).
• dest_alpha - RGBA components of the source/destination image color are multiplied by the bA component.
• one_minus_dest_alpha - RGBA components of the source/destination image color are multiplied by the 1 -  bA component.

  Where mR, mG, mB, mA are normalized Red, Blue, Green and Alpha material image channels;
  bR, bG, bB, bA are normalized Red, Blue, Green and Alpha background image channels.

For example, the user material that has the opaque areas receiving a material color and transparent areas receiving a screen buffer color will have the following element:

<blend src="one" dest="one_minus_src_alpha"/>

In the Parameters window, the blending option value can be set in the Transparency group of the Common tab.

Rendering order of the material. Specifies the priority of the material rendering inside the group.

Available values:

• -128 - 127. The default value is 0. The higher the rendering order, the lower the rendering priority (the material with the -128 order will be rendered first).

Polygon offset of the material. Can be useful to prevent a Z-fighting effect.

Available values:

• 0 - 1024 (powers of 2). The default value is 0.

A shadow mask used to control shadows cast by an object lit by light sources.

Available values:

• Integer, representing a mask. The default value is ~0.

A viewport mask.

Available values:

• Integer, representing a mask. The default value is ~0.

A flag indicating whether the material is transparent.

Available values:

• 0 - the material is opaque
• 1 - the Alpha test blending preset.
• 2 - the Alpha blend, Additive, Multiplicative or Custom blending preset.

A flag indicating if writing in the depth buffer is enabled for a material.

Available values:

• 0 - not used
• 1 - used (by default)

A flag indicating if the native depth pre-pass is performed for a material.

Available values:

• 0 - is performed
• 1 - not performed

A flag indicating if an Overlap option is enabled for a material.

Available values:

• 0 - disabled (by default)
• 1 - enabled

A flag indicating if a Two Sided option is enabled for a material.

Available values:

• 0 - disabled (by default)
• 1 - enabled

A flag indicating if a Depth Test option is enabled for a material.

Available values:

• 0 - disabled
• 1 - enabled (by default)

A flag indicating if a Cast Proj and Omni Shadow option is enabled for a material.

Available values:

• 0 - disabled
• 1 - enabled (by default)

A flag indicating if a Cast World Shadow option is enabled for a material.

Available values:

• 0 - disabled
• 1 - enabled (by default)

For example, if you enable the Alpha test and Two sided options, the following is written into the *.mat file:

<options alpha_test="1" two_sided="1"/>

In the Parameters window, a common option value can be set on the Common tab.

Name of the state.

For example, if you set the Ambient occlusion state, the following string will be written into the *.mat file:

<state name="ao_map">1</state>

Texture name.

A texture wrapping methods.

Available values:

• clamp - a texture is clamped along all axes
• clamp_x - a texture is clamped along X-axis
• clamp_y - a texture is clamped along Y-axis
• clamp_z - a texture is clamped along Z-axis
• border - a texture is bordered along all axes
• border_x - a texture is bordered along X-axis
• border_y - a texture is bordered along Y-axis
• border_z - a texture is bordered along Z-axis
• repeat - no wrap, a texture is tiled along all axes. This value can be used, for example, when a base material's texture is bordered, and the child material's texture shouldn't.

A flag, indicating if the anisotropy for the texture is enabled.

Available values:

• 0  -  enabled (by default)
• 1  -  disabled

A type of the texture filtering.

Available values:

• point   - point  
• linear   - linear  
• bilinear   - bilinear  

For example, if you change the path to the Albedo texture, the following will be written into the *.mat file:

<texture name="albedo" anisotropy="0">unigine_project/textures/ground_dirt_alb.dds</texture>

Name of the parameter.

If you override the Albedo color and Metalness parameters of the material, inherited from the mesh_base, the following will be written into the *.mat file:

<parameter name="albedo_color">0.501960814 0 0 1</parameter>
<parameter name="metalness">0.76700002</parameter>