s&box docs
API ReferenceSandbox

public sealed class Sandbox.DecalDefinition : Sandbox.GameResource

A decal which can be applied to objects and surfaces.

Broader workflow and conceptual references connected to this API.

DecalDefinition

A DecalDefinition holds what a single Decal should look like. It describes its color, normals, roughness, metalness and ambient occlusion. If you define a Height texture, it will define its parallax too.

Constructors

Showing 1 constructors

Properties

Showing 13 properties

public float Sandbox.DecalDefinition.ColorMix { get; set; }

Controls the opacity of the decal's color texture without reducing the impact of the normal or rmo texture. Set to 0 to create a normal/rmo only decal masked by the color textures alpha.

public Sandbox.Texture Sandbox.DecalDefinition.ColorTexture { get; set; }

The color map to use for the decal including transparency which masks the decal. This must be set for other textures to use the decal mask.

public float Sandbox.DecalDefinition.EmissionEnergy { get; set; }

Strength of the emission effect.

public Sandbox.Texture Sandbox.DecalDefinition.EmissiveTexture { get; set; }

The emissive texture map to use for the decal.

public Sandbox.Rendering.FilterMode Sandbox.DecalDefinition.FilterMode { get; set; }

How the texture gets filtered.

public float Sandbox.DecalDefinition.Height { get; set; }

Height of the decal.

public Sandbox.Texture Sandbox.DecalDefinition.HeightTexture { get; set; }

The height texture to use for parallax mapping.

public Sandbox.Texture Sandbox.DecalDefinition.NormalTexture { get; set; }

The normal texture map to use for the decal.

public float Sandbox.DecalDefinition.ParallaxStrength { get; set; }

Strength of the parallax effect.

public Sandbox.Texture Sandbox.DecalDefinition.RoughMetalOcclusionTexture { get; set; }

The Roughness/Metal/Ambient Occlusion texture map to use for the decal, stored in the respective RGB channels.

public Color Sandbox.DecalDefinition.Tint { get; set; }

Tints the color of the decal's albedo and can be used to adjust the overall opacity of the decal.

public float Sandbox.DecalDefinition.Width { get; set; }

Width of the decal.

Metadata

FieldValue
NamespaceSandbox
Typeclass
AssemblySandbox.Engine
Doc IDT:Sandbox.DecalDefinition

Decal

Previous Page

DecalGameSystem

Next Page

On this page

Constructorspublic DecalDefinition()Propertiespublic System.Single Sandbox.DecalDefinition.ColorMix { get; set; }public Sandbox.Texture Sandbox.DecalDefinition.ColorTexture { get; set; }public System.Collections.Generic.List`1<Sandbox.DecalDefinition.DecalEntry> Sandbox.DecalDefinition.Decals { get; set; }public System.Single Sandbox.DecalDefinition.EmissionEnergy { get; set; }public Sandbox.Texture Sandbox.DecalDefinition.EmissiveTexture { get; set; }public Sandbox.Rendering.FilterMode Sandbox.DecalDefinition.FilterMode { get; set; }public System.Single Sandbox.DecalDefinition.Height { get; set; }public Sandbox.Texture Sandbox.DecalDefinition.HeightTexture { get; set; }public Sandbox.Texture Sandbox.DecalDefinition.NormalTexture { get; set; }public System.Single Sandbox.DecalDefinition.ParallaxStrength { get; set; }public Sandbox.Texture Sandbox.DecalDefinition.RoughMetalOcclusionTexture { get; set; }public Color Sandbox.DecalDefinition.Tint { get; set; }public System.Single Sandbox.DecalDefinition.Width { get; set; }Metadata