Version: 2017.2 (switch to 2017.3b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

ProceduralMaterial

class in UnityEngine

/

Inherits from:Material

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual

Description

Class for ProceduralMaterial handling.

var floatRangeProperty : String = "Saturation";
var cycleTime : float = 10;
var rend: Renderer;

function Start() { rend = GetComponent.<Renderer>(); }

function Update () { var substance : ProceduralMaterial = rend.sharedMaterial as ProceduralMaterial;

if (substance) { // Make the property go up and down over time var lerp = Mathf.PingPong (Time.time * 2 / cycleTime, 1); substance.SetProceduralFloat (floatRangeProperty, lerp); substance.RebuildTextures (); } }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { public string floatRangeProperty = "Saturation"; public float cycleTime = 10; public Renderer rend; void Start() { rend = GetComponent<Renderer>(); } void Update() { ProceduralMaterial substance = rend.sharedMaterial as ProceduralMaterial; if (substance) { float lerp = Mathf.PingPong(Time.time * 2 / cycleTime, 1); substance.SetProceduralFloat(floatRangeProperty, lerp); substance.RebuildTextures(); } } }

Static Properties

isSupportedCheck if ProceduralMaterials are supported on the current platform.
substanceProcessorUsageUsed to specify the Substance engine CPU usage.

Properties

animationUpdateRateSet or get the update rate in millisecond of the animated substance.
cacheSizeSet or get the Procedural cache budget.
isCachedDataAvailableIndicates whether cached data is available for this ProceduralMaterial's textures (only relevant for Cache and DoNothingAndCache loading behaviors).
isFrozenReturns true if FreezeAndReleaseSourceData was called on this ProceduralMaterial.
isLoadTimeGeneratedShould the ProceduralMaterial be generated at load time?
isProcessingCheck if the ProceduralTextures from this ProceduralMaterial are currently being rebuilt.
isReadableSet or get the "Readable" flag for a ProceduralMaterial.
loadingBehaviorGet ProceduralMaterial loading behavior.
presetSet or get an XML string of "input/value" pairs (setting the preset rebuilds the textures).

Public Methods

CacheProceduralPropertySpecifies if a named ProceduralProperty should be cached for efficient runtime tweaking.
ClearCacheClear the Procedural cache.
FreezeAndReleaseSourceDataRender a ProceduralMaterial immutable and release the underlying data to decrease the memory footprint.
GetGeneratedTextureThis allows to get a reference to a ProceduralTexture generated by a ProceduralMaterial using its name.
GetGeneratedTexturesGet generated textures.
GetProceduralBooleanGet a named Procedural boolean property.
GetProceduralColorGet a named Procedural color property.
GetProceduralEnumGet a named Procedural enum property.
GetProceduralFloatGet a named Procedural float property.
GetProceduralPropertyDescriptionsGet an array of descriptions of all the ProceduralProperties this ProceduralMaterial has.
GetProceduralStringGet a named Procedural string property.
GetProceduralTextureGet a named Procedural texture property.
GetProceduralVectorGet a named Procedural vector property.
HasProceduralPropertyChecks if the ProceduralMaterial has a ProceduralProperty of a given name.
IsProceduralPropertyCachedChecks if a named ProceduralProperty is cached for efficient runtime tweaking.
IsProceduralPropertyVisibleChecks if a given ProceduralProperty is visible according to the values of this ProceduralMaterial's other ProceduralProperties and to the ProceduralProperty's visibleIf expression.
RebuildTexturesTriggers an asynchronous rebuild of this ProceduralMaterial's dirty textures.
RebuildTexturesImmediatelyTriggers an immediate (synchronous) rebuild of this ProceduralMaterial's dirty textures.
SetProceduralBooleanSet a named Procedural boolean property.
SetProceduralColorSet a named Procedural color property.
SetProceduralEnumSet a named Procedural enum property.
SetProceduralFloatSet a named Procedural float property.
SetProceduralStringSet a named Procedural string property.
SetProceduralTextureSet a named Procedural texture property.
SetProceduralVectorSet a named Procedural vector property.

Static Methods

StopRebuildsDiscard all the queued ProceduralMaterial rendering operations that have not started yet.

Inherited Members

Properties

colorThe main material's color.
doubleSidedGIGets and sets whether the Double Sided Global Illumination setting is enabled for this material.
enableInstancingGets and sets whether GPU instancing is enabled for this material.
globalIlluminationFlagsDefines how the material should interact with lightmaps and lightprobes.
mainTextureThe material's texture.
mainTextureOffsetThe texture offset of the main texture.
mainTextureScaleThe texture scale of the main texture.
passCountHow many passes are in this material (Read Only).
renderQueueRender queue of this material.
shaderThe shader used by the material.
shaderKeywordsAdditional shader keywords set by this material.
hideFlagsShould the object be hidden, saved with the scene or modifiable by the user?
nameThe name of the object.

Public Methods

CopyPropertiesFromMaterialCopy properties from other material into this material.
DisableKeywordUnset a shader keyword.
EnableKeywordSets a shader keyword that is enabled by this material.
FindPassReturns the index of the pass passName.
GetColorGet a named color value.
GetColorArrayGet a named color array.
GetFloatGet a named float value.
GetFloatArrayGet a named float array.
GetIntGet a named integer value.
GetMatrixGet a named matrix value from the shader.
GetMatrixArrayGet a named matrix array.
GetPassNameReturns the name of the shader pass at index pass.
GetShaderPassEnabledChecks whether a given Shader pass is enabled on this Material.
GetTagGet the value of material's shader tag.
GetTextureGet a named texture.
GetTextureOffsetGets the placement offset of texture propertyName.
GetTextureScaleGets the placement scale of texture propertyName.
GetVectorGet a named vector value.
GetVectorArrayGet a named vector array.
HasPropertyChecks if material's shader has a property of a given name.
IsKeywordEnabledIs the shader keyword enabled on this material?
LerpInterpolate properties between two materials.
SetBufferSets a named ComputeBuffer value.
SetColorSets a named color value.
SetColorArraySets a color array property.
SetFloatSets a named float value.
SetFloatArraySets a float array property.
SetIntSets a named integer value.
SetMatrixSets a named matrix for the shader.
SetMatrixArraySets a matrix array property.
SetOverrideTagSets an override tag/value on the material.
SetPassActivate the given pass for rendering.
SetShaderPassEnabledEnables or disables a Shader pass on a per-Material level.
SetTextureSets a named texture.
SetTextureOffsetSets the placement offset of texture propertyName.
SetTextureScaleSets the placement scale of texture propertyName.
SetVectorSets a named vector value.
SetVectorArraySets a vector array property.
GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the game object.

Static Methods

DestroyRemoves a gameobject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadMakes the object target not be destroyed automatically when loading a new scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active loaded objects of Type type.
InstantiateClones the object original and returns the clone.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.

Did you find this page useful? Please give it a rating: