mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-08-03 21:30:59 +00:00
Add type annotations for some structure members
* These annotations are necessary for good autocomplete on the python side so it knows the types.
This commit is contained in:
@@ -804,6 +804,8 @@ eventId guarantees are desired, this function should be avoided.
|
||||
Also eventIds may not correspond directly to an actual function call - sometimes a function such as
|
||||
a multi action indirect will be one function call that expands to multiple events to allow inspection
|
||||
of results part way through the multi action.
|
||||
|
||||
:type: int
|
||||
)");
|
||||
uint32_t eventId = 0;
|
||||
|
||||
@@ -811,6 +813,8 @@ of results part way through the multi action.
|
||||
|
||||
If no chunk index is available this will be set to :data:`NoChunk`. This will only happen for fake
|
||||
markers added to the capture after load.
|
||||
|
||||
:type: int
|
||||
)");
|
||||
uint32_t chunkIndex = 0;
|
||||
|
||||
@@ -818,6 +822,8 @@ markers added to the capture after load.
|
||||
|
||||
.. note:: This should only be used as a relative measure, it is not a literal number of bytes from
|
||||
the start of the file on disk.
|
||||
|
||||
:type: int
|
||||
)");
|
||||
uint64_t fileOffset = 0;
|
||||
|
||||
|
||||
@@ -214,10 +214,16 @@ struct SDType
|
||||
DOCUMENT("The name of this type.");
|
||||
rdcinflexiblestr name;
|
||||
|
||||
DOCUMENT("The :class:`SDBasic` category that this type belongs to.");
|
||||
DOCUMENT(R"(The :class:`SDBasic` category that this type belongs to.
|
||||
|
||||
:type: SDBasic
|
||||
)");
|
||||
SDBasic basetype;
|
||||
|
||||
DOCUMENT("The :class:`SDTypeFlags` flags for this type.");
|
||||
DOCUMENT(R"(The :class:`SDTypeFlags` flags for this type.
|
||||
|
||||
:type: SDTypeFlags
|
||||
)");
|
||||
SDTypeFlags flags;
|
||||
|
||||
DOCUMENT(R"(The size in bytes that an instance of this type takes up.
|
||||
@@ -227,6 +233,8 @@ an arbitrary size, or for basic types such as integers and floating point values
|
||||
size/precision of the type.
|
||||
|
||||
For variable size types like structs, arrays, etc it will be set to 0.
|
||||
|
||||
:type: int
|
||||
)");
|
||||
uint64_t byteSize;
|
||||
|
||||
@@ -287,22 +295,35 @@ struct SDChunkMetaData
|
||||
|
||||
DOCUMENT(R"(The length in bytes of this chunk - may be longer than the actual sum of the data if a
|
||||
conservative size estimate was used on creation to avoid seeking to fix-up the stored length.
|
||||
|
||||
:type: int
|
||||
)");
|
||||
uint64_t length = 0;
|
||||
|
||||
DOCUMENT("The ID of the thread where this chunk was recorded.");
|
||||
DOCUMENT(R"(The ID of the thread where this chunk was recorded.
|
||||
|
||||
:type: int
|
||||
)");
|
||||
uint64_t threadID = 0;
|
||||
|
||||
DOCUMENT(R"(The duration in microseconds that this chunk took. This is the time for the actual
|
||||
work, not the serialising.
|
||||
Since 0 is a possible value for this (for extremely fast calls), -1 is the invalid/not present value.
|
||||
|
||||
:type: int
|
||||
)");
|
||||
int64_t durationMicro = -1;
|
||||
|
||||
DOCUMENT("The point in time when this chunk was recorded, in microseconds since program start.");
|
||||
DOCUMENT(R"(The point in time when this chunk was recorded, in microseconds since program start.
|
||||
|
||||
:type: int
|
||||
)");
|
||||
uint64_t timestampMicro = 0;
|
||||
|
||||
DOCUMENT("The frames of the CPU-side callstack leading up to the chunk.");
|
||||
DOCUMENT(R"(The frames of the CPU-side callstack leading up to the chunk.
|
||||
|
||||
:type: List[int]
|
||||
)");
|
||||
rdcarray<uint64_t> callstack;
|
||||
|
||||
private:
|
||||
@@ -320,22 +341,40 @@ Only one member is valid, as defined by the type of the :class:`SDObject`.
|
||||
)");
|
||||
union SDObjectPODData
|
||||
{
|
||||
DOCUMENT("The value as an unsigned integer.");
|
||||
DOCUMENT(R"(The value as an unsigned integer.
|
||||
|
||||
:type: int
|
||||
)");
|
||||
uint64_t u;
|
||||
|
||||
DOCUMENT("The value as a signed integer.");
|
||||
DOCUMENT(R"(The value as a signed integer.
|
||||
|
||||
:type: int
|
||||
)");
|
||||
int64_t i;
|
||||
|
||||
DOCUMENT("The value as a floating point number.");
|
||||
DOCUMENT(R"(The value as a floating point number.
|
||||
|
||||
:type: float
|
||||
)");
|
||||
double d;
|
||||
|
||||
DOCUMENT("The value as a boolean.");
|
||||
DOCUMENT(R"(The value as a boolean.
|
||||
|
||||
:type: bool
|
||||
)");
|
||||
bool b;
|
||||
|
||||
DOCUMENT("The value as a single byte character.");
|
||||
DOCUMENT(R"(The value as a single byte character.
|
||||
|
||||
:type: str
|
||||
)");
|
||||
char c;
|
||||
|
||||
DOCUMENT("The value as a :class:`ResourceId`.");
|
||||
DOCUMENT(R"(The value as a :class:`ResourceId`
|
||||
|
||||
:type: ResourceId
|
||||
)");
|
||||
ResourceId id;
|
||||
|
||||
SDObjectPODData() : u(0) {}
|
||||
@@ -391,10 +430,16 @@ struct SDObjectData
|
||||
DOCUMENT("");
|
||||
SDObjectData() = default;
|
||||
|
||||
DOCUMENT("The plain-old data contents of the object, in a :class:`SDObjectPODData`.");
|
||||
DOCUMENT(R"(The plain-old data contents of the object, in a :class:`SDObjectPODData`.
|
||||
|
||||
:type: basic
|
||||
)");
|
||||
SDObjectPODData basic;
|
||||
|
||||
DOCUMENT("The string contents of the object.");
|
||||
DOCUMENT(R"(The string contents of the object.
|
||||
|
||||
:type: str
|
||||
)");
|
||||
rdcinflexiblestr str;
|
||||
|
||||
SDObjectData(const SDObjectData &) = delete;
|
||||
@@ -562,13 +607,22 @@ struct SDObject
|
||||
return ret;
|
||||
}
|
||||
|
||||
DOCUMENT("The name of this object.");
|
||||
DOCUMENT(R"(The name of this object.
|
||||
|
||||
:type: name
|
||||
)");
|
||||
rdcinflexiblestr name;
|
||||
|
||||
DOCUMENT("The :class:`SDType` of this object.");
|
||||
DOCUMENT(R"(The :class:`SDType` of this object.
|
||||
|
||||
:type: SDType
|
||||
)");
|
||||
SDType type;
|
||||
|
||||
DOCUMENT("The :class:`SDObjectData` with the contents of this object.");
|
||||
DOCUMENT(R"(The :class:`SDObjectData` with the contents of this object.
|
||||
|
||||
:type: SDObjectData
|
||||
)");
|
||||
SDObjectData data;
|
||||
|
||||
DOCUMENT(R"(Checks if the given object has the same value as this one. This equality is defined
|
||||
@@ -1560,7 +1614,10 @@ public:
|
||||
)");
|
||||
StructuredBufferList buffers;
|
||||
|
||||
DOCUMENT("The version of this structured stream, typically only used internally.");
|
||||
DOCUMENT(R"(The version of this structured stream, typically only used internally.
|
||||
|
||||
:type: int
|
||||
)");
|
||||
uint64_t version = 0;
|
||||
|
||||
DOCUMENT(R"(Swaps the contents of this file with another.
|
||||
|
||||
Reference in New Issue
Block a user