Add XML documentation to Ryujinx.Graphics.Gpu.Image

This commit is contained in:
gdkchan 2019-12-29 20:26:37 -03:00 committed by Thog
parent 53bbc1311f
commit 32764f9560
24 changed files with 1133 additions and 61 deletions

View file

@ -2,17 +2,44 @@ using Ryujinx.Graphics.GAL;
namespace Ryujinx.Graphics.Gpu.Image
{
/// <summary>
/// Texture binding information.
/// This is used for textures that needs to be accessed from shaders.
/// </summary>
struct TextureBindingInfo
{
/// <summary>
/// Shader sampler target type.
/// </summary>
public Target Target { get; }
/// <summary>
/// Shader texture handle.
/// This is a index into the texture constant buffer.
/// </summary>
public int Handle { get; }
/// <summary>
/// Indicates if the texture is a bindless texture.
/// For those textures, Handle is ignored.
/// </summary>
public bool IsBindless { get; }
public int CbufSlot { get; }
/// <summary>
/// Constant buffer slot with the bindless texture handle, for bindless texture.
/// </summary>
public int CbufSlot { get; }
/// <summary>
/// Constant buffer offset of the bindless texture handle, for bindless texture.
/// </summary>
public int CbufOffset { get; }
/// <summary>
/// Constructs the texture binding information structure.
/// </summary>
/// <param name="target">The shader sampler target type</param>
/// <param name="handle">The shader texture handle (read index into the texture constant buffer)</param>
public TextureBindingInfo(Target target, int handle)
{
Target = target;
@ -24,6 +51,12 @@ namespace Ryujinx.Graphics.Gpu.Image
CbufOffset = 0;
}
/// <summary>
/// Constructs the bindless texture binding information structure.
/// </summary>
/// <param name="target">The shader sampler target type</param>
/// <param name="cbufSlot">Constant buffer slot where the bindless texture handle is located</param>
/// <param name="cbufOffset">Constant buffer offset of the bindless texture handle</param>
public TextureBindingInfo(Target target, int cbufSlot, int cbufOffset)
{
Target = target;