class DirectX9RenderTarget in Tinman.AddOns.DirectX9

class	DirectX9RenderTarget	extends	Disposable
		implements	IRenderTarget

Public / Attributes

LifecycleState

Returns the lifecycle state of this object.

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

MemoryConsumption

Returns the estimated memory consumption of this object.

public property	MemoryConsumption { get }
type	int64
value	[>=0]	The estimated memory consumption, in bytes.
implements	IMemoryConsumption.MemoryConsumption

NativeHandle

Returns the raw handle value of the native resource that is contained in this object.

public property	NativeHandle { get }
type	IntPtr
value		The raw handle value.
implements	INativeHandle.NativeHandle

Remarks:

The documentation of the implementing class will contain information on how to interpret the raw handle value.

Size

The size of this render target.

public property	Size { get }
type	Vec2I
value		The render target size, in pixels.
implements	IRenderTarget.Size

Texture

The texture resource that holds the rendered pixels.

public property	Texture { get }
type	ITexture2D
value		The texture resource or null if this render target represents the backbuffer of a swap chain.
implements	IRenderTarget.Texture

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.

TextureUpdate

Ensures that Texture reflects the current content of the render target.

public method	TextureUpdate ()
implements	IRenderTarget.TextureUpdate

Remarks:

This method allows an implementation to defer costly operations and perform them only when necessary, for example:

• Compute texture mipmap-levels (Mipmaps).
• Copy content of multi-sample render target to texture (see MultiSample).

This method should be called after rendering to this target (see SetRenderTarget) and before using Texture as input for subsequent rendering.

Protected / Constructors

DirectX9RenderTarget

Creates a new instance of DirectX9RenderTarget.

protected constructor	DirectX9RenderTarget ([Owner] IntPtr textureHandle, [Owner] IntPtr backbufferHandle, [Owner] IntPtr depthStencilHandle, int32 memoryConsumption, bool srgb)
params	textureHandle		The IDirect3DTexture9* COM pointer that has been obtained by calling IDirect3DDevice9::CreateTexture with D3DUSAGE_RENDERTARGET usage. Upon disposal, Release will be called on the COM pointer.
	backbufferHandle		The IDirect3DSurface9* COM pointer that has been obtained by calling IDirect3DDevice9::CreateRenderTarget resp. IDirect3DDevice9Ex::CreateRenderTargetEx, or Zero (i.e. NULL). Upon disposal, Release will be called on the COM pointer.
	depthStencilHandle		The IDirect3DSurface9* COM pointer that has been obtained by calling IDirect3DDevice9::CreateDepthStencilSurface resp. IDirect3DDevice9Ex::CreateDepthStencilSurfaceEx, or Zero (i.e. NULL). Upon disposal, Release will be called on the COM pointer.
	memoryConsumption	[>=0]	The estimated GPU memory consumption, in bytes.
	srgb		Has Srgb been specified?

Remarks:

The backbufferHandle and textureHandle parameters a mutually exclusive, i.e. one of them should be Zero.

Protected / Methods

DisposeManaged

Disposes the managed resources held by a concrete subclass. This method will be called at most once per subclass.

protected override method	DisposeManaged ()
overrides	Disposable.DisposeManaged

Remarks:

This method will only be called when a disposable object is explicitly destroyed by user code calling the Dispose method. It will not be called when the object is collected as garbage by the system.

Overriding methods must call the DisposeManaged method of their base class. The base call should be the last statement.

The DisposeManaged method is called before the DisposeUnmanaged method.

DisposeUnmanaged

Disposes the unmanaged resources held by a concrete subclass. This method will be called exactly once per subclass.

protected override method	DisposeUnmanaged ()
overrides	Disposable.DisposeUnmanaged

Remarks:

Overriding methods must call the DisposeUnmanaged method of their base class. The base call should be the last statement.

The DisposeUnmanaged method is called after the DisposeManaged method.