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

Fix documentation being missing on ResourceFormat.type

Browse Source
This commit is contained in:
baldurk
2021-06-24 16:58:34 +01:00
parent 8f0e1de669
commit 6212e9876e
1 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
renderdoc/api/replay/data_types.h
+9 -5
View File
@@ -199,10 +199,6 @@ struct ResourceFormat
:rtype: bool
)");
bool Special() const { return type != ResourceFormatType::Regular; }
DOCUMENT(R"(The :class:`ResourceFormatType` of this format. If the value is not
:attr:`ResourceFormatType.Regular` then it's a non-uniform layout like block-compressed.
)");
DOCUMENT(R"(:return: ``True`` if the components are to be read in ``BGRA`` order.
.. note::
@@ -389,9 +385,17 @@ texel.
return 0;
}
DOCUMENT(R"(The :class:`ResourceFormatType` of this format. If the value is not
:attr:`ResourceFormatType.Regular` then it's a non-uniform layout like block-compressed.
:type: ResourceFormatType
)");
ResourceFormatType type;
DOCUMENT("The :class:`type <CompType>` of each component.");
DOCUMENT(R"(The :class:`type <CompType>` of each component.
:type: CompType
)");
CompType compType;
DOCUMENT("The number of components in each element.");
uint8_t compCount;