mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-05-05 17:40:39 +00:00
baldurk
ebaefc82a9
* 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.
75 lines
3.0 KiB
C++
75 lines
3.0 KiB
C++
/******************************************************************************
|
|
* The MIT License (MIT)
|
|
*
|
|
* Copyright (c) 2017 Baldur Karlsson
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
******************************************************************************/
|
|
|
|
#pragma once
|
|
|
|
class RemoteHost;
|
|
|
|
// do not include any headers here, they must all be in QRDInterface.h
|
|
#include "QRDInterface.h"
|
|
|
|
DOCUMENT("A handle for interacting with a remote servers on a given host.");
|
|
class RemoteHost
|
|
{
|
|
public:
|
|
RemoteHost();
|
|
|
|
VARIANT_CAST(RemoteHost);
|
|
|
|
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`.");
|
|
void Launch();
|
|
|
|
DOCUMENT("``True`` if a remote server is currently running on this host.");
|
|
bool serverRunning : 1;
|
|
DOCUMENT("``True`` if an active connection exists to this remote server.");
|
|
bool connected : 1;
|
|
DOCUMENT("``True`` if someone else is currently connected to this server.");
|
|
bool busy : 1;
|
|
DOCUMENT("``True`` if there is a code version mismatch with this server.");
|
|
bool versionMismatch : 1;
|
|
|
|
DOCUMENT("The hostname of this host.");
|
|
rdcstr hostname;
|
|
DOCUMENT("The friendly name for this host, if available (if empty, the Hostname is used).");
|
|
rdcstr friendlyName;
|
|
DOCUMENT("The command to run locally to try to launch the server remotely.");
|
|
rdcstr runCommand;
|
|
|
|
DOCUMENT(R"(
|
|
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; }
|
|
DOCUMENT("Returns ``True`` if this host represents a connected ADB (Android) device.");
|
|
bool IsADB() const
|
|
{
|
|
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"; }
|
|
};
|
|
|
|
DECLARE_REFLECTION_STRUCT(RemoteHost); |