class ShaderEffectSourceInfo in Tinman.AddOns.Rendering

Helper object for IGraphicsContext implementations that stores the timestamped source file list of a shader effect.

sealed class

ShaderEffectSourceInfo

extends

SerializableBase

Serialization

SerialId

Serialization information about this type.

public static readonly field	SerialId
type	ISerialTypeInfo

Public / Attributes

FilePath

Path to shader effect source file.

public property	FilePath { get }
type	Path
value		The file path.

Length

Length of shader effect source file, in bytes.

public property	Length { get }
type	int64
value		The file length.

See also:

IFile.GetLength

SerialType

Returns the serial type of this object.

public property	SerialType { get }
type	ISerialTypeInfo
value	[not-null]	The serial type.
inherited	SerializableBase.SerialType

SerialVersion

Returns the serial data version.

public virtual property	SerialVersion { get }
type	int32
value	[>=1]	The serial data version tag.
inherited	SerializableBase.SerialVersion

Remarks:

An ISerializable implementation is required to support all versions up to the one returned by SerialVersion.

See also:

ISerializable.Serialize
ISerializable.Deserialize

Timestamp

Timestamp of shader effect source file.

public property	Timestamp { get }
type	int64
value		The file timestamp.

See also:

IFile.GetTimestamp

Public / Constructors

ShaderEffectSourceInfo

Creates a new instance of ShaderEffectSourceInfo.

public constructor	ShaderEffectSourceInfo (Path resolver, Path filePath)
params	resolver	[not-null]	The relative path resolver to use.
	filePath	[not-null]	File path to the shader effect source file.

Public / Methods

Deserialize

Initializes the state of this object from the given data stream.

public override method	Deserialize (int32 serialVersion, ISerializer data)
type	ISerializable
params	serialVersion	[>=1]	The serial data version.
	data	[not-null]	The serial data stream.
returns		[not-null]	The deserialized object. This will typically be this, but in some circumstances, another instance may be returned (e.g. singletons).
overrides	SerializableBase.Deserialize

Remarks:

The Deserialize method will be called immediately after the object has been instantiated via its default constructor.

The provided serialVersion number is guaranteed to be equal to or less than the SerialVersion returned by this object (i.e. ISerializable object must provide backwards compatibility).

See also:

ISerializable.Serialize
ISerializable.SerialVersion

HasChanged

Validates this shader effect source file.

public method	HasChanged (Path resolver)
type	bool
params	resolver	[not-null]	The path resolver to use.
returns			true if the file exists and has changed, false otherwise.

---

Validates the given shader effect source files.

public static method	HasChanged (Path resolver, ShaderEffectSourceInfo[] infos)
type	bool
params	resolver	[not-null]	The path resolver to use.
	infos	[not-null]	The shader effect source files.
returns			true if at least one shader effect source file exists and has changed, false otherwise.

Serialize

Serializes the current state of this object to the given data stream.

public override method	Serialize (ISerializer data)
params	data	[not-null]	The serial data stream.
overrides	SerializableBase.Serialize

See also:

ISerializable.Deserialize
ISerializable.SerialVersion