interface IShaderEffect in Tinman.AddOns.Rendering

Base interface for classes that encapsulate a GPU shader effect.

interface	IShaderEffect	extends	IDisposable
		base of	ShaderEffect

Attributes

LifecycleState

Returns the lifecycle state of this object.

property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	ILifecycleState.LifecycleState

Name

The name of this shader effect.

property	Name { get }
type	string
value	[not-null]	The effect name.

ParameterNames

Returns the names of all shader effect parameters.

property	ParameterNames { get }
type	string[]
value	[not-null]	The list of shader effect parameter names.

See also:

Parameter

TechniqueNames

Returns the names of all shader effect techniques.

property	TechniqueNames { get }
type	string[]
value	[not-null]	The list of shader effect technique names.

See also:

Technique

Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
method	AcquireTry ()
type	IDisposable
returns			this if a new strong reference has been acquired, null if this object is already being disposed.
inherited	IDisposable.AcquireTry

Remarks:

The object will not be actually disposed by calls to Dispose when there is at least one strong reference left. Code that calls the AcquireTry method is responsible for calling the Dispose method accordingly.

This method is not intended to be used in performance-critical code. It should only be used to high-level resource management.

ApplyChanges

Applies all changes that have been made to the parameters of this shader effect during an active render pass.

method

ApplyChanges ()

Remarks:

The ApplyChanges only needs to be called between calls to BeginPass and EndPass.

Dispose

Releases all resources held by this object if there are no more strong references to it, decrements the reference counter by one otherwise.

[Dispose, OwnerThis, ThreadSafe]
method	Dispose ()
inherited	IDisposable.Dispose

Remarks:

The Dispose method silently returns if the object has already been disposed.

HasParameter

Checks if a parameter of the given name exists.

[Pure]
method	HasParameter (string name)
type	bool
params	name	[not-empty]	The shader effect parameter name.
returns			true if the parameter exists, false if not.

HasTechnique

Checks if a technique of the given name exists.

[Pure]
method	HasTechnique (string name)
type	bool
params	name	[not-empty]	The shader effect technique name.
returns			true if the parameter exists, false if not.

Parameter

Returns a parameter of this shader effect by its name.

[Pure]
method	Parameter (string name)
type	IShaderParameter
params	name	[not-empty]	The shader effect parameter name.
returns		[not-null]	The shader parameter.

See also:

HasParameter

Exceptions:

• TinmanException:
  If the given name is not known.

Technique

Returns the index of the given rendering technique.

[Pure]
method	Technique (string name)
type	IShaderTechnique
params	name	[not-empty]	Name of rendering technique.
returns		[0..Techniques-1]	The render technique index.

See also:

HasTechnique

Exceptions:

• TinmanException:
  If the given name is not known.