Normalise and make python/public interface more consistent

* 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-22 13:02:36 +00:00
parent fd66995ac2
commit ebaefc82a9
171 changed files with 9843 additions and 10175 deletions
+13 -13
View File
@@ -40,36 +40,36 @@ public:
DOCUMENT(
"Ping the host to check current status - if the server is running, connection status, etc.");
void CheckStatus();
DOCUMENT("Runs the command specified in :data:`RunCommand`.");
DOCUMENT("Runs the command specified in :data:`runCommand`.");
void Launch();
DOCUMENT("``True`` if a remote server is currently running on this host.");
bool ServerRunning : 1;
bool serverRunning : 1;
DOCUMENT("``True`` if an active connection exists to this remote server.");
bool Connected : 1;
bool connected : 1;
DOCUMENT("``True`` if someone else is currently connected to this server.");
bool Busy : 1;
bool busy : 1;
DOCUMENT("``True`` if there is a code version mismatch with this server.");
bool VersionMismatch : 1;
bool versionMismatch : 1;
DOCUMENT("The hostname of this host.");
rdcstr Hostname;
rdcstr hostname;
DOCUMENT("The friendly name for this host, if available (if empty, the Hostname is used).");
rdcstr FriendlyName;
rdcstr friendlyName;
DOCUMENT("The command to run locally to try to launch the server remotely.");
rdcstr RunCommand;
rdcstr runCommand;
DOCUMENT(R"(
Returns the name to display for this host in the UI, either :data:`FriendlyName` or :data:`Hostname`
Returns the name to display for this host in the UI, either :data:`friendlyName` or :data:`hostname`
)");
const rdcstr &Name() const { return !FriendlyName.isEmpty() ? FriendlyName : Hostname; }
const rdcstr &Name() const { return !friendlyName.isEmpty() ? friendlyName : hostname; }
DOCUMENT("Returns ``True`` if this host represents a connected ADB (Android) device.");
bool IsHostADB() const
bool IsADB() const
{
return Hostname[0] == 'a' && Hostname[1] == 'd' && Hostname[2] == 'b' && Hostname[3] == ':';
return hostname[0] == 'a' && hostname[1] == 'd' && hostname[2] == 'b' && hostname[3] == ':';
}
DOCUMENT("Returns ``True`` if this host represents the special localhost device.");
bool IsLocalhost() const { return Hostname == "localhost"; }
bool IsLocalhost() const { return hostname == "localhost"; }
};
DECLARE_REFLECTION_STRUCT(RemoteHost);