Skip to content
This repository was archived by the owner on Nov 30, 2020. It is now read-only.

Commit 2a9c969

Browse files
committed
Added xmldoc to newly exposed public API
1 parent 9faa469 commit 2a9c969

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

PostProcessing/Runtime/PostProcessRenderContext.cs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -322,6 +322,13 @@ public void PushDebugOverlay(CommandBuffer cmd, RenderTargetIdentifier source, P
322322
// size usages explicit
323323
#if UNITY_2017_2_OR_NEWER
324324
RenderTextureDescriptor m_sourceDescriptor;
325+
/// <summary>
326+
/// Returns a modified copy the RenderTextureDescriptor used by the context object.
327+
/// </summary>
328+
/// <param name="depthBufferBits">The number of bits to use for the depth buffer</param>
329+
/// <param name="colorFormat">The render texture format</param>
330+
/// <param name="readWrite">The color space conversion mode</param>
331+
/// <returns>A RenderTextureDescriptor object</returns>
325332
public RenderTextureDescriptor GetDescriptor(int depthBufferBits = 0, RenderTextureFormat colorFormat = RenderTextureFormat.Default, RenderTextureReadWrite readWrite = RenderTextureReadWrite.Default)
326333
{
327334
var modifiedDesc = new RenderTextureDescriptor(m_sourceDescriptor.width, m_sourceDescriptor.height,

0 commit comments

Comments
 (0)