Class GorgonRenderTargetView
A view to allow 2D texture based render targets to be bound to the pipeline.
Inheritance
Inherited Members
Namespace: Gorgon.Graphics.Core
Assembly: Gorgon.Graphics.Core.dll
Syntax
public abstract class GorgonRenderTargetView : GorgonResourceView, IDisposable, IGorgonGraphicsObject, IEquatable<GorgonResourceView>Remarks
A render target view allows a render target (such as a GorgonSwapChain or a texture to be bound to the GPU pipeline as a render target resource.
The view can bind the entire resource, or a sub section of the resource as required. It will also allow for casting of the format to allow for reinterpreting the data stored within the the render target.
Constructors
| Edit this page View SourceGorgonRenderTargetView(GorgonGraphicsResource, BufferFormat, GorgonFormatInfo)
Initializes a new instance of the GorgonRenderTarget2DView class.
Declaration
protected GorgonRenderTargetView(GorgonGraphicsResource resource, BufferFormat format, GorgonFormatInfo formatInfo)Parameters
| Type | Name | Description |
|---|---|---|
| GorgonGraphicsResource | resource | The resource to bind. |
| BufferFormat | format | The format of the render target view. |
| GorgonFormatInfo | formatInfo | Information about the format. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | Thrown when the |
See Also
Properties
| Edit this page View SourceBinding
Property to return the flags to determine how the texture will be bound with the pipeline when rendering.
Declaration
public abstract TextureBinding Binding { get; }Property Value
| Type | Description |
|---|---|
| TextureBinding |
See Also
| Edit this page View SourceFormat
Property to return the format used to interpret this view.
Declaration
public BufferFormat Format { get; }Property Value
| Type | Description |
|---|---|
| BufferFormat |
See Also
| Edit this page View SourceFormatInformation
Property to return information about the Format used by this view.
Declaration
public GorgonFormatInfo FormatInformation { get; }Property Value
| Type | Description |
|---|---|
| GorgonFormatInfo |
See Also
| Edit this page View SourceHeight
Property to return the height of the render target view.
Declaration
public abstract int Height { get; }Property Value
| Type | Description |
|---|---|
| int |
See Also
| Edit this page View SourceWidth
Property to return the width of the render target view.
Declaration
public abstract int Width { get; }Property Value
| Type | Description |
|---|---|
| int |
See Also
Methods
| Edit this page View SourceClear(in GorgonColor)
Function to clear the contents of the render target for this view.
Declaration
public void Clear(in GorgonColor color)Parameters
| Type | Name | Description |
|---|---|---|
| GorgonColor | color | Color to use when clearing the render target view. |
Remarks
This will clear the render target view to the specified color.