aboutsummaryrefslogtreecommitdiff
path: root/Ryujinx.Graphics.Gpu/Image
diff options
context:
space:
mode:
authorgdkchan <gab.dark.100@gmail.com>2020-01-01 12:39:09 -0300
committerThog <thog@protonmail.com>2020-01-09 02:13:00 +0100
commit92703af5558258da078d876b1d46e916b1065978 (patch)
tree6579863103b145b3e7345e42fc03caf870622b43 /Ryujinx.Graphics.Gpu/Image
parent40ef18d7599971c7387779d752a73568685d3432 (diff)
Address PR feedback
Diffstat (limited to 'Ryujinx.Graphics.Gpu/Image')
-rw-r--r--Ryujinx.Graphics.Gpu/Image/AutoDeleteCache.cs11
-rw-r--r--Ryujinx.Graphics.Gpu/Image/FormatInfo.cs10
-rw-r--r--Ryujinx.Graphics.Gpu/Image/Pool.cs4
-rw-r--r--Ryujinx.Graphics.Gpu/Image/ReductionFilter.cs4
-rw-r--r--Ryujinx.Graphics.Gpu/Image/Texture.cs4
-rw-r--r--Ryujinx.Graphics.Gpu/Image/TextureBindingInfo.cs4
-rw-r--r--Ryujinx.Graphics.Gpu/Image/TextureBindingsManager.cs8
-rw-r--r--Ryujinx.Graphics.Gpu/Image/TextureManager.cs4
8 files changed, 35 insertions, 14 deletions
diff --git a/Ryujinx.Graphics.Gpu/Image/AutoDeleteCache.cs b/Ryujinx.Graphics.Gpu/Image/AutoDeleteCache.cs
index fc30d03c..d66eab93 100644
--- a/Ryujinx.Graphics.Gpu/Image/AutoDeleteCache.cs
+++ b/Ryujinx.Graphics.Gpu/Image/AutoDeleteCache.cs
@@ -24,9 +24,11 @@ namespace Ryujinx.Graphics.Gpu.Image
/// <summary>
/// Adds a new texture to the cache, even if the texture added is already on the cache.
+ /// </summary>
+ /// <remarks>
/// Using this method is only recommended if you know that the texture is not yet on the cache,
/// otherwise it would store the same texture more than once.
- /// </summary>
+ /// </remarks>
/// <param name="texture">The texture to be added to the cache</param>
public void Add(Texture texture)
{
@@ -48,9 +50,12 @@ namespace Ryujinx.Graphics.Gpu.Image
/// <summary>
/// Adds a new texture to the cache, or just moves it to the top of the list if the
- /// texture is already on the cache. Moving the texture to the top of the list prevents
- /// it from being deleted, as the textures on the bottom of the list are deleted when new ones are added.
+ /// texture is already on the cache.
/// </summary>
+ /// <remarks>
+ /// Moving the texture to the top of the list prevents it from being deleted,
+ /// as the textures on the bottom of the list are deleted when new ones are added.
+ /// </remarks>
/// <param name="texture">The texture to be added, or moved to the top</param>
public void Lift(Texture texture)
{
diff --git a/Ryujinx.Graphics.Gpu/Image/FormatInfo.cs b/Ryujinx.Graphics.Gpu/Image/FormatInfo.cs
index 4f73bfa8..12f3aecb 100644
--- a/Ryujinx.Graphics.Gpu/Image/FormatInfo.cs
+++ b/Ryujinx.Graphics.Gpu/Image/FormatInfo.cs
@@ -18,13 +18,19 @@ namespace Ryujinx.Graphics.Gpu.Image
public Format Format { get; }
/// <summary>
- /// The block width for compressed formats. Must be 1 for non-compressed formats.
+ /// The block width for compressed formats.
/// </summary>
+ /// <remarks>
+ /// Must be 1 for non-compressed formats.
+ /// </remarks>
public int BlockWidth { get; }
/// <summary>
- /// The block height for compressed formats. Must be 1 for non-compressed formats.
+ /// The block height for compressed formats.
/// </summary>
+ /// <remarks>
+ /// Must be 1 for non-compressed formats.
+ /// </remarks>
public int BlockHeight { get; }
/// <summary>
diff --git a/Ryujinx.Graphics.Gpu/Image/Pool.cs b/Ryujinx.Graphics.Gpu/Image/Pool.cs
index bb55d40e..e4cefe9c 100644
--- a/Ryujinx.Graphics.Gpu/Image/Pool.cs
+++ b/Ryujinx.Graphics.Gpu/Image/Pool.cs
@@ -17,8 +17,10 @@ namespace Ryujinx.Graphics.Gpu.Image
/// <summary>
/// The maximum ID value of resources on the pool (inclusive).
- /// The maximum amount of resources on the pool is equal to this value plus one.
/// </summary>
+ /// <remarks>
+ /// The maximum amount of resources on the pool is equal to this value plus one.
+ /// </remarks>
public int MaximumId { get; }
/// <summary>
diff --git a/Ryujinx.Graphics.Gpu/Image/ReductionFilter.cs b/Ryujinx.Graphics.Gpu/Image/ReductionFilter.cs
index 94b3f542..1f7d9b07 100644
--- a/Ryujinx.Graphics.Gpu/Image/ReductionFilter.cs
+++ b/Ryujinx.Graphics.Gpu/Image/ReductionFilter.cs
@@ -2,8 +2,10 @@ namespace Ryujinx.Graphics.Gpu.Image
{
/// <summary>
/// Represents a filter used with texture minification linear filtering.
- /// This feature is only supported on NVIDIA GPUs.
/// </summary>
+ /// <remarks>
+ /// This feature is only supported on NVIDIA GPUs.
+ /// </remarks>
enum ReductionFilter
{
Average,
diff --git a/Ryujinx.Graphics.Gpu/Image/Texture.cs b/Ryujinx.Graphics.Gpu/Image/Texture.cs
index 4bbefd0b..be3d622f 100644
--- a/Ryujinx.Graphics.Gpu/Image/Texture.cs
+++ b/Ryujinx.Graphics.Gpu/Image/Texture.cs
@@ -190,9 +190,11 @@ namespace Ryujinx.Graphics.Gpu.Image
/// <summary>
/// Changes the texture size.
+ /// </summary>
+ /// <remarks>
/// This operation may also change the size of all mipmap levels, including from the parent
/// and other possible child textures, to ensure that all sizes are consistent.
- /// </summary>
+ /// </remarks>
/// <param name="width">The new texture width</param>
/// <param name="height">The new texture height</param>
/// <param name="depthOrLayers">The new texture depth (for 3D textures) or layers (for layered textures)</param>
diff --git a/Ryujinx.Graphics.Gpu/Image/TextureBindingInfo.cs b/Ryujinx.Graphics.Gpu/Image/TextureBindingInfo.cs
index 94225406..91a5fcf6 100644
--- a/Ryujinx.Graphics.Gpu/Image/TextureBindingInfo.cs
+++ b/Ryujinx.Graphics.Gpu/Image/TextureBindingInfo.cs
@@ -21,8 +21,10 @@ namespace Ryujinx.Graphics.Gpu.Image
/// <summary>
/// Indicates if the texture is a bindless texture.
- /// For those textures, Handle is ignored.
/// </summary>
+ /// <remarks>
+ /// For those textures, Handle is ignored.
+ /// </remarks>
public bool IsBindless { get; }
/// <summary>
diff --git a/Ryujinx.Graphics.Gpu/Image/TextureBindingsManager.cs b/Ryujinx.Graphics.Gpu/Image/TextureBindingsManager.cs
index 4d50c46e..984d45a9 100644
--- a/Ryujinx.Graphics.Gpu/Image/TextureBindingsManager.cs
+++ b/Ryujinx.Graphics.Gpu/Image/TextureBindingsManager.cs
@@ -52,7 +52,7 @@ namespace Ryujinx.Graphics.Gpu.Image
_texturePoolCache = texturePoolCache;
_isCompute = isCompute;
- int stages = isCompute ? 1 : Constants.TotalShaderStages;
+ int stages = isCompute ? 1 : Constants.ShaderStages;
_textureBindings = new TextureBindingInfo[stages][];
_imageBindings = new TextureBindingInfo[stages][];
@@ -135,7 +135,7 @@ namespace Ryujinx.Graphics.Gpu.Image
/// <summary>
/// Ensures that the bindings are visible to the host GPU.
- /// This actually performs the binding using the host graphics API.
+ /// Note: this actually performs the binding using the host graphics API.
/// </summary>
public void CommitBindings()
{
@@ -164,7 +164,7 @@ namespace Ryujinx.Graphics.Gpu.Image
/// <summary>
/// Ensures that the texture bindings are visible to the host GPU.
- /// This actually performs the binding using the host graphics API.
+ /// Note: this actually performs the binding using the host graphics API.
/// </summary>
/// <param name="pool">The current texture pool</param>
/// <param name="stage">The shader stage using the textures to be bound</param>
@@ -242,7 +242,7 @@ namespace Ryujinx.Graphics.Gpu.Image
/// <summary>
/// Ensures that the image bindings are visible to the host GPU.
- /// This actually performs the binding using the host graphics API.
+ /// Note: this actually performs the binding using the host graphics API.
/// </summary>
/// <param name="pool">The current texture pool</param>
/// <param name="stage">The shader stage using the textures to be bound</param>
diff --git a/Ryujinx.Graphics.Gpu/Image/TextureManager.cs b/Ryujinx.Graphics.Gpu/Image/TextureManager.cs
index e0a8908a..387e908d 100644
--- a/Ryujinx.Graphics.Gpu/Image/TextureManager.cs
+++ b/Ryujinx.Graphics.Gpu/Image/TextureManager.cs
@@ -753,9 +753,11 @@ namespace Ryujinx.Graphics.Gpu.Image
/// <summary>
/// Removes a texture from the cache.
+ /// </summary>
+ /// <remarks>
/// This only removes the texture from the internal list, not from the auto-deletion cache.
/// It may still have live references after the removal.
- /// </summary>
+ /// </remarks>
/// <param name="texture">The texture to be removed</param>
public void RemoveTextureFromCache(Texture texture)
{