lee/renderdoc
1
0
Fork 0
mirror of https://github.com/baldurk/renderdoc.git synced 2026-09-25 07:05:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Properly update docstrings with optional/default parameters

Browse Source
This commit is contained in:
baldurk
2026-08-13 17:46:45 +01:00
parent ce8941150f
commit 4f3dab116b
6 changed files with 58 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files
renderdoc/api/replay/pipestate.h
+5 -5
View File
@@ -351,7 +351,7 @@ convenience of access.
DOCUMENT(R"(Retrieves all descriptor information for all descriptors accessed at the current event.
:param bool onlyUsed: Omit descriptors bound or declared but not accessed.
:param bool onlyUsed=False: **Optional parameter**. Omit descriptors bound or declared but not accessed.
:return: All descriptors accessed at the current event.
:rtype: List[UsedDescriptor]
)");
@@ -371,7 +371,7 @@ convenience of access.
DOCUMENT(R"(Retrieves the constant blocks used by a particular shader stage.
:param ShaderStage stage: The shader stage to fetch from.
:param bool onlyUsed: Omit descriptors bound or declared but not accessed.
:param bool onlyUsed=False: **Optional parameter**. Omit descriptors bound or declared but not accessed.
:return: The currently bound constant blocks.
:rtype: List[UsedDescriptor]
)");
@@ -380,7 +380,7 @@ convenience of access.
DOCUMENT(R"(Retrieves the read-only resources used by a particular shader stage.
:param ShaderStage stage: The shader stage to fetch from.
:param bool onlyUsed: Omit descriptors bound or declared but not accessed.
:param bool onlyUsed=False: **Optional parameter**. Omit descriptors bound or declared but not accessed.
:return: The currently bound read-only resources.
:rtype: List[UsedDescriptor]
)");
@@ -389,7 +389,7 @@ convenience of access.
DOCUMENT(R"(Retrieves the samplers bound to a particular shader stage.
:param ShaderStage stage: The shader stage to fetch from.
:param bool onlyUsed: Omit descriptors bound or declared but not accessed.
:param bool onlyUsed=False: **Optional parameter**. Omit descriptors bound or declared but not accessed.
:return: The currently bound sampler resources.
:rtype: List[UsedDescriptor]
)");
@@ -398,7 +398,7 @@ convenience of access.
DOCUMENT(R"(Retrieves the read/write resources used by a particular shader stage.
:param ShaderStage stage: The shader stage to fetch from.
:param bool onlyUsed: Omit descriptors bound or declared but not accessed.
:param bool onlyUsed=False: **Optional parameter**. Omit descriptors bound or declared but not accessed.
:return: The currently bound read/write resources.
:rtype: List[UsedDescriptor]
)");