class ImageSampler in Tinman.Terrain.Imaging

Base interface for classes that sample image data using some kind of interpolation.

sealed class

ImageSampler

extends

Disposable

Public / Attributes

LifecycleState

Returns the lifecycle state of this object.

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

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.

For

Creates a new instance of ImageSampler for the given image.

[OwnerReturn]
public static method	For (IImage image)
type	ImageSampler
params	image	[not-null]	The image.
returns		[not-null]	The image sampler.

---

Creates a new instance of ImageSampler for the given image.

[OwnerReturn]
public static method	For ([Owner] IImageReader reader)
type	ImageSampler
params	reader	[not-null]	The image.
returns		[not-null]	The image sampler.

SamplePixel

Samples a pixel from the image.

public method	SamplePixel (float64 u, float64 v)
type	int64
params	u		X-coordinate of pixel to sample, in the range [0..1].
	v		Y-coordinate of pixel to sample, in the range [0..1].
returns			The samples pixel value.