Class MaterialParameter

Material variable object. Allows to modify material parameter value at runtime.

MaterialParameter

Inherited Members

ScriptingObject::_gcHandle

ScriptingObject::_id

ScriptingObject::CanCast(const ScriptingTypeHandle& from, const ScriptingTypeHandle& to)

ScriptingObject::CanCast(const MClass* from, const MClass* to)

ScriptingObject::Cast(ScriptingObject* obj)

ScriptingObject::ChangeID(const Guid& newId)

ScriptingObject::CreateManaged()

ScriptingObject::CreateManagedInternal()

ScriptingObject::Deleted

Object::DeleteObject(float timeToLive = 0.0f, bool useGameTime=false)

Object::DeleteObjectNow()

ScriptingObject::DestroyManaged()

Object::Flags

ScriptingObject::FromInterface(void* interfaceObj, const ScriptingTypeHandle& interfaceType)

ScriptingObject::FromInterface(T* interfaceObj)

ScriptingObject::GetClass()

ScriptingObject::GetID()

ScriptingObject::GetManagedInstance()

ScriptingObject::GetOrCreateManagedInstance()

ScriptingObject::GetType()

ScriptingObject::GetTypeHandle()

ScriptingObject::HasManagedInstance()

ScriptingObject::Is(const ScriptingTypeHandle& type)

ScriptingObject::Is(const MClass* type)

ScriptingObject::Is()

ScriptingObject::IsRegistered()

ScriptingObject::NewObject(const ScriptingTypeHandle& typeHandle)

ScriptingObject::NewObject()

ScriptingObject::OnDeleteObject()

ScriptingObject::OnManagedInstanceDeleted()

ScriptingObject::OnScriptingDispose()

ScriptingObject::RegisterObject()

ScriptingObject::ScriptingObject(const SpawnParams& params)

ScriptingObject::SetManagedInstance(MObject* instance)

MaterialParameter

ScriptingObject::ToInterface(ScriptingObject* obj, const ScriptingTypeHandle& interfaceType)

ScriptingObject::ToInterface(ScriptingObject* obj)

ScriptingObject::ToManaged(const ScriptingObject* obj)

ScriptingObject::ToNative(MObject* obj)

ScriptingObject::UnregisterObject()

Object::~Object()

ScriptingObject::~ScriptingObject()

Assembly: FlaxEngine.dll

File: Engine/Graphics/Materials/MaterialParams.h

Syntax

public class MaterialParameter : public ScriptingObject

Fields

_asBool

Declaration

public bool _asBool

Field Value

bool

_asColor

Declaration

public Color _asColor

Field Value

Color

_asFloat

Declaration

public float _asFloat

Field Value

float

_asInteger

Declaration

public int32 _asInteger

Field Value

int32

_asVector2

Declaration

public Float2 _asVector2

Field Value

Float2

_asVector3

Declaration

public Float3 _asVector3

Field Value

Float3

AsData

Declaration

public byte AsData[16* 4]

Field Value

byte

Methods

Bind(BindMeta& meta)

Binds the parameter to the pipeline.

Declaration

public void Bind(BindMeta& meta) const

Parameters

BindMeta meta

The bind meta.

GetBindOffset()

Gets the parameter binding offset since the start of the constant buffer.

Declaration

public uint16 GetBindOffset() const

Returns

uint16

GetName()

Gets the parameter name.

Declaration

public String GetName() const

Returns

String

GetParameterID()

Gets the parameter ID (not the parameter instance Id but the original parameter ID).

Declaration

public Guid GetParameterID() const

Returns

Guid

GetParameterType()

Gets the parameter type.

Declaration

public MaterialParameterType GetParameterType() const

Returns

MaterialParameterType

GetRegister()

Gets the parameter resource graphics pipeline binding register index.

Declaration

public byte GetRegister() const

Returns

byte

GetValue()

Gets the value of the parameter.

Declaration

public Variant GetValue() const

Returns

Variant

The value.

HasContentLoaded()

Declaration

public bool HasContentLoaded() const

Returns

bool

IsOverride()

Returns true is parameter is overriding the value.

Declaration

public bool IsOverride() const

Returns

bool

IsPublic()

Returns true is parameter is public visible.

Declaration

public bool IsPublic() const

Returns

bool

operator==(const MaterialParameter& other)

Declaration

public bool operator==(const MaterialParameter& other) const

Parameters

MaterialParameter other

Returns

bool

SetIsOverride(bool value)

Sets the value override mode.

Declaration

public void SetIsOverride(bool value)

Parameters

bool value

SetValue(const Variant& value)

Sets the value of the parameter.

Declaration

public void SetValue(const Variant& value)

Parameters

Variant value

The value.

ToString()

Gets the string representation of this object.

Declaration

public virtual String ToString() const override

Returns

String

Overrides

Object::ToString()