class ShaderEffectCompileInfo in Tinman.AddOns.Rendering

Helper object for IGraphicsContext implementations that stores information for compiling and loading of a shader effect.

sealed class

ShaderEffectCompileInfo

extends

Disposable

Public / Attributes

Bytes

The bytes of the compiled shader effect binary.

[Owner]
public field	Bytes
type	ByteBuffer

Compiled

Has the shader effect source (see Source) been compiled successfully?

public field	Compiled
type	bool

Errors

Errors messages that have been generated while compiling the shader effect source (see Source).

public field	Errors
type	string

Files

The files that belong to the shader effect

public field	Files
type	IBag<Path>

Handle

The native handle of the loaded shader effect.

public field	Handle
type	IntPtr

LifecycleState

Returns the lifecycle state of this object.

public virtual property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	Disposable.LifecycleState

Name

Name of the top-level shader effect source file or null.

public field	Name
type	string

Source

The shader effect source code or null.

public field	Source
type	string

Public / Constructors

ShaderEffectCompileInfo

Creates a new instance of ShaderEffectCompileInfo.

public constructor

ShaderEffectCompileInfo ()

Public / Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
public method	AcquireTry ()
type	IDisposable
returns			this if a new strong reference has been acquired, null if this object is already being disposed.
inherited	Disposable.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.

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]
public method	Dispose ()
inherited	Disposable.Dispose

Remarks:

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