interface ISwapChain in Tinman.AddOns.Rendering

A swap chain for rendering in a window.

interface

ISwapChain

extends

IRenderTarget

See also:

IGraphicsContext.SetRenderTarget
IGraphicsContext.CreateSwapChain

Attributes

LifecycleState

Returns the lifecycle state of this object.

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

MemoryConsumption

Returns the estimated memory consumption of this object.

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

NativeHandle

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

property	NativeHandle { get }
type	IntPtr
value		The raw handle value.
inherited	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.

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

Texture

The texture resource that holds the rendered pixels.

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

Methods

AcquireTry

Acquires a strong reference to this disposable object.

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

Remarks:

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

Present

Presents the most recent renderings.

method

Present ()

TextureUpdate

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

method	TextureUpdate ()
inherited	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.

Validate

Checks if this swap chain is still valid.

method	Validate ()
type	bool
returns			true if the swap chain is valid, false if it has become invalid.

Remarks:

If a swap chain has become invalid, it needs to be disposed and recreated. It is not necessary to recreate any other graphics resources in this case.