interface IResourceData in Tinman.Engine.Rendering

Base interface for pre-loaded resource handles.

interface	IResourceData	extends	IDisposable
			IResourceHandle
		base of	TextureData2D

See also:

IPreloadingResourceHandle.PreloadResource

Attributes

IsSoleOwnership

Will this object be disposed upon the next call to Dispose?

[ThreadSafe]
property	IsSoleOwnership { get }
type	bool
value		true if the object will be disposed when Dispose is called, false if the object will not be disposed, because some other code is still holding shared ownership (see AcquireThrow).
inherited	IDisposable.IsSoleOwnership

LifecycleState

Returns the lifecycle state of this object.

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

Methods

AcquireBase

Acquires a strong reference to this disposable object.

[OwnerReturn, Pure]
method	AcquireBase ()
type	IDisposable
returns			The strong reference to this disposable object or null iff this object is no longer valid.
inherited	IDisposable.AcquireBase

Remarks:

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

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

Using this method usually requires type casting. Subclasses may additionally implement IDisposableGeneric, in order to provide some syntactic sugar for that.

AcquireThrow

Acquires a strong reference to this disposable object.

[OwnerReturn, Pure]
method	AcquireThrow ()
type	IDisposable
returns		[not-null]	The strong reference to this disposable object.
inherited	IDisposable.AcquireThrow

Remarks:

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

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

Exceptions:

• TinmanException:
  If this object is no longer valid.

CreateResource

Creates a new resource object, using the given graphics context.

[OwnerReturn]
method	CreateResource (Graphics graphics)
type	IResource
params	graphics	[not-null]	The graphics context to use.
returns		[not-null]	The resource object.
inherited	IResourceHandle.CreateResource

Remarks:

Resource objects may implement the IMemoryConsumption interface. In this case, the reported memory consumption will be interpreted as an estimate on how much GPU memory is consumed by the resource. This estimate can then be used for resource caching (e.g. CacheMemory).

Exceptions:

• RenderException:
  If a graphics subsystem error has occurred.
• IOException:
  If an I/O error has occurred while reading the resource data.
• ValidatingException:
  If the data reader has reported an error, for example because of an unsupported file format feature.

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.

Implementing methods must not throw any exceptions.

Equals

Compares this object with the given one.

[Pure]
method	Equals (IResourceHandle other)
type	bool
params	other		The object to compare to.
returns			true if this object is equal to other, false if not.
inherited	IEquatable.Equals