GraphicsAPI reference
Struct RenderTargetDescription
Namespace: MicroEngine.Graphics.Devices
Assembly: MicroEngine.Graphics.dll
Guide: The graphics device
An offscreen target: one colour texture that can also be sampled, and an optional depth(-stencil) texture.
public readonly struct RenderTargetDescription : IEquatable<RenderTargetDescription>Implements
IEquatable<RenderTargetDescription>
Constructors
RenderTargetDescription(int, int, TextureFormat, TextureFormat?, string?)
An offscreen target: one colour texture that can also be sampled, and an optional depth(-stencil) texture.
public RenderTargetDescription(int Width, int Height, TextureFormat Format = TextureFormat.Rgba8Unorm, TextureFormat? Depth = null, string? Name = null)Parameters
Width int
Width in pixels, 1..MaxRenderTargetSize.
Height int
Height in pixels, 1..MaxRenderTargetSize.
Format TextureFormat
Colour format; must support RenderTarget and Sampled.
Depth TextureFormat?
Depth format, or null; requires DepthBuffer and DepthStencil support for the format.
Name string?
Debug name.
Properties
Depth
Depth format, or null; requires DepthBuffer and DepthStencil support for the format.
public TextureFormat? Depth { get; init; }Property Value
Format
Colour format; must support RenderTarget and Sampled.
public TextureFormat Format { get; init; }Property Value
Height
Height in pixels, 1..MaxRenderTargetSize.
public int Height { get; init; }Property Value
Name
Debug name.
public string? Name { get; init; }Property Value
Width
Width in pixels, 1..MaxRenderTargetSize.
public int Width { get; init; }Property Value
Methods
Deconstruct(out int, out int, out TextureFormat, out TextureFormat?, out string?)
public void Deconstruct(out int Width, out int Height, out TextureFormat Format, out TextureFormat? Depth, out string? Name)Parameters
Width int
Height int
Format TextureFormat
Depth TextureFormat?
Name string?
Equals(object)
public override bool Equals(object obj)Parameters
obj object
Returns
Equals(RenderTargetDescription)
public bool Equals(RenderTargetDescription other)Parameters
other RenderTargetDescription
Returns
GetHashCode()
public override int GetHashCode()Returns
ToString()
public override string ToString()Returns
Operators
operator ==(RenderTargetDescription, RenderTargetDescription)
public static bool operator ==(RenderTargetDescription left, RenderTargetDescription right)Parameters
right RenderTargetDescription
Returns
operator !=(RenderTargetDescription, RenderTargetDescription)
public static bool operator !=(RenderTargetDescription left, RenderTargetDescription right)Parameters
right RenderTargetDescription