RyuKen/Ryujinx.Graphics.Gpu/Image/FormatInfo.cs

72 lines
2.4 KiB
C#
Raw Normal View History

2019-10-13 06:02:07 +00:00
using Ryujinx.Graphics.GAL;
namespace Ryujinx.Graphics.Gpu.Image
{
/// <summary>
/// Represents texture format information.
/// </summary>
readonly struct FormatInfo
2019-10-13 06:02:07 +00:00
{
/// <summary>
/// A default, generic RGBA8 texture format.
/// </summary>
public static FormatInfo Default { get; } = new FormatInfo(Format.R8G8B8A8Unorm, 1, 1, 4, 4);
2019-10-13 06:02:07 +00:00
/// <summary>
/// The format of the texture data.
/// </summary>
2019-10-13 06:02:07 +00:00
public Format Format { get; }
/// <summary>
2020-01-01 15:39:09 +00:00
/// The block width for compressed formats.
/// </summary>
2020-01-01 15:39:09 +00:00
/// <remarks>
/// Must be 1 for non-compressed formats.
/// </remarks>
public int BlockWidth { get; }
/// <summary>
2020-01-01 15:39:09 +00:00
/// The block height for compressed formats.
/// </summary>
2020-01-01 15:39:09 +00:00
/// <remarks>
/// Must be 1 for non-compressed formats.
/// </remarks>
public int BlockHeight { get; }
/// <summary>
/// The number of bytes occupied by a single pixel in memory of the texture data.
/// </summary>
2019-10-13 06:02:07 +00:00
public int BytesPerPixel { get; }
/// <summary>
/// The maximum number of components this format has defined (in RGBA order).
/// </summary>
public int Components { get; }
/// <summary>
/// Whenever or not the texture format is a compressed format. Determined from block size.
/// </summary>
2019-10-13 06:02:07 +00:00
public bool IsCompressed => (BlockWidth | BlockHeight) != 1;
/// <summary>
/// Constructs the texture format info structure.
/// </summary>
/// <param name="format">The format of the texture data</param>
/// <param name="blockWidth">The block width for compressed formats. Must be 1 for non-compressed formats</param>
/// <param name="blockHeight">The block height for compressed formats. Must be 1 for non-compressed formats</param>
/// <param name="bytesPerPixel">The number of bytes occupied by a single pixel in memory of the texture data</param>
2019-10-13 06:02:07 +00:00
public FormatInfo(
Format format,
int blockWidth,
int blockHeight,
int bytesPerPixel,
int components)
2019-10-13 06:02:07 +00:00
{
Format = format;
BlockWidth = blockWidth;
BlockHeight = blockHeight;
BytesPerPixel = bytesPerPixel;
Components = components;
2019-10-13 06:02:07 +00:00
}
}
}