Interface IEffect

Namespace

Icy.Rendering

Assembly

IcyUI.dll

Represents an interface for the shader effects used in rendering process.

public interface IEffect

Extension Methods

PropertyReferencesExtensions.ContainsProperty(object, IPropertyReference)

Methods

GetParameter<T>(string)

Gets a value of the parameter with the specified name.

T GetParameter<T>(string name)

Parameters

name string

Name of the parameter to get value from.

Returns

T

Value of the parameter by the specified name.

Type Parameters

T

Expected type of the parameter.

Remarks

Note that because of engine-dependent effects implementations the wrapper for the GetParameter<T>(string) and SetParameter<T>(string, T) methods should be responsible to convert only to compatible types, all the other types should be either binary compatible with target type or should be able to be implicitly converted to it.

Exceptions

InvalidCastException

Occurs when the target type is incompatible with the parameter type.

KeyNotFoundException

Occurs when the parameter with the specified name not found.

SetParameter<T>(string, T)

Sets a value to the parameter with the specified name.

void SetParameter<T>(string name, T value)

Parameters

name string

Name of the parameter to set value to.

value T

Value to set to the parameter.

Type Parameters

T

Expected type of the parameter.

Remarks

Note that because of engine-dependent effects implementations the wrapper for the GetParameter<T>(string) and SetParameter<T>(string, T) methods should be responsible to convert only to compatible types, all the other types should be either binary compatible with target type or should be able to be implicitly converted to it.

Exceptions

InvalidCastException

Occurs when the target type is incompatible with the parameter type.

KeyNotFoundException

Occurs when the parameter with the specified name not found.