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

Normalise and make python/public interface more consistent

Browse Source 
* We enforce a naming scheme more strongly - types, member functions,
  and enum values must be UpperCaseCamel, and member variables must be
  lowerCaseCamel. No underscores allowed.
* eventId not eventID or EID, and Id preferred to ID in general. Also
  for resourceId.
* Removed some lingering hungarian m_Foo naming.
* Some pipeline state structs that are almost identical between the
  different APIs are pulled out into common structs. Where something
  doesn't make sense (e.g. viewport enable for vulkan) it will just be
  set to a sensible default (in that case always true).
* Changed scissors to be x/y & width/height instead of sometimes
  left/top/right/bottom
* Abbreviations are discouraged, e.g. operation not op, function not
  func.
This commit is contained in:
baldurk
2017-12-21 21:39:42 +00:00
parent fd66995ac2
commit ebaefc82a9
171 changed files with 9843 additions and 10175 deletions
Download Patch File Download Diff File Expand all files Collapse all files
qrenderdoc/Code/Interface/PersistantConfig.h
+21 -21
View File
@@ -65,40 +65,40 @@ DOCUMENT("Describes a submitted bug report.");
struct BugReport
{
DOCUMENT("");
BugReport() { UnreadUpdates = false; }
BugReport() { unreadUpdates = false; }
VARIANT_CAST(BugReport);
bool operator==(const BugReport &o) const
{
return ID == o.ID && SubmitDate == o.SubmitDate && CheckDate == o.CheckDate &&
UnreadUpdates == o.UnreadUpdates;
return reportId == o.reportId && submitDate == o.submitDate && checkDate == o.checkDate &&
unreadUpdates == o.unreadUpdates;
}
bool operator<(const BugReport &o) const
{
if(ID != o.ID)
return ID < o.ID;
if(SubmitDate != o.SubmitDate)
return SubmitDate < o.SubmitDate;
if(CheckDate != o.CheckDate)
return CheckDate < o.CheckDate;
if(UnreadUpdates != o.UnreadUpdates)
return UnreadUpdates < o.UnreadUpdates;
if(reportId != o.reportId)
return reportId < o.reportId;
if(submitDate != o.submitDate)
return submitDate < o.submitDate;
if(checkDate != o.checkDate)
return checkDate < o.checkDate;
if(unreadUpdates != o.unreadUpdates)
return unreadUpdates < o.unreadUpdates;
return false;
}
DOCUMENT("The private ID of the bug report.");
rdcstr ID;
rdcstr reportId;
DOCUMENT("The original date when this bug was submitted.");
QDateTime SubmitDate;
QDateTime submitDate;
DOCUMENT("The last date that we checked for updates.");
QDateTime CheckDate;
QDateTime checkDate;
DOCUMENT("Unread updates to the bug exist");
bool UnreadUpdates = false;
bool unreadUpdates = false;
DOCUMENT(R"(Gets the URL for this report.
:return: The URL to the report.
:rtype: ``str``
)");
rdcstr URL() const { return lit(BUGREPORT_URL "/report/%1").arg(QString(ID)); }
rdcstr URL() const { return lit(BUGREPORT_URL "/report/%1").arg(QString(reportId)); }
};
DECLARE_REFLECTION_STRUCT(BugReport);
@@ -376,14 +376,14 @@ For more information about some of these settings that are user-facing see
.. data:: EventBrowser_ApplyColors
``True`` if the :class:`EventBrowser` should apply any colours specified with API marker regions.
``True`` if the :class:`EventBrowser` should apply any colors specified with API marker regions.
Defaults to ``True``.
.. data:: EventBrowser_ColorEventRow
``True`` if when colouring marker regions in the :class:`EventBrowser`, the whole row should be
coloured instead of just a side-bar.
``True`` if when coloring marker regions in the :class:`EventBrowser`, the whole row should be
colored instead of just a side-bar.
Defaults to ``True``.
)",
@@ -456,8 +456,8 @@ For more information about some of these settings that are user-facing see
.. data:: CheckUpdate_AllowChecks
``True`` if when colouring marker regions in the :class:`EventBrowser`, the whole row should be
coloured instead of just a side-bar.
``True`` if when coloring marker regions in the :class:`EventBrowser`, the whole row should be
colored instead of just a side-bar.
Defaults to ``True``.