UE3:MaterialInstance (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
UDK Object >> Surface >> MaterialInterface >> MaterialInstance
Package:
Engine
Direct subclasses:
MaterialInstanceConstant, MaterialInstanceTimeVarying
This class in other games:


Properties

Property group 'MaterialInstance'

Parent

Type: MaterialInterface

Modifiers: const


PhysMaterial

Type: PhysicalMaterial

Physical material to use for this graphics material. Used for sounds, effects etc.

Internal variables

bHasStaticPermutationResource

Type: bool

indicates whether the instance has static permutation resources (which are required when static parameters are present)

bStaticPermutationDirty

Type: bool

Modifiers: native, transient

indicates whether the static permutation resource needs to be updated on PostEditChange()

ParentLightingGuid

Type: Object.Guid

Modifiers: private, const

Unique ID for this material, used for caching during distributed lighting

ReentrantFlag

Type: bool

Modifiers: private, const, native


ReferencedTextureGuids

Type: array<Object.Guid>

Modifiers: private, const, editoronly


ReferencedTextures

Type: array<Texture>

Modifiers: deprecated, private, const

Legacy texture references, now handled by FMaterial.

Resources

Type: pointer{class FMaterialInstanceResource}

Array size: 2

Modifiers: const, native, duplicatetransient


StaticParameters

Type: pointer{FStaticParameterSet}

Array size: 2

Modifiers: const, native, duplicatetransient

The set of static parameters that this instance will be compiled with, one for sm3 and one for sm2. This is indexed by EMaterialShaderPlatform.

StaticPermutationResources

Type: pointer{FMaterialResource}

Array size: 2

Modifiers: const, native, duplicatetransient

The material resources for this instance, one for sm3 and one for sm2. This is indexed by EMaterialShaderPlatform.

Native functions

ClearParameterValues

native function ClearParameterValues ()

Removes all parameter values

IsInMapOrTransientPackage

native function bool IsInMapOrTransientPackage () const

Returns if this MI is either in a map package or the transient package During gameplay, Set..Parameter should only be called on MIs where this is TRUE - otherwise you are modifying an MI within a content package, that will persist across level reload etc.

SetFontParameterValue

native function SetFontParameterValue (name ParameterName, Font FontValue, int FontPage)

Sets the value of the given font parameter.

Parameters:

  • ParameterName - The name of the font parameter
  • OutFontValue - New font value to set for this MIC
  • OutFontPage - New font page value to set for this MIC

SetParent

native function SetParent (MaterialInterface NewParent)


SetScalarCurveParameterValue

native function SetScalarCurveParameterValue (name ParameterName, const out Object.InterpCurveFloat Value)


SetScalarParameterValue

native function SetScalarParameterValue (name ParameterName, float Value)


SetTextureParameterValue

native function SetTextureParameterValue (name ParameterName, Texture Value)


SetVectorParameterValue

native function SetVectorParameterValue (name ParameterName, const out Object.LinearColor Value)