From 6212e9876e084f54c14b1e3c6fb3e93341b8c56f Mon Sep 17 00:00:00 2001 From: baldurk Date: Thu, 24 Jun 2021 16:58:34 +0100 Subject: [PATCH] Fix documentation being missing on ResourceFormat.type --- renderdoc/api/replay/data_types.h | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/renderdoc/api/replay/data_types.h b/renderdoc/api/replay/data_types.h index 59f5dbe6c..69a38552f 100644 --- a/renderdoc/api/replay/data_types.h +++ b/renderdoc/api/replay/data_types.h @@ -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 ` of each component."); + DOCUMENT(R"(The :class:`type ` of each component. + +:type: CompType +)"); CompType compType; DOCUMENT("The number of components in each element."); uint8_t compCount;